Skip to content

Commit 14a6d87

Browse files
committed
update doc for 0.1.0
1 parent 350d0e1 commit 14a6d87

File tree

4 files changed

+32
-39
lines changed

4 files changed

+32
-39
lines changed

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
project = 'torch-molecule'
1010
copyright = '2025, Gang Liu'
1111
author = 'Gang Liu'
12-
release = '0.1'
12+
release = '0.1.0'
1313

1414
# -- General configuration ---------------------------------------------------
1515
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/source/example.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ Examples
33

44
This section shows how to use the `torch_molecule` library in practice. More examples are available in the `examples <https://github.com/liugangcode/torch-molecule/tree/main/examples/>`_ folder and the `tests <https://github.com/liugangcode/torch-molecule/tree/main/tests/>`_ folder.
55

6-
76
Molecular Property Prediction Usage
87
-----------------------------------
98

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
torch-molecule documentation
55
============================
66

7-
Welcome to the torch-molecule. torch-molecule is an actively developed package designed to facilitate molecular discovery through deep learning.
7+
Welcome to the torch-molecule. torch-molecule is a deep learning package designed for molecular discovery.
88

99
It offers a user-friendly interface similar to `sklearn`, and includes model checkpoints for efficient deployment and benchmarking across various molecular tasks. The package currently focuses on three main components:
1010

docs/source/install.rst

Lines changed: 30 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,33 @@ Installation
44
To install `torch-molecule`, follow these steps:
55

66
1. **Create a Conda environment**:
7+
```bash
8+
conda create --name torch_molecule python=3.11.7
9+
conda activate torch_molecule
10+
```
711

8-
.. code-block:: bash
12+
2. **Install using pip (0.1.0)**:
13+
14+
```bash
15+
pip install torch-molecule
16+
```
17+
18+
3. **Install from source for the latest version**:
19+
20+
Clone the repository:
21+
22+
```bash
23+
git clone https://github.com/liugangcode/torch-molecule
24+
cd torch-molecule
25+
```
926

10-
conda create --name torch_molecule python=3.11.7
11-
conda activate torch_molecule
27+
Install:
1228

13-
2. **Install `torch_molecule` from GitHub**:
29+
```bash
30+
pip install .
31+
```
32+
33+
4. **Install editable `torch_molecule` (for developer)**:
1434

1535
Clone the repository:
1636

@@ -30,37 +50,11 @@ To install `torch-molecule`, follow these steps:
3050
3151
pip install -e .
3252
33-
3. **Install `torch_molecule` from PyPI** (Legacy):
34-
35-
.. code-block:: bash
36-
37-
pip install -i https://test.pypi.org/simple/ torch-molecule
38-
39-
**Required Dependencies**:
40-
41-
Dependencies are listed in `requirements.txt <https://github.com/liugangcode/torch-molecule/requirements.txt>`_. Example contents:
42-
43-
.. code-block:: text
44-
45-
# Install PyTorch with CUDA 11.8
46-
-f https://download.pytorch.org/whl/cu118/torch_stable.html
47-
torch==2.2.0+cu118
48-
49-
# Install PyTorch Geometric and related packages
50-
-f https://data.pyg.org/whl/torch-2.2.0+cu118.html
51-
torch_geometric==2.6.1
52-
torch_cluster
53-
torch_scatter
5453
55-
# Other dependencies
56-
huggingface_hub
57-
joblib==1.3.2
58-
networkx==3.2.1
59-
pandas==2.2.3
60-
PyYAML==6.0.2
61-
rdkit==2023.9.5
62-
scikit_learn==1.4.1.post1
63-
scipy==1.14.1
64-
tqdm==4.66.2
54+
### Additional Packages
6555

66-
optuna
56+
| Model | Required Packages |
57+
|-------|-------------------|
58+
| HFPretrainedMolecularEncoder | transformers |
59+
| BFGNNMolecularPredictor | torch-scatter |
60+
| GRINMolecularPredictor | torch-scatter |

0 commit comments

Comments
 (0)