MatterGen 项目使用教程

1. 项目目录结构及介绍

MatterGen 项目是一个用于无机材料设计的生成模型，其目录结构如下：

.
├── .azure
├── .github
├── assets
├── benchmark
├── checkpoints
├── data-release
├── datasets
├── mattergen
├── sampling_conf
├── .gitignore
├── .lfsconfig
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── MODEL_CARD.md
├── NOTICE
├── README.md
├── SECURITY.md
├── pyproject.toml

• .azure: 存储与 Azure 相关的配置文件。
• .github: 包含 GitHub Actions 工作流的配置文件。
• assets: 存储项目资产文件。
• benchmark: 用于性能基准测试的代码和数据。
• checkpoints: 包含预训练模型和微调模型的检查点文件。
• data-release: 发布数据相关文件。
• datasets: 存储项目所使用的数据集。
• mattergen: 核心代码库，包含模型定义和训练逻辑。
• sampling_conf: 采样配置文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• .lfsconfig: Git Large File Storage 配置文件。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 向贡献者说明如何贡献代码的指南。
• LICENSE: 项目的许可协议。
• MODEL_CARD.md: 模型的详细描述和用法。
• NOTICE: 法律声明和通知。
• README.md: 项目说明文件。
• SECURITY.md: 安全策略和漏洞报告指南。
• pyproject.toml: Python 项目配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过命令行工具进行，其中 mattergen-generate 是主要的启动文件，用于生成材料样本。以下是一些基本的命令行参数：

• --pretrained-name: 指定预训练模型的名称。
• --batch_size: 设置批处理大小。
• --num_batches: 设置生成批次数。
• --properties_to_condition_on: 指定条件生成时使用的属性。
• --diffusion_guidance_factor: 设置扩散引导系数，控制样本生成时的条件约束程度。

3. 项目的配置文件介绍

项目的配置文件主要涉及两个方面：环境配置和模型配置。

• 环境配置：通过 pyproject.toml 文件管理项目依赖和环境。例如，使用以下命令安装项目环境：

  pip install uv
  uv venv .venv --python 3.10
  source .venv/bin/activate
  uv pip install -e .
  

• 模型配置：在 sampling_conf 目录中，可以找到用于控制模型采样行为的配置文件。这些文件定义了如何生成样本，包括生成条件、采样策略等。

通过正确理解和配置这些文件，可以更好地利用 MatterGen 项目进行无机材料的设计和研究。