CrystalFormer 项目启动与配置教程

1. 项目目录结构及介绍

CrystalFormer 项目是一个基于transformer的自动化生成晶体材料的开源项目。项目的目录结构如下：

• .github/：包含项目的GitHub工作流文件，用于自动化测试、构建等。
• data/：存放项目所需的数据集，包括训练集、验证集和测试集。
• imgs/：存放与项目相关的图像文件，如模型结构图等。
• model/：包含模型定义和训练相关的代码。
• scripts/：存放项目中用到的脚本文件，如数据转换、模型评估等。
• tests/：存放项目的单元测试代码。
• .gitignore：定义Git忽略的文件和目录。
• LICENSE：项目的开源许可证文件。
• README.md：项目的说明文件。
• main.py：项目的主程序文件，用于模型的训练和采样。
• requirements.txt：列出了项目依赖的Python包。
• setup.py：项目的配置文件，用于打包和分发项目。

2. 项目的启动文件介绍

main.py 是项目的主要启动文件，它包含了模型的训练和采样逻辑。

训练模型

训练模型的命令如下：

python ./main.py --folder ./data/ --train_path YOUR_PATH/mp_20/train.csv --valid_path YOUR_PATH/mp_20/val.csv

• --folder：指定模型和日志文件的保存目录。
• --train_path：指定训练数据集的路径。
• --valid_path：指定验证数据集的路径。
• --test_path：可选，指定测试数据集的路径。

采样模型

采样模型的命令如下：

python ./main.py --optimizer none --test_path YOUR_PATH/mp_20/test.csv --restore_path YOUR_MODEL_PATH --spacegroup 160 --num_samples 1000  --batchsize 1000 --temperature 1.0

• --optimizer：指定优化器，none 表示不训练，只进行采样。
• --test_path：指定测试数据集的路径。
• --restore_path：指定模型权重的路径。
• --spacegroup：指定采样晶体的空间群编号。
• --num_samples：指定生成样本的数量。
• --batchsize：指定采样时使用的批次大小。
• --temperature：指定采样时的温度，用于控制样本的多样性。

3. 项目的配置文件介绍

requirements.txt 文件列出了项目依赖的Python包，例如：

jax
jaxlib
numpy
pandas

在开始项目之前，需要安装这些依赖包。可以使用以下命令安装：

pip install -r requirements.txt

setup.py 文件用于配置项目的打包和分发，它定义了项目的元数据和依赖项。

以上就是CrystalFormer项目的启动和配置教程，通过上述步骤，用户可以开始使用这个项目来生成晶体材料。