devnums / pyheartlib

A Python package for processing electrocardiogram signals ❤️
https://pyheartlib.readthedocs.io/
GNU Affero General Public License v3.0
2 stars 1 forks source link

Provide jupyter notebooks with your example dataset and model code #11

Open cudmore opened 1 year ago

cudmore commented 1 year ago

In your readthedoc web documentation you have html files with pretty large code blocks and copy/paste to a users .py file is too cumbersome and error prone. Would be best to provide examples dataset and model as jupyter notebooks so users can git clone the repo and run them locally with jupyter notebook.

For one example https://pyheartlib.readthedocs.io/en/latest/examples/dataset/arrhythmia.html

Ah, now I see you have an example/ folder in the repo with .py files with the source code shown in docs webpage.

Would be nice to provide this in one place, maybe as a jupyter notebook within the docs? Or at least mention the py files are available in the repo (from within the web docs).

devnums commented 1 year ago

The examples are now available as Jupyter notebooks. They can be run locally or in Google Colab using the links at the top of the files. https://pyheartlib.readthedocs.io/en/latest/examples/examples.html