NeuralForceField 项目教程

1. 项目目录结构及介绍

NeuralForceField 项目的目录结构如下：

NeuralForceField/
├── models/
├── nff/
├── scripts/
├── tutorials/
├── .gitignore
├── .gitmodules
├── pre-commit-config.yaml
├── LICENSE
├── README.md
├── environment.yml
├── environment_cpu.yml
├── pyproject.toml
└── setup.py

目录介绍

• models/: 包含预训练模型的文件夹。
• nff/: 包含项目的主要代码，包括神经网络模型的实现。
• scripts/: 包含用于训练和评估模型的脚本。
• tutorials/: 包含项目的教程和示例数据。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 跟踪。
• .gitmodules: Git 子模块配置文件。
• pre-commit-config.yaml: 预提交钩子配置文件。
• LICENSE: 项目许可证文件，采用 MIT 许可证。
• README.md: 项目介绍和使用说明的 Markdown 文件。
• environment.yml: Conda 环境配置文件，用于创建项目的运行环境。
• environment_cpu.yml: 针对 CPU 的环境配置文件。
• pyproject.toml: Python 项目配置文件。
• setup.py: 项目的安装脚本。

2. 项目启动文件介绍

项目的启动文件主要是 setup.py 和 scripts/ 目录下的脚本文件。

setup.py

setup.py 是 Python 项目的标准安装脚本，用于安装项目的依赖项和配置项目。通过运行以下命令可以安装项目：

pip install .

如果需要开发模式安装，可以使用：

pip install -e .[dev]

scripts/ 目录

scripts/ 目录包含多个用于训练和评估模型的脚本。例如，nff_train.py 是一个用于训练 SchNet 模型的脚本。可以通过以下命令启动训练：

python scripts/nff_train.py train schnet tutorials/data/dataset.pth.tar $HOME/train_model --device cuda:0

3. 项目的配置文件介绍

项目的配置文件主要包括 environment.yml 和 pyproject.toml。

environment.yml

environment.yml 是 Conda 环境配置文件，用于创建项目的运行环境。可以通过以下命令创建环境：

conda env create -f environment.yml

创建环境后，可以通过以下命令将环境添加到 Jupyter Notebook 中：

python -m ipykernel install --user --name nff --display-name "Python [conda env:nff]"

pyproject.toml

pyproject.toml 是 Python 项目的配置文件，用于指定项目的构建系统和依赖项。该文件通常包含以下内容：

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

通过这些配置文件，可以确保项目在不同的环境中正确运行和部署。