Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify tutorials usage #620

Merged
merged 4 commits into from
Jul 5, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions tutorials/TUTORIAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ The tutorial notebooks in this folder can be run to learn how to use DeepRank2.
- single-residue variant (SRV) data ([data_generation_srv.ipynb](https://github.com/DeepRank/deeprank2/blob/main/tutorials/data_generation_srv.ipynb)).
- The [training tutorial](tutorials/training_ppi.ipynb) will demonstrate how to train neural networks using DeepRank2.

### :heavy_exclamation_mark: Important :heavy_exclamation_mark:
gcroci2 marked this conversation as resolved.
Show resolved Hide resolved

For correct results, please run these tutorials within the expected Jupyter notebooks (`.ipynb` files) and avoid using the Python interactive shell (command line), which may cause certain functions (e.g., such as `inspect.getsource()`) to not work as expected.
gcroci2 marked this conversation as resolved.
Show resolved Hide resolved

### Use cases

#### PPIs
Expand Down
Loading