Skip to content

Commit 6d442bf

Browse files
committed
update api doc
1 parent 5d7e913 commit 6d442bf

File tree

5 files changed

+41
-20
lines changed

5 files changed

+41
-20
lines changed

docs/api_doc/datasets.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ pdbbind_dataset
106106
===============
107107

108108
.. automodule:: pahelix.datasets.pdbbind_dataset
109-
:members: load_pdbbind_dataset
110-
:inherited-members:
109+
110+
.. autofunction:: pahelix.datasets.pdbbind_dataset.load_pdbbind_dataset
111111

112112
ppi_dataset
113113
===========

docs/api_doc/featurizers.rst

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,38 @@ pahelix.featurizers
44

55
.. contents:: Table of Contents
66

7-
featurizer
8-
==========
7+
het_gnn_featurizer
8+
==================
99

1010
.. automodule:: pahelix.featurizers.het_gnn_featurizer
11-
:members: DDiFeaturizer, num_nodes_stat, nx_graph_build
11+
12+
.. autoclass:: pahelix.featurizers.het_gnn_featurizer.DDiFeaturizer
13+
:members:
1214
:inherited-members:
1315

16+
.. autofunction:: pahelix.featurizers.het_gnn_featurizer.num_nodes_stat
17+
18+
.. autofunction:: pahelix.featurizers.het_gnn_featurizer.nx_graph_build
19+
1420
pretrain_gnn_featurizer
1521
=======================
1622

1723
.. automodule:: pahelix.featurizers.pretrain_gnn_featurizer
18-
:members: AttrmaskTransformFn, AttrmaskCollateFn, SupervisedTransformFn, SupervisedCollateFn
24+
25+
.. autoclass:: pahelix.featurizers.pretrain_gnn_featurizer.AttrmaskTransformFn
26+
:members:
27+
:inherited-members:
28+
29+
.. autoclass:: pahelix.featurizers.pretrain_gnn_featurizer.AttrmaskCollateFn
30+
:members:
31+
:inherited-members:
32+
33+
.. autoclass:: pahelix.featurizers.pretrain_gnn_featurizer.SupervisedTransformFn
34+
:members:
35+
:inherited-members:
36+
37+
.. autoclass:: pahelix.featurizers.pretrain_gnn_featurizer.SupervisedCollateFn
38+
:members:
1939
:inherited-members:
2040

2141
Helpful Link

docs/api_doc/model_zoo.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,22 @@ pretrain_gnns_model
1414
protein_sequence_model
1515
======================
1616

17-
.. autoclass:: pahelix.model_zoo.protein_sequence_model
17+
.. automodule:: pahelix.model_zoo.protein_sequence_model
1818
:members: LstmEncoderModel, ResnetEncoderModel, TransformerEncoderModel, PretrainTaskModel, SeqClassificationTaskModel, ClassificationTaskModel, RegressionTaskModel, ProteinEncoderModel, ProteinModel, ProteinCriterion
1919
:inherited-members:
2020

2121
sd_vae_model
2222
============
2323

24-
.. autoclass:: pahelix.model_zoo.sd_vae_model
24+
.. automodule:: pahelix.model_zoo.sd_vae_model
2525
:members: StateDecoder, PerpCalculator, MyPerpLoss, CNNEncoder, MolVAE
2626
:inherited-members:
2727

2828
seq_vae_model
2929
============
3030

31-
.. autoclass:: pahelix.model_zoo.seq_vae_model
32-
:members: VAE
33-
:inherited-members:
31+
.. autoclass:: pahelix.model_zoo.seq_vae_model.VAE
32+
:members:
3433

3534
Helpful Link
3635
============

docs/api_doc/networks.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,12 @@ basic_block
88
===========
99

1010
.. automodule:: pahelix.networks.basic_block
11-
:members: Activation, MLP
12-
:inherited-members:
11+
12+
.. autoclass:: pahelix.networks.compound_encoder.Activation
13+
:members:
14+
15+
.. autoclass:: pahelix.networks.compound_encoder.MLP
16+
:members:
1317

1418
compound_encoder
1519
================
@@ -28,9 +32,8 @@ gnn_block
2832
involution_block
2933
================
3034

31-
.. automodule:: pahelix.networks.involution_block
32-
:members: Involution2D
33-
:inherited-members:
35+
.. autoclass:: pahelix.networks.involution_block.Involution2D
36+
:members:
3437

3538
lstm_block
3639
==========
@@ -42,9 +45,8 @@ lstm_block
4245
optimizer
4346
=========
4447

45-
.. automodule:: pahelix.networks.optimizer
46-
:members: AdamW
47-
:inherited-members:
48+
.. autoclass:: pahelix.networks.optimizer.AdamW
49+
:members:
4850

4951
pre_post_process
5052
================

docs/api_doc/utils.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ compound_tools
1515
==============
1616

1717
.. automodule:: pahelix.utils.compound_tools
18-
:members: get_gasteiger_partial_charges, create_standardized_mol_id, check_smiles_validity, split_rdkit_mol_obj, get_largest_mol, rdchem_enum_to_list, CompoundKit, Compound3DKit, mol_to_graph_data, mol_to_md_graph_data, mol_to_polar_graph_data
18+
:members: get_gasteiger_partial_charges, create_standardized_mol_id, check_smiles_validity, split_rdkit_mol_obj, get_largest_mol, rdchem_enum_to_list, CompoundKit, Compound3DKit, mol_to_graph_data, mol_to_md_graph_data, mol_to_polar_graph_data, mol_to_superedge_graph_data
1919
:inherited-members:
2020

2121
data_utils

0 commit comments

Comments
 (0)