Skip to content

Commit 69b2b4a

Browse files
committed
docs(argcheck): clarify dos shape wording
Problem - One remaining PR review comment pointed out that used the awkward phrase "frame lines". Change - rephrase the DOS shape description to use "frames (rows)" and clearer column wording Authored by OpenClaw (model: custom-chat-jinzhezeng-group/gpt-5.4)
1 parent 7dbf273 commit 69b2b4a

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

deepmd/utils/argcheck.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
doc_hybrid = "Concatenates a list of descriptors into a new descriptor."
5656
# fitting
5757
doc_ener = "Fit an energy model (potential energy surface)."
58-
doc_dos = "Fit a density of states model. The total density of states / site-projected density of states labels should be provided by `dos.npy` or `atom_dos.npy` in each data system. The file has a number of frame lines and a number of energy-grid columns (times the number of atoms in `atom_dos.npy`). See `loss` parameter."
58+
doc_dos = "Fit a density of states model. The total density of states / site-projected density of states labels should be provided by `dos.npy` or `atom_dos.npy` in each data system. The file has a number of frames (rows) and a number of energy-grid columns (multiplied by the number of atoms in `atom_dos.npy`). See `loss` parameter."
5959
doc_dipole = "Fit an atomic dipole model. Global dipole labels or atomic dipole labels for all selected atoms (see `sel_type`) should be provided by `dipole.npy` in each data system. The file should have shape `(n_frames, 3*n_selected)` for atomic dipole labels, or shape `(n_frames, 3)` for global dipole labels. See `loss` parameter."
6060
doc_polar = "Fit an atomic polarizability model. Global polarizability labels or atomic polarizability labels for all selected atoms (see `sel_type`) should be provided by `polarizability.npy` in each data system. The file should have shape `(n_frames, 9*n_selected)` for atomic polarizability labels, or shape `(n_frames, 9)` for global polarizability labels. See `loss` parameter."
6161
# modifier

0 commit comments

Comments
 (0)