---

DeePMD-kit

关于DeePMD-kit

DeePMD-kit是一个用Python/C++编写的软件包，旨在最大限度地减少构建基于深度学习的原子间势能和力场模型以及进行分子动力学（MD）模拟所需的工作量。这为解决分子模拟中精度与效率之间的矛盾带来了新的希望。DeePMD-kit的应用范围涵盖了从有限分子到扩展体系，从金属体系到化学键合体系。

欲了解更多信息，请参阅文档。

突出特点

• 与多种后端框架兼容，包括TensorFlow、PyTorch、JAX和Paddle等最流行的深度学习框架，使训练过程高度自动化且高效。
• 与高性能经典MD及量子（路径积分）MD软件包集成，如LAMMPS、i-PI、AMBER、CP2K、GROMACS、OpenMM和ABACUS等。
• 实现了Deep Potential系列模型，这些模型已成功应用于有限体系和扩展体系，包括有机分子、金属、半导体、绝缘体等。
• 支持MPI和GPU加速，使其在高性能并行和分布式计算中表现出色。
• 高度模块化，易于适应不同的描述符，用于构建基于深度学习的势能模型。

许可证与致谢

DeePMD-kit项目采用GNU LGPLv3.0许可证。如果您在未来的研究成果中使用了本代码，请引用以下通用文献：

• Han Wang, Linfeng Zhang, Jiequn Han, and Weinan E. "DeePMD-kit: A deep learning package for many-body potential energy representation and molecular dynamics." Computer Physics Communications 228 (2018): 178-184.
• Jinzhe Zeng, Duo Zhang, Denghui Lu, Pinghui Mo, Zeyu Li, Yixiao Chen, Marián Rynik, Li'ang Huang, Ziyao Li, Shaochen Shi, Yingze Wang, Haotian Ye, Ping Tuo, Jiabin Yang, Ye Ding, Yifan Li, Davide Tisi, Qiyu Zeng, Han Bao, Yu Xia, Jiameng Huang, Koki Muraoka, Yibo Wang, Junhan Chang, Fengbo Yuan, Sigbjørn Løland Bore, Chun Cai, Yinnian Lin, Bo Wang, Jiayan Xu, Jia-Xin Zhu, Chenxing Luo, Yuzhi Zhang, Rhys E. A. Goodall, Wenshuo Liang, Anurag Kumar Singh, Sikai Yao, Jingchao Zhang, Renata Wentzcovitch, Jiequn Han, Jie Liu, Weile Jia, Darrin M. York, Weinan E, Roberto Car, Linfeng Zhang, Han Wang. "DeePMD-kit v2: A software package for deep potential models." J. Chem. Phys. 159 (2023): 054801.
• Jinzhe Zeng, Duo Zhang, Anyang Peng, Xiangyu Zhang, Sensen He, Yan Wang, Xinzijian Liu, Hangrui Bi, Yifan Li, Chun Cai, Chengqian Zhang, Yiming Du, Jia-Xin Zhu, Pinghui Mo, Zhengtao Huang, Qiyu Zeng, Shaochen Shi, Xuejian Qin, Zhaoxi Yu, Chenxing Luo, Ye Ding, Yun-Pei Liu, Ruosong Shi, Zhenyu Wang, Sigbjørn Løland Bore, Junhan Chang, Zhe Deng, Zhaohan Ding, Siyuan Han, Wanrun Jiang, Guolin Ke, Zhaoqing Liu, Denghui Lu, Koki Muraoka, Hananeh Oliaei, Anurag Kumar Singh, Haohui Que, Weihong Xu, Zhangmancang Xu, Yong-Bin Zhuang, Jiayu Dai, Timothy J. Giese, Weile Jia, Ben Xu, Darrin M. York, Linfeng Zhang, Han Wang. "DeePMD-kit v3: A Multiple-Backend Framework for Machine Learning Potentials." J. Chem. Theory Comput. 21 (2025): 4375-4385.

此外，请参考CITATIONS.bib文件，以引用您所使用的方法。

主要版本亮点

初版

Deep Potential 的目标是利用深度学习技术，构建一个通用、精确、计算高效且可扩展的原子间势能模型。其核心在于通过为每个原子分配局部参考系和局部环境，来尊重势能模型的广延性和对称不变性。每个环境包含有限数量的原子，其局部坐标以保持对称的方式排列。这些局部坐标随后通过一个子网络转换为所谓的“原子能量”。将所有原子能量相加即可得到系统的总势能。

最初的概念验证发表在 Deep Potential 论文中，该论文采用了一种仅使用势能进行神经网络训练的方法。然而，对于典型的从头算分子动力学（AIMD）数据集而言，这种方法不足以重现轨迹。Deep Potential Molecular Dynamics（DeePMD）模型克服了这一局限性。此外，得益于引入灵活的损失函数族，DeePMD 的学习过程相比 Deep Potential 方法有了显著提升。以此构建的神经网络势能能够准确地再现经典和量子（路径积分）AIMD 轨迹，适用于扩展体系和有限体系，且计算成本随系统规模线性增长，始终比同等 AIMD 模拟低几个数量级。

尽管效率极高，但原始的 Deep Potential 模型在满足势能模型的广延性和对称不变性的同时，也引入了模型中的不连续性。这在正则系综采样中对轨迹的影响可以忽略，但在计算动力学和力学性质时可能不够充分。基于这些考虑，我们开发了 Deep Potential-Smooth Edition（DeepPot-SE）模型，用平滑且自适应的嵌入网络替代了非平滑的局部框架。DeepPot-SE 在模拟物理、化学、生物学和材料科学等领域中感兴趣的多种体系方面表现出色。

除了构建势能模型外，DeePMD-kit 还可用于构建粗粒化模型。在这些模型中，我们需要参数化的量是粗粒化粒子的自由能或粗粒化势能。更多细节请参阅 DeePCG 论文。

v1

• 代码重构，使其高度模块化。
• 支持 GPU 计算描述符。

v2

• 模型压缩。使模型推理效率提升 4 至 15 倍。
• 新型描述符。包括 se_e2_r、se_e3 和 se_atten（DPA-1）。
• 描述符混合。通过拼接多个描述符构建混合描述符。
• 原子类型嵌入。启用原子类型嵌入以降低训练复杂度并提升性能。
• 电偶极矩（向量）和极化率（矩阵）的训练与推理。
• 训练集和验证集的分离。
• 针对 GPU 的优化训练，包括 CUDA 和 ROCm。
• 非冯·诺依曼架构。
• C API，用于与第三方软件包对接。

有关 v2.2.3 之前所有功能的详细信息，请参阅我们的 v2 论文。

v3

• 支持多种后端。新增 PyTorch 和 JAX 后端。
• DPA2 和 DPA3 模型。
• 外部模型插件机制。

有关 v3.0 之前所有功能的详细信息，请参阅我们的 v3 论文。

安装与使用 DeePMD-kit

只需 1 秒钟复制粘贴并运行即可。

curl -fsSL https://dp1s.deepmodeling.com | bash

有关详细信息及替代安装方法，请阅读 在线文档。

接下来，我们将简要介绍 DeePMD-kit 的使用方法。您可以从第一步开始：

dp

代码结构

代码组织如下：

• examples: 示例。
• deepmd: DeePMD-kit Python 模块。
• source/lib: 核心库源代码。
• source/op: 算子（OP）实现。
• source/api_cc: DeePMD-kit C++ API 源代码。
• source/api_c: C API 源代码。
• source/nodejs: Node.js API 源代码。
• source/ipi: i-PI 客户端源代码。
• source/lmp: LAMMPS 模块源代码。

贡献

请参阅 DeePMD-kit 贡献指南，成为我们的贡献者吧！ 🤓

DeePMD-kit 快速上手指南

DeePMD-kit 是一款基于深度学习的分子势能模型构建与分子动力学（MD）模拟软件包。它旨在解决分子模拟中精度与效率的矛盾，支持从有限分子到扩展体系（如金属、半导体、绝缘体等）的多种应用场景。

1. 环境准备

在开始之前，请确保您的系统满足以下基本要求：

• 操作系统：推荐 Linux (Ubuntu/CentOS) 或 macOS。Windows 用户建议使用 WSL2 或 Docker。
• 硬件要求：
  • CPU：支持 AVX2 指令集的现代处理器。
  • GPU（可选但推荐）：NVIDIA GPU (需安装 CUDA) 或 AMD GPU (需安装 ROCm)，用于加速训练和推理。
• 前置依赖：
  • Python 3.8+
  • C++ 编译器 (gcc/g++)
  • CMake 3.16+
  • MPI (用于并行计算，如 OpenMPI 或 MPICH)
  • 深度学习框架后端：DeePMD-kit v3 支持 PyTorch, JAX, TensorFlow, 和 PaddlePaddle。您至少需要安装其中一种（官方示例通常默认使用 PyTorch 或 TensorFlow）。

提示：如果您希望避免复杂的环境配置，可以直接使用官方提供的 Docker 镜像，或采用下文推荐的“一键安装”脚本，该脚本会自动处理大部分依赖。

2. 安装步骤

DeePMD-kit 提供了多种安装方式，推荐使用官方提供的一键安装脚本，它会自动检测环境并选择合适的安装方式（Conda/Pip/Docker）。

方法一：一键安装脚本（推荐）

这是最快捷的方式，适合大多数用户。在终端执行以下命令：

curl -fsSL https://dp1s.deepmodeling.com | bash

该脚本会引导您完成安装过程。安装完成后，请根据提示重启终端或激活相应的 Conda 环境。

方法二：使用 Conda 安装

如果您已经配置好 Conda 环境，可以通过 conda-forge 直接安装（以 PyTorch 后端为例）：

conda install -c conda-forge deepmd-kit-pytorch

如需其他后端（如 tensorflow, jax），请将 deepmd-kit-pytorch 替换为对应的包名。

方法三：使用 Pip 安装

pip install deepmd-kit

注意：Pip 安装可能需要您预先手动安装好对应的深度学习框架（如 torch 或 tensorflow）以及 MPI 库。

验证安装

安装完成后，运行以下命令检查版本信息，确认安装成功：

dp --version

3. 基本使用

DeePMD-kit 的核心工作流通常包含三个步骤：数据预处理 -> 模型训练 -> 模型推理/压缩。所有操作均通过 dp 命令行工具完成。

第一步：查看帮助与示例

输入 dp 查看可用命令列表：

dp

您可以访问官方仓库的 examples 目录获取完整的测试数据集和输入文件模板。

第二步：准备输入文件

您需要准备一个 JSON 格式的输入文件（例如 input.json），定义网络结构、训练参数和数据路径。以下是一个极简的训练配置示例（train 部分）：

{
  "model": {
    "type_map": ["O", "H"],
    "descriptor": {
      "type": "se_e2_a",
      "sel": [46, 92],
      "rcut_smth": 0.50,
      "rcut": 6.00,
      "neuron": [25, 50, 100],
      "resnet_dt": false,
      "axis_neuron": 16,
      "seed": 1
    },
    "fitting_net": {
      "neuron": [240, 240, 240],
      "resnet_dt": true,
      "seed": 1
    }
  },
  "learning_rate": {
    "type": "exp",
    "start_lr": 0.001,
    "stop_lr": 3.51e-7,
    "decay_steps": 5000
  },
  "loss": {
    "start_pref_e": 0.02,
    "limit_pref_e": 1,
    "start_pref_f": 1000,
    "limit_pref_f": 1,
    "start_pref_v": 0,
    "limit_pref_v": 0
  },
  "training": {
    "training_data": {
      "systems": ["./data/train"],
      "batch_size": "auto",
      "seed": 1
    },
    "validation_data": {
      "systems": ["./data/valid"],
      "batch_size": "auto",
      "seed": 1
    },
    "numb_steps": 100000,
    "seed": 1,
    "disp_file": "lcurve.out",
    "disp_freq": 1000,
    "save_freq": 10000
  }
}

第三步：训练模型

使用准备好的数据和配置文件启动训练：

dp train input.json

训练过程中，程序会输出损失函数变化曲线（默认保存到 lcurve.out），并定期保存模型检查点（.pb 文件）。

第四步：模型压缩（可选但推荐）

为了提高推理速度（特别是在进行大规模分子动力学模拟时），建议对训练好的模型进行压缩：

dp compress -i frozen_model.pb -o compressed_model.pb

压缩后的模型推理速度通常可提升 4-15 倍，且精度损失极小。

第五步：进行分子动力学模拟

DeePMD-kit 本身不直接运行 MD，而是作为插件接口连接到经典的 MD 软件（如 LAMMPS, GROMACS, CP2K 等）。以 LAMMPS 为例，需要在 LAMMPS 输入脚本中加载深势模型：

pair_style deepmd compressed_model.pb
pair_coeff * *

随后即可像使用普通力场一样运行 run 命令进行模拟。

---

更多高级功能（如多后端切换、插件开发、粗粒化模型等）请参考 官方文档。