Skip to content

docs(skills): add dpdata driver skill#953

Merged
njzjz merged 3 commits intodeepmodeling:masterfrom
njzjz-bot:skills/dpdata-driver-skill
Mar 23, 2026
Merged

docs(skills): add dpdata driver skill#953
njzjz merged 3 commits intodeepmodeling:masterfrom
njzjz-bot:skills/dpdata-driver-skill

Conversation

@njzjz-bot
Copy link
Contributor

@njzjz-bot njzjz-bot commented Mar 15, 2026

This PR adds an Agent Skill under skills/ documenting dpdata Python Driver plugins and System.predict() usage.

Includes a runnable ASE example (with uv inline script metadata for dependencies) and notes on supported driver keys.

Authored by OpenClaw (model: gpt-5.2)

Summary by CodeRabbit

  • Documentation

    • Added a comprehensive dpdata driver guide covering driver concepts, runtime discovery, verification checks, minimal and ASE examples, hybrid driver configuration, and notes on external dependencies.
  • Chores

    • Updated ignore rules to exclude local virtual environment and lock files.

@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation dpdata labels Mar 15, 2026
@codspeed-hq
Copy link

codspeed-hq bot commented Mar 15, 2026

Merging this PR will not alter performance

⚠️ Unknown Walltime execution environment detected

Using the Walltime instrument on standard Hosted Runners will lead to inconsistent data.

For the most accurate results, we recommend using CodSpeed Macro Runners: bare-metal machines fine-tuned for performance measurement consistency.

✅ 2 untouched benchmarks


Comparing njzjz-bot:skills/dpdata-driver-skill (76f7970) with master (0b6bf2f)

Open in CodSpeed

@codecov
Copy link

codecov bot commented Mar 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.65%. Comparing base (d68b700) to head (76f7970).
⚠️ Report is 6 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #953      +/-   ##
==========================================
+ Coverage   86.37%   86.65%   +0.28%     
==========================================
  Files          86       86              
  Lines        8086     8019      -67     
==========================================
- Hits         6984     6949      -35     
+ Misses       1102     1070      -32     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitai
Copy link

coderabbitai bot commented Mar 15, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Added two ignore rules to .gitignore (uv.lock, .venv/) and added a new documentation page skills/dpdata-driver/SKILL.md describing dpdata Driver plugins, usage with System.predict(), examples (ASE, hybrid), runtime discovery, verification, and dependency notes.

Changes

Cohort / File(s) Summary
Development Configuration
.gitignore
Added uv.lock and .venv/ entries to ignore local development artifacts.
Documentation
skills/dpdata-driver/SKILL.md
New documentation describing the dpdata Driver role, ways to provide drivers (string key or Driver instance), runtime discovery (Driver.get_drivers()), verification steps, ASE runnable example, hybrid driver configuration, and external dependency notes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

size:M

Suggested reviewers

  • wanghan-iapcm
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(skills): add dpdata driver skill' directly and clearly describes the main change: adding documentation for a dpdata driver skill under the skills directory.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@skills/dpdata-driver/SKILL.md`:
- Around line 86-93: The example uses ASE's EMT calculator (calculator=EMT())
for an H2 demo which is unreliable; replace EMT with a general-purpose
calculator such as ASE's LennardJones to produce stable, documented results.
Update the snippet that constructs the System and calls
sys.predict(driver="ase", calculator=EMT()) so it instead passes
calculator=LennardJones() (or another suitable cross-species calculator) and
ensure any necessary imports (e.g., from ase.calculators.lennardjones import
LennardJones) are added and referenced where EMT and calculator=EMT() currently
appear.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1c67b4fd-be54-4d43-897f-dbedfa214c54

📥 Commits

Reviewing files that changed from the base of the PR and between d68b700 and f5a383c.

📒 Files selected for processing (2)
  • .gitignore
  • skills/dpdata-driver/SKILL.md

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new agent skill document for using dpdata “driver plugins” via the Python API (e.g., System.predict()), plus ignores common local uv/venv artifacts.

Changes:

  • Add skills/dpdata-driver/SKILL.md documenting driver keys, System.predict(), and usage examples (ASE + hybrid).
  • Update .gitignore to ignore uv.lock and .venv/.

Reviewed changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated 3 comments.

File Description
skills/dpdata-driver/SKILL.md New skill documentation for dpdata driver plugins and example workflows.
.gitignore Ignore local uv.lock and .venv/ development artifacts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Mar 18, 2026
@wanghan-iapcm
Copy link
Contributor

please check the suggestions raised by the AI reviewers.

Load built-in plugins before listing driver keys, align the uv example with the project's Python support floor, and use a safer/runnable ASE example with Lennard-Jones and pathlib-based file writes.

Authored by OpenClaw (model: gpt-5.4)
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
skills/dpdata-driver/SKILL.md (1)

39-47: Prefer “examples of keys” wording over a fixed list.

This list can drift across versions/extras and become misleading. Consider reframing as “commonly seen keys” (or removing the explicit list) and lean on the runtime snippet as the source of truth.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@skills/dpdata-driver/SKILL.md` around lines 39 - 47, Replace the hard-coded
list under the "In the current repo state, keys include:" section with a more
flexible phrasing; change the explicit bullet list (ase, dp / deepmd /
deepmd-kit, gaussian, sqm, hybrid) to wording like "examples of commonly seen
keys" or remove the list and point readers to the runtime snippet as the source
of truth (update the sentence beginning "In the current repo state, keys
include:" accordingly) so the documentation does not become misleading as dpdata
versions/extras change.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@skills/dpdata-driver/SKILL.md`:
- Around line 39-47: Replace the hard-coded list under the "In the current repo
state, keys include:" section with a more flexible phrasing; change the explicit
bullet list (ase, dp / deepmd / deepmd-kit, gaussian, sqm, hybrid) to wording
like "examples of commonly seen keys" or remove the list and point readers to
the runtime snippet as the source of truth (update the sentence beginning "In
the current repo state, keys include:" accordingly) so the documentation does
not become misleading as dpdata versions/extras change.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 62f9dacd-c35f-47ed-87d1-d2094a9558d6

📥 Commits

Reviewing files that changed from the base of the PR and between f5a383c and 1607cc6.

📒 Files selected for processing (1)
  • skills/dpdata-driver/SKILL.md

Added license, compatibility, and metadata information.

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@ustc.edu.cn>
@njzjz njzjz enabled auto-merge (squash) March 23, 2026 09:45
@njzjz njzjz merged commit b9b2ac5 into deepmodeling:master Mar 23, 2026
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation dpdata lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants