<img src=https://raw.githubusercontent.com/aiqm/torchani/master/logo1.png width=180/> 基于PyTorch的精确神经网络势能
指标:
检查:
我们仅提供与 PyTorch 每日构建版本的兼容性,但您可以通过查看以下徽章来检查是否支持稳定版 PyTorch:
TorchANI 是 ANI 的 PyTorch 实现。它目前处于 alpha 发布阶段,这意味着 API 尚不稳定。如果您发现 TorchANI 的错误,或有一些功能请求,欢迎在 GitHub 上提出问题,或向我们发送拉取请求。
<img src=https://raw.githubusercontent.com/aiqm/torchani/master/logo2.png width=500/>
安装
TorchANI 需要最新预览版的 PyTorch。请在安装 TorchANI 之前安装 PyTorch。
有关安装最新预览版 PyTorch 的说明,请参见 PyTorch 官方网站。
请注意,如果您更新了 TorchANI,可能还需要更新 PyTorch。
安装正确的 PyTorch 后,您可以通过 pip
或 conda
安装 TorchANI:
pip install torchani
或
conda install -c conda-forge torchani
有关 conda 包的更多信息,请参见 https://github.com/conda-forge/torchani-feedstock。
要运行测试和示例,您必须手动下载数据包
./download.sh
CUAEV(可选) 要安装 AEV CUDA 扩展(加速 AEV 前向和后向传播),请按照 torchani/cuaev 的说明进行操作。
引用
如果您使用 TorchANI,请引用以下论文
-
Xiang Gao, Farhad Ramezanghorbani, Olexandr Isayev, Justin S. Smith, 和 Adrian E. Roitberg。TorchANI:基于 PyTorch 的 ANI 神经网络势能的免费开源深度学习实现。Journal of Chemical Information and Modeling 2020 60 (7), 3408-3415,
-
请参考 isayev/ASE_ANI 获取 ANI 模型参考。
ANI 模型参数
所有 ANI 模型参数(包括 ANI2x、ANI1x 和 ANI1ccx)可从以下仓库获取:
开发
从 GitHub 安装 TorchANI:
git clone https://github.com/aiqm/torchani.git
cd torchani
pip install -e .
安装 TorchANI 后,可以通过运行 sphinx-build docs build
来构建文档。但请确保先安装依赖:
pip install -r docs_requirements.txt
要手动运行单元测试,请执行:
pytest -v
如果您提交了拉取请求,在 docs
检查成功后,可以在 https://aiqm.github.io/torchani-test-docs/ 查看生成的文档。
请注意,该仓库仅用于便于开发,只保留最新推送。
其他拉取请求的 CI 运行可能会覆盖此仓库。您可以重新运行 docs
检查以将您的构建覆盖到此仓库。
致 TorchANI 开发者的注意事项
切勿直接提交到 master 分支。如需更改,请创建新分支,在 GitHub 上提交拉取请求。
在合并您的拉取请求之前,您必须通过 GitHub 上的所有测试。
合并拉取请求前需进行代码审查。