CrystalFormer 开源项目最佳实践教程

1. 项目介绍

CrystalFormer 是一个基于 Transformer 的自回归模型，专门设计用于空间群控制的晶体材料生成。该模型利用空间群对称性显著简化了晶体空间，这对于数据高效和计算高效的晶体材料生成模型至关重要。CrystalFormer 可以根据给定的空间群生成晶体结构，为材料设计和发现提供了强大的工具。

2. 项目快速启动

环境搭建

首先，需要创建一个新的 Python 环境，并安装所需的依赖包。推荐使用 Python 3.10 版本和 conda 管理环境：

conda create -n crystalgpt python=3.10
conda activate crystalgpt

安装 jax 和 jaxlib：

# CPU 版本安装
pip install -U "jax[cpu]"

# GPU 版本安装（需要检查 CUDA 版本）
pip install -U "jax[cuda12]"

然后安装项目所需的其他包：

pip install -r requirements.txt

训练模型

使用以下命令开始训练模型：

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 指定验证数据集的路径

生成样本

训练完成后，可以使用以下命令生成样本：

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. 应用案例和最佳实践

生成稳定的晶体结构

利用 CrystalFormer，可以生成给定结构原型的稳定晶体。这一工作流程可以应用于元素替代主导的任务。

强化学习微调

通过强化学习微调，可以进一步优化材料设计，提高生成结构的稳定性和性能。

使用 GUI Notebook

使用 CrystalFormer 提供的 GUI Notebook 可以快速开始晶体材料的条件生成。该 Notebook 在 Google Colab 和 Bohrium 平台上提供。

4. 典型生态项目

• SMACT：用于计算材料属性的 Python 包。
• matminer：一个包含多种材料属性和特征提取工具的库。
• matbench-genmetrics：用于生成材料性能度量的工具。

通过这些生态项目，可以进一步分析和评估 CrystalFormer 生成的晶体结构的性能和有效性。