-
Notifications
You must be signed in to change notification settings - Fork 647
docs(agent-skills): add DeePMD-kit skill guide #5497
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
c35e1a5
docs(agent-skills): make install commands copyable
njzjz-bot 74516ee
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] bdf5dd4
docs(agent-skills): address review comments
njzjz-bot 349e943
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 872d9ac
docs(agent-skills): use master for GitHub install example
njzjz-bot 61789c9
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] f8194e3
update paper url
njzjz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| # Agent Skills | ||
|
|
||
| DeePMD-kit provides official [Agent Skills](https://agentskills.io/what-are-skills) that help AI agents run | ||
| DeePMD-kit workflows in a reproducible way. These skills capture | ||
| project-specific operating knowledge—such as training inputs, model | ||
| deployment, LAMMPS integration, and Python inference patterns—so an agent can | ||
| turn a high-level request into concrete files, commands, and validation steps. | ||
|
|
||
| The DeePMD-kit skills were initially developed in the | ||
| [Computational Chemistry Agent Skills](https://github.com/jinzhezenggroup/computational-chemistry-agent-skills) | ||
| project as part of the work described below. They are now maintained directly | ||
| in the DeePMD-kit repository under `skills/`. | ||
|
|
||
| ## List of skills | ||
|
|
||
| - `deepmd-train-dpa3`: Train DeePMD-kit models with the DPA3 descriptor and the | ||
| PyTorch backend, including input generation, neighbor-selection choices, | ||
| training, freezing, and testing. | ||
| - `deepmd-finetune-dpa3`: Fine-tune DPA3 models from self-trained checkpoints, | ||
| multi-task pretrained models, or built-in models downloaded by `dp pretrained download`. | ||
| - `deepmd-train-se-e2-a`: Train classical Deep Potential models with the | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| `se_e2_a` descriptor, including preparation of training JSON files and | ||
| post-training validation. | ||
| - `deepmd-python-inference`: Run Python and CLI inference with trained or | ||
| frozen DeePMD-kit models, including energy, force, virial, descriptor, and | ||
| model-deviation workflows. | ||
| - `lammps-deepmd`: Prepare, explain, and run LAMMPS simulations with DeePMD-kit | ||
| potentials, including common NVE, NVT, and NPT setups. | ||
|
|
||
| ## Related reference | ||
|
|
||
| The DeePMD-kit skills were originally developed as part of the following | ||
| paper: | ||
|
|
||
| - Mingwei Ding, Chen Huang, Yibo Hu, Yifan Li, Zitian Lu, Xingtai Yu, Duo | ||
| Zhang, Wenxi Zhai, Tong Zhu, Qiangqiang Gu, and Jinzhe Zeng. [Automating | ||
| Computational Chemistry Workflows via OpenClaw and Domain-Specific | ||
| Skills](https://doi.org/10.1021/acs.jctc.6c00622). *Journal | ||
| of Chemical Theory and Computation*, 2026. | ||
|
|
||
| ## Install skills | ||
|
|
||
| ### If you are a user | ||
|
|
||
| The easiest way is to send this page to your agent and ask it to install the | ||
| skills for you. Users usually do not need to perform manual installation. | ||
|
|
||
| ### If you are an agent | ||
|
|
||
| If you already have a DeePMD-kit checkout, run this command from the repository | ||
| root: | ||
|
njzjz-bot marked this conversation as resolved.
|
||
|
|
||
| ```bash | ||
| npx -y skills add ./skills -a openclaw -y | ||
| ``` | ||
|
|
||
| If you do not have a checkout, the same skills can also be installed directly | ||
| from GitHub: | ||
|
|
||
| ```bash | ||
| npx -y skills add https://github.com/deepmodeling/deepmd-kit/tree/master/skills \ | ||
| -a openclaw -y | ||
| ``` | ||
|
|
||
| The examples above require Node.js/npm so that `npx` is available, and they | ||
| install the skills for OpenClaw. Replace `openclaw` with the target agent name | ||
| when installing for another agent. The GitHub command lets the skill CLI fetch | ||
| the repository for you. For large repositories or slow networks, this can take | ||
| longer than installing from an existing local checkout. Refresh or restart the | ||
| session afterward so the installed skills are reloaded. | ||
|
|
||
| ## Minimal verification | ||
|
|
||
| Ask the agent to perform a small task that exercises the installed skill | ||
| without launching an expensive calculation. For example: | ||
|
|
||
| - “Use the `deepmd-python-inference` skill to write a minimal Python snippet | ||
| for loading a frozen DeePMD-kit model and evaluating one frame.” | ||
| - “Use the `deepmd-train-dpa3` skill to draft a small DPA3 training input for a | ||
| water dataset, but do not start training.” | ||
| - “Use the `lammps-deepmd` skill to prepare an NVT LAMMPS input file for a | ||
| DeePMD-kit model, and explain each command.” | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.