docs: expand DPA4 water README with Mini/Neo/Air variant comparison#5711
docs: expand DPA4 water README with Mini/Neo/Air variant comparison#5711SchrodingersCattt wants to merge 8 commits into
Conversation
📝 WalkthroughWalkthroughThis PR documents DPA4 model architecture variants (Air, Neo, Mini) in the water example README, adding a comparison table of descriptor keys and reorganizing the Input files section. It also adds three new example JSON training configuration files under arc_variants/ for these variants. ChangesDPA4 architecture variants
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
d3d483e to
5adc1b8
Compare
There was a problem hiding this comment.
🧹 Nitpick comments (1)
examples/water/dpa4/README.md (1)
23-36: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winClarify how to invoke the
arc_variants/files given relative dataset paths.The variant JSON files (e.g.
arc_variants/input-air.json) use"../data/data_0"fortraining_data.systems, same as the baselineinput.json. DeepMD resolves these paths relative to the current working directory at invocation time, not relative to the JSON file's location. The "Run" section (Line 37+) only documentscd examples/water/dpa4 && dp --pt train input.json; it doesn't show how to run a variant (e.g.,dp --pt train arc_variants/input-air.jsonfrom the sameexamples/water/dpa4directory). If a user insteadcds intoarc_variants/before running, the relative path would resolve one level too shallow and fail to find the dataset.Consider adding an explicit example invocation for the variants next to this bullet to avoid path-resolution confusion.
📝 Suggested addition
- `arc_variants/`: input files for DPA4-Air, DPA4-Neo, and DPA4-Mini architectures. + + Run a variant from `examples/water/dpa4` (do not `cd` into `arc_variants/`), + e.g.: + ```bash + dp --pt train arc_variants/input-neo.json + ```🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@examples/water/dpa4/README.md` around lines 23 - 36, The arc_variants/ entries need an explicit usage example because their training_data.systems paths are resolved from the current working directory, not the JSON location. Update the README’s input-files section by adding a clear invocation example for one of the arc_variants JSONs using the same examples/water/dpa4 working directory, and reference arc_variants/input-air.json or arc_variants/input-neo.json so users know not to run it from inside arc_variants/.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@examples/water/dpa4/README.md`:
- Around line 23-36: The arc_variants/ entries need an explicit usage example
because their training_data.systems paths are resolved from the current working
directory, not the JSON location. Update the README’s input-files section by
adding a clear invocation example for one of the arc_variants JSONs using the
same examples/water/dpa4 working directory, and reference
arc_variants/input-air.json or arc_variants/input-neo.json so users know not to
run it from inside arc_variants/.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 7074b342-13cc-430a-ae7e-95b283d60198
📒 Files selected for processing (4)
examples/water/dpa4/README.mdexamples/water/dpa4/arc_variants/input-air.jsonexamples/water/dpa4/arc_variants/input-mini.jsonexamples/water/dpa4/arc_variants/input-neo.json
Add detailed comparison of DPA4-Mini, DPA4-Neo, and DPA4-Air model variants from the DPA4-MatPES-v20260628 release, including: - Architecture parameter table (channels, lmax, n_blocks, so2_layers, n_focus) - Training hyperparameter comparison (lr, batch_size, epochs) - Step-by-step guide on how to switch between variants in input.json - Validation metrics and model sizes - Usage instructions for pretrained checkpoints (test, freeze, finetune) - References to DPA4 paper, DeePMD-kit docs, and MatPES dataset
- Add arc_variants/ directory with input-air.json, input-neo.json, input-mini.json - Each file uses the existing water dataset paths, only descriptor keys differ - README: replace verbose section with a compact table showing which keys to change - Air (default): channels=64, lmax=3, n_blocks=3, so2_layers=4, n_focus=1 - Neo: channels=32, n_blocks=2, so2_layers=3, n_focus=2 - Mini: channels=32, lmax=2, n_blocks=2, so2_layers=3, n_focus=1
5adc1b8 to
0b3071f
Compare
for more information, see https://pre-commit.ci
Correct formatting for the 'Run' section in README. Signed-off-by: Ming-Yu Guo <guomy26@mail2.sysu.edu.cn>
Signed-off-by: Ming-Yu Guo <guomy26@mail2.sysu.edu.cn>
for more information, see https://pre-commit.ci
Clarified instructions for switching model architecture variants. Signed-off-by: Ming-Yu Guo <guomy26@mail2.sysu.edu.cn>
for more information, see https://pre-commit.ci
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #5711 +/- ##
==========================================
- Coverage 81.22% 81.09% -0.13%
==========================================
Files 980 980
Lines 109356 109355 -1
Branches 4206 4205 -1
==========================================
- Hits 88821 88679 -142
- Misses 19013 19152 +139
- Partials 1522 1524 +2 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Summary
Expand
examples/water/dpa4/README.mdwith detailed comparison of the three DPA4 model variants (Mini, Neo, Air) from the DPA4-MatPES-v20260628 release.Changes
channels,lmax,n_blocks,so2_layers,n_focusfor all three variantsstart_lr,batch_size,num_epochsinput.jsondescriptor, learning_rate, and training sections to switch between Mini/Neo/AirAll data sourced from the official AIS Square model page and the released training config files.
-- Co-authored by: https://matmaster.bohrium.com/matmaster/
Summary by CodeRabbit