From 58311f936468c1df7c7bc11470bd94c15960008e Mon Sep 17 00:00:00 2001 From: gcroci2 Date: Mon, 1 Jul 2024 13:19:49 +0200 Subject: [PATCH 1/3] add disclaimer about ipynb --- tutorials/TUTORIAL.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/tutorials/TUTORIAL.md b/tutorials/TUTORIAL.md index c6622a44a..3f444c8f0 100644 --- a/tutorials/TUTORIAL.md +++ b/tutorials/TUTORIAL.md @@ -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: + +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. + ### Use cases #### PPIs From aa1b23785176a35449a058476d9946b33f0e65eb Mon Sep 17 00:00:00 2001 From: Giulia Crocioni <55382553+gcroci2@users.noreply.github.com> Date: Fri, 5 Jul 2024 17:49:04 +0200 Subject: [PATCH 2/3] Update tutorials/TUTORIAL.md Co-authored-by: Dani Bodor --- tutorials/TUTORIAL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/TUTORIAL.md b/tutorials/TUTORIAL.md index 3f444c8f0..fcb319e62 100644 --- a/tutorials/TUTORIAL.md +++ b/tutorials/TUTORIAL.md @@ -9,7 +9,7 @@ The tutorial notebooks in this folder can be run to learn how to use DeepRank2. ### :heavy_exclamation_mark: Important :heavy_exclamation_mark: -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. +For a smooth experience, please run these tutorials within the Jupyter notebooks provided (`.ipynb` files). Running the commands in a Python (interactive) shell or on command line may lead to unexpected errors. ### Use cases From 8adc678e9749e6903449ebe87f13730f2ab318ea Mon Sep 17 00:00:00 2001 From: gcroci2 Date: Fri, 5 Jul 2024 17:50:34 +0200 Subject: [PATCH 3/3] remove emphasis --- tutorials/TUTORIAL.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/tutorials/TUTORIAL.md b/tutorials/TUTORIAL.md index 3f444c8f0..7fb7c66ca 100644 --- a/tutorials/TUTORIAL.md +++ b/tutorials/TUTORIAL.md @@ -7,8 +7,6 @@ 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: - 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. ### Use cases