Skip to content

Commit 7c9813b

Browse files
committed
refactor docstring
1 parent d1871b5 commit 7c9813b

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

deepmd/utils/argcheck.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3226,9 +3226,13 @@ def training_args(
32263226
"of batches for system i and p_i is the sampling probability after "
32273227
"sys_probs/auto_prob normalization. In multi-task mode, model_prob is "
32283228
"normalized to sum to 1, per-task total_numb_batch values are computed "
3229-
"as above, and the final total_numb_batch is their model_prob-weighted "
3230-
"sum. At least one of numb_steps or num_epoch must be set; otherwise a "
3231-
"ValueError is raised."
3229+
"as above, and the final total_numb_batch is their model_prob-weighted sum. "
3230+
"Note that in multi-task mode, this defines an 'expected epoch' where each "
3231+
"sample is visited once in expectation across all tasks, rather than a "
3232+
"full epoch for each individual task. For multi-task pretraining scenarios "
3233+
"where different tasks require different numbers of visits, using numb_steps "
3234+
"directly is recommended for more explicit control. At least one of numb_steps "
3235+
"or num_epoch must be set; otherwise a ValueError is raised."
32323236
)
32333237
doc_seed = "The random seed for getting frames from the training data set."
32343238
doc_disp_file = "The file for printing learning curve."

0 commit comments

Comments
 (0)