ALIGNN 项目使用教程

1. 项目目录结构及介绍

ALIGNN（Atomistic Line Graph Neural Network）项目的目录结构如下：

alignn/
├── alignn/
│   ├── __init__.py
│   ├── model.py
│   ├── train.py
│   ├── utils.py
│   └── ...
├── examples/
│   ├── sample_data/
│   │   ├── config_example.json
│   │   ├── id_prop.csv
│   │   └── POSCAR-JVASP-10.vasp
│   └── ...
├── scripts/
│   ├── train_alignn.py
│   └── ...
├── README.md
├── LICENSE.rst
├── environment.yml
├── pyproject.toml
└── setup.py

目录结构介绍

• alignn/: 项目的主要代码目录，包含模型定义、训练脚本、工具函数等。
  • init.py: 初始化文件，使 alignn 成为一个 Python 包。
  • model.py: 定义了 ALIGNN 模型的核心代码。
  • train.py: 训练模型的脚本。
  • utils.py: 包含一些辅助函数和工具。
• examples/: 包含示例数据和配置文件，用于演示如何使用 ALIGNN 进行训练和预测。
  • sample_data/: 示例数据目录，包含配置文件、数据文件和结构文件。
• scripts/: 包含自动化训练脚本，用于批量训练模型。
• README.md: 项目的介绍文档，包含安装、使用说明等。
• LICENSE.rst: 项目的开源许可证文件。
• environment.yml: Conda 环境配置文件，用于创建项目的运行环境。
• pyproject.toml: 项目配置文件，包含项目依赖和构建信息。
• setup.py: 用于安装项目的脚本。

2. 项目启动文件介绍

项目的启动文件主要是 train_alignn.py，位于 scripts/ 目录下。该文件用于启动模型的训练过程。

启动文件介绍

• train_alignn.py: 该脚本用于训练 ALIGNN 模型。用户可以通过命令行参数指定数据目录、配置文件路径等。

python scripts/train_alignn.py --root_dir "examples/sample_data" --config "examples/sample_data/config_example.json" --output_dir=temp

主要参数

• --root_dir: 指定数据目录的路径。
• --config: 指定配置文件的路径。
• --output_dir: 指定输出目录，用于保存训练结果。

3. 项目的配置文件介绍

项目的配置文件主要是 config_example.json，位于 examples/sample_data/ 目录下。该文件包含了训练模型的各种超参数和配置选项。

配置文件介绍

{
  "train_ratio": 0.8,
  "val_ratio": 0.1,
  "test_ratio": 0.1,
  "batch_size": 32,
  "learning_rate": 0.001,
  "epochs": 100,
  "keep_data_order": false,
  "classification_threshold": 0.01
}

主要配置项

• train_ratio: 训练集的比例。
• val_ratio: 验证集的比例。
• test_ratio: 测试集的比例。
• batch_size: 批处理大小。
• learning_rate: 学习率。
• epochs: 训练的轮数。
• keep_data_order: 是否保持数据顺序。
• classification_threshold: 分类任务的阈值。

通过修改配置文件中的参数，用户可以自定义训练过程，以适应不同的数据集和任务需求。