README_zh.md

---
# 用户自定义标签
tags:
  - MP-20
  - Materials Project
  - crystal structure
  - inorganic materials
  - CIF
  - materials generation
language:
  - en
  - zh
license: CC BY 4.0
---
<p align="center">
  <strong>
    <span style="font-size: 30px;">MP-20</span>
  </strong>
</p>

## 数据集描述

MP-20 来源于 Materials Project 数据库（Jain 等，2013），包含约 4.5 万种通用无机材料，覆盖大多数实验已知且单位晶胞原子数不超过 20 的材料。数据包含元素组成、CIF 结构、空间群、单原子形成能、DFT 带隙、体积模量和磁密度等信息。

数据来源论文：A. Jain *et al.*, *Commentary: The Materials Project: A materials genome approach to accelerating materials innovation*, **APL Materials 1**, 011002 (2013)。<br>
论文链接：https://pubs.aip.org/aip/apm/article/1/1/011002/119685<br>
DOI：https://doi.org/10.1063/1.4812323

本仓库提供原始 CSV 和预处理 cache 两种形式。数据划分包含训练集 27,136 个结构、验证集 9,047 个结构和测试集 9,046 个结构，共 45,229 个晶体结构。

当前数据包包含 30 个数据文件，约 83 MB。

## 数据集支持的任务

本标准化数据仓库整理了 MP-20 的训练、验证和测试数据，可用于：

- 无机晶体结构的数据分析与统计
- 晶体结构生成任务的训练和评测
- 材料属性条件建模
- 形成能、带隙、体积模量和磁密度等属性研究
- 晶体数据加载、预处理和数据管线验证

## 数据集的格式和结构

数据文件位于 `data/MP20/` 目录下：

```text
data/MP20/
├── raw/mp_20/
│   ├── train.csv
│   ├── val.csv
│   └── test.csv
└── cache/mp_20/
    ├── train/
    ├── val/
    └── test/
```

| 文件路径 | 格式 | shape / 内容 | 说明 |
|---|---|---|---|
| `raw/mp_20/train.csv` | CSV + CIF | 27,136 个结构 | 训练集原始晶体与属性数据 |
| `raw/mp_20/val.csv` | CSV + CIF | 9,047 个结构 | 验证集原始晶体与属性数据 |
| `raw/mp_20/test.csv` | CSV + CIF | 9,046 个结构 | 测试集原始晶体与属性数据 |
| `cache/mp_20/train/` | NPY + JSON | 27,136 个结构 | 训练集预处理缓存 |
| `cache/mp_20/val/` | NPY + JSON | 9,047 个结构 | 验证集预处理缓存 |
| `cache/mp_20/test/` | NPY + JSON | 9,046 个结构 | 测试集预处理缓存 |
| `metadata/sha256_manifest.txt` | SHA256 | 30 条记录 | 数据文件完整性校验清单 |

### CSV 数据格式

CSV 文件中的每一行对应一个晶体结构。`cif` 字段保存完整的多行 CIF 文本，因此不能使用普通文本行数统计样本数量。

| 字段 | 类型 | 说明 |
|---|---|---|
| `material_id` | str | Materials Project 结构 ID |
| `pretty_formula` | str | 化学式 |
| `elements` | list[str] | 结构中的元素集合 |
| `cif` | str | CIF 格式晶体结构 |
| `spacegroup_number` | int | 空间群编号 |
| `formation_energy_per_atom` | float | 单原子形成能 |
| `dft_band_gap` | float | DFT 带隙 |
| `dft_bulk_modulus` | float / null | DFT 体积模量，部分样本为空值 |
| `dft_mag_density` | float | DFT 磁密度 |

### Cache 数据格式

每个 `train`、`val`、`test` cache 目录包含以下文件：

| 文件 | 类型 | shape | 说明 |
|---|---|---|---|
| `atomic_numbers.npy` | int64 | `[N_atoms_total]` | 所有结构拼接后的原子序数 |
| `cell.npy` | float64 | `[N_structures, 3, 3]` | 晶胞矩阵 |
| `num_atoms.npy` | int64 | `[N_structures]` | 每个结构的原子数 |
| `pos.npy` | float64 | `[N_atoms_total, 3]` | 所有结构拼接后的分数坐标 |
| `structure_id.npy` | str | `[N_structures]` | 结构 ID |
| `formation_energy_per_atom.json` | JSON | `[N_structures]` | 单原子形成能属性 |
| `dft_band_gap.json` | JSON | `[N_structures]` | DFT 带隙属性 |
| `dft_bulk_modulus.json` | JSON | `[N_structures]` | DFT 体积模量属性 |
| `dft_mag_density.json` | JSON | `[N_structures]` | DFT 磁密度属性 |

## 数据集使用方式

下载数据集：

```bash
hf download --dataset OneScience-Sugon/mp20 --local-dir ./data
```

验证数据集目录、样本数量、数组 shape 和 SHA256：

```bash
python scripts/validate_mp20.py \
  --dataset-root data/MP20 \
  --checksum-manifest metadata/sha256_manifest.txt
```

跳过 SHA256、只检查数据结构：

```bash
python scripts/validate_mp20.py \
  --dataset-root data/MP20 \
  --skip-checksum
```

## OneScience 官方信息

| 平台 | OneScience 主仓库 | Skills 仓库 |
|---|---|---|
| Gitee | https://gitee.com/onescience-ai/onescience | https://gitee.com/onescience-ai/oneskills |
| GitHub | https://github.com/onescience-ai/OneScience | https://github.com/onescience-ai/oneskills |

## 限制与许可证

本仓库对 MP-20 数据进行目录标准化，并提供原始 CSV、预处理 cache、校验清单和验证脚本，没有生成新样本或改变原始晶体及属性内容。

- 数据中的结构与属性来自 Materials Project 及 MP-20 原始数据整理流程。使用数据时应引用 Jain 等 2013 年的 Materials Project 论文和实际使用的数据版本。
- 部分材料属性存在缺失值，使用时需要根据具体任务进行过滤或掩码处理。
- Materials Project 官方声明其数据采用 [Creative Commons Attribution 4.0 International（CC BY 4.0）](https://creativecommons.org/licenses/by/4.0/) 许可。本仓库沿用该数据许可，使用和再分发时需要保留适当署名。
- 如个别条目包含第三方贡献数据或额外限制，应以对应条目的来源和 Materials Project 页面说明为准。