# DP-EVA Documentation

Deep Potential EVolution Accelerator (DP-EVA) is an active learning framework designed for efficient fine-tuning of DPA universal machine learning interatomic potential.

Citation

If you use DP-EVA, please cite the project article: DP-EVA in Clean Energy.

Getting Started

• 安装与环境准备（Installation）
  • 1. 目的与范围
  • 2. 相关方
  • 3. Python 环境要求
  • 4. 从零准备 Local PyTorch 环境
  • 5. 其它安装方式与依赖边界
  • 6. 预置集群环境
  • 7. 下一步
• Paper case tutorial (CPU notebooks)
• Quickstart（最短路径跑通）
  • 准备
  • 选择运行位置
  • 依次运行
  • 查看产物
  • 从头重新运行示例
  • 换用自己的模型与数据
• SAI 快速上手（Slurm 用户）
  • 1. 目的与范围
  • 2. 环境
  • 3. 安装与自检
  • 4. 提交配置要点
  • 5. 已知坑（逐条给出处）
  • 6. 完成标记与监控
  • 7. 相关文档
  • 8. 变更记录
• CLI 使用指南
  • 1. 目的与范围
  • 2. 相关方
  • 3. 总体用法
  • 4. 子命令职责、输入输出与配置
  • 5. 完成标记与链式编排
  • 6. 异常处理与退出码
  • 7. 变更记录
• 配置编写指南（Configuration）
  • 1. 目的与范围
  • 2. 相关方
  • 3. 路径解析规则（强烈建议使用相对路径）
  • 4. Submission 配置（Local / Slurm）
  • 5. 各 Workflow 最小配置示例
  • 6. 异常处理
  • 7. 变更记录
  • 替换入门示例中的模型与数据

User Guides

• Slurm 使用与排障指南
  • 1. 目的与范围
  • 2. 相关方
  • 3. Submission 配置结构
  • 4. 工作流脚本与日志约定
  • 5. 运行示例
  • 6. 异常处理与排障
  • 7. 变更记录
• Troubleshooting（常见问题与排查）
  • 1. 目的与范围
  • 2. 相关方
  • 3. 总体排查顺序（强制建议）
  • 4. 环境类问题
  • 5. 数据类问题（dpdata / Multi DataPool）
  • 6. 作业与调度类问题（Slurm）
  • 7. 数值类问题（NaN/Inf/聚类不收敛）
  • 8. 变更记录

Reference

• Reference
  • Reference（权威参考）
  • 参数校验与约束（Validation Rules）
  • 上游软件与依赖边界（Upstream Software）

Developer Guide

• DP-EVA 项目开发文档
  • 0. 开发者快速入口 (Read First)
  • 1. 项目概述 (Overview)
  • 2. 系统架构 (Architecture)
  • 3. 核心模块详解 (Modules)
  • 4. 接口使用指南 (Interface Guide)
  • 5. 开发与测试 (Development)
  • 6. 版本修订记录 (Revision History)
• Architecture（系统结构）
• Configuration Reference
  • Common & Submission Configuration
  • Feature Generation Configuration
  • Exploration Configuration
  • Training Configuration
  • Inference Configuration
  • Collection (Active Learning) Configuration
  • Labeling Configuration
  • Analysis Configuration
• Workflows API
  • AnalysisWorkflow
  • CollectionWorkflow
  • DataCleaningWorkflow
  • FeatureWorkflow
  • InferenceWorkflow
  • TrainingWorkflow
• Labeling API
  • AbacusGenerator
  • AbacusPostProcessor
  • ResubmissionStrategy
• Sampling API
• Uncertainty API
• Submission API

Governance

• 文档治理快速上手（开发者与 AI）
• 过程资产生命周期（AI 草案到项目文档）
• Policy（制度与规范）

项目级审查与实验报告保留在仓库 docs/reports/ 目录中，作为可复盘资产按需访问，不纳入主导航的稳定入口。