Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lsj2408/transformer-m
[ICLR 2023] One Transformer Can Understand Both 2D & 3D Molecular Data (official implementation)
https://github.com/lsj2408/transformer-m
general-purpose-molecular-model graph-neural-network graph-transformer molecular-modeling molecule transformer
Last synced: 2 months ago
JSON representation
[ICLR 2023] One Transformer Can Understand Both 2D & 3D Molecular Data (official implementation)
- Host: GitHub
- URL: https://github.com/lsj2408/transformer-m
- Owner: lsj2408
- License: mit
- Created: 2022-10-04T10:05:33.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-31T12:36:34.000Z (over 1 year ago)
- Last Synced: 2024-10-09T22:06:32.350Z (2 months ago)
- Topics: general-purpose-molecular-model, graph-neural-network, graph-transformer, molecular-modeling, molecule, transformer
- Language: Python
- Homepage: https://arxiv.org/abs/2210.01765
- Size: 5.45 MB
- Stars: 201
- Watchers: 6
- Forks: 24
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# One Transformer Can Understand Both 2D & 3D Molecular Data
[](https://paperswithcode.com/sota/graph-regression-on-pcqm4mv2-lsc?p=one-transformer-can-understand-both-2d-3d)
This repository is the official implementation of “[One Transformer Can Understand Both 2D & 3D Molecular Data](https://arxiv.org/abs/2210.01765)”, based on the official implementation of [Graphormer](https://github.com/microsoft/Graphormer) and [Fairseq](https://github.com/facebookresearch/fairseq) in [PyTorch](https://github.com/pytorch/pytorch).
> One Transformer Can Understand Both 2D & 3D Molecular Data
>
> *Shengjie Luo, Tianlang Chen\*, Yixian Xu\*, Shuxin Zheng, Tie-Yan Liu, Liwei Wang, Di He*
## 🔥 News
- **2023.03.31**: The fine-tuning code of QM9 has been released.
- **2022.11.22**: Congratulations! Transformer-M has been used by **all Top-3 winners** in [**PCQM4Mv2 Track, 2nd OGB Large-Scale Challenge, NeurIPS 2022**](https://ogb.stanford.edu/neurips2022/results/#winners_pcqm4mv2)!
- 1st Place winner, Team WeLoveGraphs from GraphCore, [code](https://github.com/graphcore/ogb-lsc-pcqm4mv2) & [report](https://ogb.stanford.edu/paper/neurips2022/pcqm4mv2_WeLoveGraphs.pdf).
- co-2nd Place winner, Team VisNet from Microsoft, [code](https://github.com/microsoft/ViSNet/tree/OGB-LSC%40NIPS2022) & [report](https://github.com/microsoft/ViSNet/blob/OGB-LSC%40NIPS2022/ViSNet_Tech_Report_OGB_LSC_NIPS22.pdf).
- co-2nd Place winner, Team NVIDIA-PCQM4Mv2 from NVIDIA, [code](https://github.com/jfpuget/NVIDIA-PCQM4Mv2) & [report](https://ogb.stanford.edu/paper/neurips2022/pcqm4mv2_NVIDIA-PCQM4Mv2.pdf).
- **2022.10.05**: Codes and model checkpoints are released!
## Overview
Transformer-M is a versatile and effective molecular model that can take molecular data of 2D or 3D formats as input and generate meaningful semantic representations. Using the standard Transformer as the backbone architecture, Transformer-M develops two separated channels to encode 2D and 3D structural information and incorporate them with the atom features in the network modules. When the input data is in a particular format, the corresponding channel will be activated, and the other will be disabled. Empirical results show that our Transformer-M can achieve strong performance on 2D and 3D tasks simultaneously, which is the first step toward general-purpose molecular models in chemistry.
## Results on PCQM4Mv2, OGB Large-Scale Challenge
🚀**Note:** **PCQM4Mv2** is also the benchmark dataset of the graph-level track in the **2nd OGB-LSC** at [**NeurIPS 2022 competition track**](https://ogb.stanford.edu/neurips2022/). As non-participants, we open source all the codes and model weights, and sincerely welcome participants to use our model. Looking forward to your feedback!
## Installation
- Clone this repository
```shell
git clone https://github.com/lsj2408/Transformer-M.git
```
- Install the dependencies (Using [Anaconda](https://www.anaconda.com/), tested with CUDA version 11.0)
```shell
cd ./Transformer-M
conda env create -f requirement.yaml
conda activate Transformer-M
pip install torch==1.7.1+cu110 torchvision==0.8.2+cu110 torchaudio==0.7.2 -f https://download.pytorch.org/whl/torch_stable.html
pip install torch_geometric==1.6.3
pip install torch_scatter==2.0.7
pip install torch_sparse==0.6.9
pip install azureml-defaults
pip install rdkit-pypi cython
python setup.py build_ext --inplace
python setup_cython.py build_ext --inplace
pip install -e .
pip install --upgrade protobuf==3.20.1
pip install --upgrade tensorboard==2.9.1
pip install --upgrade tensorboardX==2.5.1
```
## Checkpoints
| Model | File Size | Update Date | Valid MAE on PCQM4Mv2 | Download Link |
| ----- | --------- | ------------ | --------------------- | -------------------------------------------------------- |
| L12 | 189MB | Oct 04, 2022 | 0.0785 | https://1drv.ms/u/s!AgZyC7AzHtDBdWUZttg6N2TsOxw?e=sUOhox |
| L18 | 270MB | Oct 04, 2022 | 0.0772 | https://1drv.ms/u/s!AgZyC7AzHtDBdrY59-_mP38jsCg?e=URoyUK |
| L12_old | 189MB | Mar 31, 2023 | 0.0787 | https://1drv.ms/u/s!AgZyC7AzHtDBesDk9tZK1yvbtzE?e=5H91Zq |
```shell
# create paths to checkpoints for evaluation
# download the above model weights (L12.pt, L18.pt) to ./
mkdir -p logs/L12
mkdir -p logs/L18
mv L12.pt logs/L12/
mv L18.pt logs/L18/
```
## Datasets
- Preprocessed data: [download link](https://1drv.ms/u/s!AgZyC7AzHtDBeIDqE61u1ZEMv_8?e=3g428e)
```shell
# create paths to datasets for evaluation/training
# download the above compressed datasets (pcqm4mv2-pos.zip) to ./
unzip pcqm4mv2-pos.zip -d ./datasets
```
- You can also directly execute the evaluation/training code to process data from scratch.
## Evaluation
```shell
export data_path='./datasets/pcq-pos' # path to data
export save_path='./logs/{folder_to_checkpoints}' # path to checkpoints, e.g., ./logs/L12
export layers=12 # set layers=18 for 18-layer model
export hidden_size=768 # dimension of hidden layers
export ffn_size=768 # dimension of feed-forward layers
export num_head=32 # number of attention heads
export num_3d_bias_kernel=128 # number of Gaussian Basis kernels
export batch_size=256 # batch size for a single gpu
export dataset_name="PCQM4M-LSC-V2-3D"
export add_3d="true"
bash evaluate.sh
```
## Training
```shell
# L12. Valid MAE: 0.0785
export data_path='./datasets/pcq-pos' # path to data
export save_path='./logs/' # path to logs
export lr=2e-4 # peak learning rate
export warmup_steps=150000 # warmup steps
export total_steps=1500000 # total steps
export layers=12 # set layers=18 for 18-layer model
export hidden_size=768 # dimension of hidden layers
export ffn_size=768 # dimension of feed-forward layers
export num_head=32 # number of attention heads
export batch_size=256 # batch size for a single gpu
export dropout=0.0
export act_dropout=0.1
export attn_dropout=0.1
export weight_decay=0.0
export droppath_prob=0.1 # probability of stochastic depth
export noise_scale=0.2 # noise scale
export mode_prob="0.2,0.2,0.6" # mode distribution for {2D+3D, 2D, 3D}
export dataset_name="PCQM4M-LSC-V2-3D"
export add_3d="true"
export num_3d_bias_kernel=128 # number of Gaussian Basis kernels
bash train.sh
```
Our model is trained on 4 NVIDIA Tesla A100 GPUs (40GB). The time cost for an epoch is around 10 minutes.
## Downstream Task -- (QM9)
Download the checkpoint: L12-old.pt
```shell
export ckpt_path='./L12-old.pt' # path to checkpoints
bash finetune_qm9.sh
```
## Citation
If you find this work useful, please kindly cite following papers:
```latex
@article{luo2022one,
title={One Transformer Can Understand Both 2D \& 3D Molecular Data},
author={Luo, Shengjie and Chen, Tianlang and Xu, Yixian and Zheng, Shuxin and Liu, Tie-Yan and Wang, Liwei and He, Di},
journal={arXiv preprint arXiv:2210.01765},
year={2022}
}
@inproceedings{
ying2021do,
title={Do Transformers Really Perform Badly for Graph Representation?},
author={Chengxuan Ying and Tianle Cai and Shengjie Luo and Shuxin Zheng and Guolin Ke and Di He and Yanming Shen and Tie-Yan Liu},
booktitle={Thirty-Fifth Conference on Neural Information Processing Systems},
year={2021},
url={https://openreview.net/forum?id=OeWooOxFwDa}
}
@article{shi2022benchmarking,
title={Benchmarking Graphormer on Large-Scale Molecular Modeling Datasets},
author={Yu Shi and Shuxin Zheng and Guolin Ke and Yifei Shen and Jiacheng You and Jiyan He and Shengjie Luo and Chang Liu and Di He and Tie-Yan Liu},
journal={arXiv preprint arXiv:2203.04810},
year={2022},
url={https://arxiv.org/abs/2203.04810}
}
```
## Contact
Shengjie Luo ([email protected])
Sincerely appreciate your suggestions on our work!
## License
This project is licensed under the terms of the MIT license. See [LICENSE](https://github.com/lsj2408/Transformer-M/blob/main/LICENSE) for additional details.