Skip to content

Commit 71921b9

Browse files
committed
doc: enhance documentation for training and validation data systems input handling
1 parent ca6d147 commit 71921b9

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

deepmd/utils/argcheck.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2993,8 +2993,9 @@ def training_data_args() -> list[
29932993
link_sys = make_link("systems", "training/training_data/systems")
29942994
doc_systems = (
29952995
"The data systems for training. "
2996+
"This key can be a list or a str. "
29962997
"When provided as a string, it can be a system directory path (containing 'type.raw') or a parent directory path to recursively search for all system subdirectories. "
2997-
"When provided as a list, each string item is processed the same way as individual string inputs."
2998+
"When provided as a list, each string item in the list is processed the same way as individual string inputs, i.e., each path can be a system directory or a parent directory to recursively search for all system subdirectories."
29982999
)
29993000
doc_patterns = (
30003001
"The customized patterns used in `rglob` to collect all training systems. "
@@ -3074,8 +3075,9 @@ def validation_data_args() -> list[
30743075
link_sys = make_link("systems", "training/validation_data/systems")
30753076
doc_systems = (
30763077
"The data systems for validation. "
3078+
"This key can be a list or a str. "
30773079
"When provided as a string, it can be a system directory path (containing 'type.raw') or a parent directory path to recursively search for all system subdirectories. "
3078-
"When provided as a list, each string item is processed the same way as individual string inputs."
3080+
"When provided as a list, each string item in the list is processed the same way as individual string inputs, i.e., each path can be a system directory or a parent directory to recursively search for all system subdirectories."
30793081
)
30803082
doc_patterns = (
30813083
"The customized patterns used in `rglob` to collect all validation systems. "

doc/train/training-advanced.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ Other training parameters are given in the {ref}`training <training>` section.
7676
The sections {ref}`training_data <training/training_data>` and {ref}`validation_data <training/validation_data>` give the training dataset and validation dataset, respectively. Taking the training dataset for example, the keys are explained below:
7777

7878
- {ref}`systems <training/training_data/systems>` provide paths of the training data systems. DeePMD-kit allows you to provide multiple systems with different numbers of atoms. This key can be a `list` or a `str`.
79-
- `list`: {ref}`systems <training/training_data/systems>` gives the training data systems.
80-
- `str`: {ref}`systems <training/training_data/systems>` should be a valid path. DeePMD-kit will recursively search all data systems in this path.
79+
- `str`: {ref}`systems <training/training_data/systems>` should be a valid path. It can be a system directory path (containing 'type.raw') or a parent directory path to recursively search for all system subdirectories.
80+
- `list`: {ref}`systems <training/training_data/systems>` gives a list of paths. Each string item in the list is processed the same way as individual string inputs, i.e., each path can be a system directory or a parent directory to recursively search for all system subdirectories.
8181
- At each training step, DeePMD-kit randomly picks {ref}`batch_size <training/training_data/batch_size>` frame(s) from one of the systems. The probability of using a system is by default in proportion to the number of batches in the system. More options are available for automatically determining the probability of using systems. One can set the key {ref}`auto_prob <training/training_data/auto_prob>` to
8282
- `"prob_uniform"` all systems are used with the same probability.
8383
- `"prob_sys_size"` the probability of using a system is proportional to its size (number of frames).

0 commit comments

Comments
 (0)