Skip to content

Commit 186aef2

Browse files
committed
update doc
1 parent cd45518 commit 186aef2

14 files changed

+381
-18
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
[![TorchDrug](asset/logo.svg)](https://torchdrug.ai/)
2-
3-
----------------------------
1+
[![TorchDrug](asset/torchdrug_logo_full.svg)](https://torchdrug.ai/)
2+
<h1 align="center">
3+
with
4+
<a href="https://torchprotein.ai/">
5+
<img src="asset/torchprotein_logo_tight.svg" alt="TorchProtein" style="height:26px" />
6+
</a>
7+
</h1>
48

59
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1Tbnr1Fog_YjkqU1MOhcVLuxqZ4DC-c8-#forceEdit=true&sandboxMode=true)
610
[![Contributions](https://img.shields.io/badge/contributions-welcome-blue)](https://github.com/DeepGraphLearning/torchdrug/blob/master/CONTRIBUTING.md)
@@ -26,7 +30,7 @@ Installation
2630
------------
2731

2832
TorchDrug can be installed on either Linux, Windows or macOS. It is compatible with
29-
Python 3.7/3.8 and PyTorch >= 1.8.0.
33+
Python 3.7/3.8/3.9 and PyTorch >= 1.8.0.
3034

3135
### From Conda ###
3236

File renamed without changes.

asset/torchprotein_logo_tight.svg

Lines changed: 19 additions & 0 deletions
Loading

doc/source/api/data.rst

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ Molecule
1616
.. autoclass:: Molecule
1717
:members:
1818

19+
Protein
20+
^^^^^^^
21+
.. autoclass:: Protein
22+
:members:
23+
1924
PackedGraph
2025
^^^^^^^^^^^
2126
.. autoclass:: PackedGraph
@@ -26,6 +31,11 @@ PackedMolecule
2631
.. autoclass:: PackedMolecule
2732
:members:
2833

34+
PackedProtein
35+
^^^^^^^^^^^^^
36+
.. autoclass:: PackedProtein
37+
:members:
38+
2939
Dictionary
3040
^^^^^^^^^^
3141
.. autoclass:: Dictionary
@@ -45,6 +55,21 @@ MoleculeDataset
4555
.. autoclass:: MoleculeDataset
4656
:members:
4757

58+
ProteinDataset
59+
^^^^^^^^^^^^^^
60+
.. autoclass:: ProteinDataset
61+
:members:
62+
63+
ProteinPairDataset
64+
^^^^^^^^^^^^^^^^^^
65+
.. autoclass:: ProteinPairDataset
66+
:members:
67+
68+
ProteinLigandDataset
69+
^^^^^^^^^^^^^^^^^^^^
70+
.. autoclass:: ProteinLigandDataset
71+
:members:
72+
4873
NodeClassificationDataset
4974
^^^^^^^^^^^^^^^^^^^^^^^^^
5075
.. autoclass:: NodeClassificationDataset
@@ -104,6 +129,8 @@ Atom Features
104129

105130
.. autofunction:: atom_synthon_completion
106131

132+
.. autofunction:: atom_residue_symbol
133+
107134
Bond Features
108135
^^^^^^^^^^^^^
109136
.. autofunction:: bond_default
@@ -114,6 +141,12 @@ Bond Features
114141

115142
.. autofunction:: bond_pretrain
116143

144+
Residue Features
145+
^^^^^^^^^^^^^^^^
146+
.. autofunction:: residue_default
147+
148+
.. autofunction:: residue_symbol
149+
117150
Molecule Features
118151
^^^^^^^^^^^^^^^^^
119152
.. autofunction:: molecule_default
@@ -154,4 +187,4 @@ abbreviated chemical symbol for atomic number ``i``.
154187
For a full list of elements, please refer to `the perodic table`_.
155188

156189
.. _the perodic table:
157-
https://en.wikipedia.org/wiki/Periodic_table
190+
https://en.wikipedia.org/wiki/Periodic_table

doc/source/api/datasets.rst

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,103 @@ PCQM4M
141141
:members:
142142

143143

144+
Protein Property Prediction Datasets
145+
------------------------------------
146+
147+
BetaLactamase
148+
^^^^^^^^^^^^^
149+
.. autoclass:: BetaLactamase
150+
:members:
151+
152+
Fluorescence
153+
^^^^^^^^^^^^
154+
.. autoclass:: Fluorescence
155+
:members:
156+
157+
Stability
158+
^^^^^^^^^
159+
.. autoclass:: Stability
160+
:members:
161+
162+
Solubility
163+
^^^^^^^^^^
164+
.. autoclass:: Solubility
165+
:members:
166+
167+
BinaryLocalization
168+
^^^^^^^^^^^^^^^^^^
169+
.. autoclass:: BinaryLocalization
170+
:members:
171+
172+
SubcellularLocalization
173+
^^^^^^^^^^^^^^^^^^^^^^^
174+
.. autoclass:: SubcellularLocalization
175+
:members:
176+
177+
EnzymeCommission
178+
^^^^^^^^^^^^^^^^
179+
.. autoclass:: EnzymeCommission
180+
:members:
181+
182+
GeneOntology
183+
^^^^^^^^^^^^
184+
.. autoclass:: GeneOntology
185+
:members:
186+
187+
AlphaFoldDB
188+
^^^^^^^^^^^
189+
.. autoclass:: AlphaFoldDB
190+
:members:
191+
192+
Protein Structure Prediction Datasets
193+
-------------------------------------
194+
195+
Fold
196+
^^^^
197+
.. autoclass:: Fold
198+
:members:
199+
200+
SecondaryStructure
201+
^^^^^^^^^^^^^^^^^^
202+
.. autoclass:: SecondaryStructure
203+
:members:
204+
205+
ProteinNet
206+
^^^^^^^^^^
207+
.. autoclass:: ProteinNet
208+
:members:
209+
210+
Protein-Protein Prediction Datasets
211+
-----------------------------------
212+
213+
HumanPPI
214+
^^^^^^^^
215+
.. autoclass:: HumanPPI
216+
:members:
217+
218+
YeastPPI
219+
^^^^^^^^
220+
.. autoclass:: YeastPPI
221+
:members:
222+
223+
PPIAffinity
224+
^^^^^^^^^^^
225+
.. autoclass:: PPIAffinity
226+
:members:
227+
228+
Protein Ligand Prediction Datasets
229+
----------------------------------
230+
231+
BindingDB
232+
^^^^^^^^^
233+
.. autoclass:: BindingDB
234+
:members:
235+
236+
PDBBind
237+
^^^^^^^
238+
.. autoclass:: PDBBind
239+
:members:
240+
144241
Retrosynthesis Datasets
145242
-----------------------
146243

doc/source/api/layers.rst

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,11 @@ ContinuousFilterConv
5050
.. autoclass:: ContinuousFilterConv
5151
:members:
5252

53+
GeometricRelationalGraphConv
54+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
55+
.. autoclass:: GeometricRelationalGraphConv
56+
:members:
57+
5358
GraphAttentionConv
5459
^^^^^^^^^^^^^^^^^^
5560
.. autoclass:: GraphAttentionConv
@@ -152,6 +157,25 @@ ConditionalFlow
152157
:members:
153158

154159

160+
Sequence Encoder Blocks
161+
-----------------------
162+
163+
ProteinResNetBlock
164+
^^^^^^^^^^^^^^^^^^
165+
.. autoclass:: ProteinResNetBlock
166+
:members:
167+
168+
SelfAttentionBlock
169+
^^^^^^^^^^^^^^^^^^
170+
.. autoclass:: SelfAttentionBlock
171+
:members:
172+
173+
ProteinBERTBlock
174+
^^^^^^^^^^^^^^^^
175+
.. autoclass:: ProteinBERTBlock
176+
:members:
177+
178+
155179
Distribution Layers
156180
-------------------
157181

@@ -165,6 +189,69 @@ IndependentGaussian
165189
:members:
166190

167191

192+
Graph Construction Layers
193+
-------------------------
194+
195+
These layers belong to `torchdrug.layers.geometry`.
196+
197+
.. currentmodule:: torchdrug.layers.geometry
198+
199+
GraphConstruction
200+
^^^^^^^^^^^^^^^^^
201+
.. autoclass:: GraphConstruction
202+
:members:
203+
204+
SpatialLineGraph
205+
^^^^^^^^^^^^^^^^
206+
.. autoclass:: SpatialLineGraph
207+
:members:
208+
209+
BondEdge
210+
^^^^^^^^
211+
.. autoclass:: BondEdge
212+
:members:
213+
214+
KNNEdge
215+
^^^^^^^
216+
.. autoclass:: KNNEdge
217+
:members:
218+
219+
SpatialEdge
220+
^^^^^^^^^^^
221+
.. autoclass:: SpatialEdge
222+
:members:
223+
224+
SequentialEdge
225+
^^^^^^^^^^^^^^
226+
.. autoclass:: SequentialEdge
227+
:members:
228+
229+
AlphaCarbonNode
230+
^^^^^^^^^^^^^^^
231+
.. autoclass:: AlphaCarbonNode
232+
:members:
233+
234+
IdentityNode
235+
^^^^^^^^^^^^
236+
.. autoclass:: IdentityNode
237+
:members:
238+
239+
RandomEdgeMask
240+
^^^^^^^^^^^^^^
241+
.. autoclass:: RandomEdgeMask
242+
:members:
243+
244+
SubsequenceNode
245+
^^^^^^^^^^^^^^^
246+
.. autoclass:: SubsequenceNode
247+
:members:
248+
249+
SubspaceNode
250+
^^^^^^^^^^^^
251+
.. autoclass:: SubspaceNode
252+
:members:
253+
254+
168255
Functional Layers
169256
-----------------
170257

doc/source/api/metrics.rst

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ torchdrug.metrics
33

44
.. currentmodule:: torchdrug.metrics
55

6-
76
Basic Metrics
87
-------------
98

@@ -32,16 +31,36 @@ Accuracy
3231

3332
Matthews Correlation Coefficient
3433
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
35-
.. autofuction:: matthews_corrcoef
34+
.. autofunction:: matthews_corrcoef
3635

3736
Pearson Correlation Coefficient
3837
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3938
.. autofunction:: pearsonr
4039

41-
Spearman Correlation Coefficient
42-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
40+
Spearman's Rank Correlation Coefficient
41+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4342
.. autofunction:: spearmanr
4443

44+
Variadic Accuracy
45+
^^^^^^^^^^^^^^^^^
46+
.. autofunction:: variadic_accuracy
47+
48+
Variadic Area Under ROC
49+
^^^^^^^^^^^^^^^^^^^^^^^
50+
.. autofunction:: variadic_area_under_roc
51+
52+
Variadic Area Under PRC
53+
^^^^^^^^^^^^^^^^^^^^^^^
54+
.. autofunction:: variadic_area_under_prc
55+
56+
Variadic Top Precision
57+
^^^^^^^^^^^^^^^^^^^^^^
58+
.. autofunction:: variadic_top_precision
59+
60+
F1 Max
61+
^^^^^^
62+
.. autofunction:: f1_max
63+
4564

4665
Chemical Metrics
4766
----------------

0 commit comments

Comments
 (0)