ribesstefano commited on
Commit
a253f7d
·
1 Parent(s): 6dab7ba

Updated README to include link to documentation

Browse files
Files changed (1) hide show
  1. README.md +4 -3
README.md CHANGED
@@ -10,7 +10,7 @@ A machine learning-based tool for predicting PROTAC protein degradation activity
10
 
11
  - [Data Curation](#-data-curation)
12
  - [Installation](#-installation)
13
- - [Usage](#-usage)
14
  - [Training](#-training)
15
  - [Citation](#-citation)
16
  - [License](#-license)
@@ -33,9 +33,10 @@ pip install .
33
 
34
  The package has been developed on a Linux machine with Python 3.10.8. It is recommended to use a virtual environment to avoid conflicts with other packages.
35
 
36
- ## 🎯 Usage
37
 
38
- For a thorough explanation on how to use the package, please refer to the tutorial notebook [`protac_degradation_predictor_tutorial.ipynb`](notebooks/protac_degradation_predictor_tutorial.ipynb).
 
39
 
40
  After installing the package, you can use it as follows:
41
 
 
10
 
11
  - [Data Curation](#-data-curation)
12
  - [Installation](#-installation)
13
+ - [Documentation and Usage](#-documentation-and-usage)
14
  - [Training](#-training)
15
  - [Citation](#-citation)
16
  - [License](#-license)
 
33
 
34
  The package has been developed on a Linux machine with Python 3.10.8. It is recommended to use a virtual environment to avoid conflicts with other packages.
35
 
36
+ ## 🎯 Documentation and Usage
37
 
38
+ The package documentation can be found [here](https://ribesstefano.github.io/PROTAC-Degradation-Predictor/).
39
+ For a walkthrough on how to use the package, please refer to the tutorial notebook [`protac_degradation_predictor_tutorial.ipynb`](notebooks/protac_degradation_predictor_tutorial.ipynb).
40
 
41
  After installing the package, you can use it as follows:
42