Arguments of the input script
Host and nodes
- name:
- type:
str, optional, default:pfdargument path:nameThe workflow name, ‘pfd’ for default
- dflow_config:
- type:
dict|NoneType, optional, default:Noneargument path:dflow_configThe configuration passed to dflow
- dflow_s3_config:
- type:
dict|NoneType, optional, default:Noneargument path:dflow_s3_configThe S3 configuration passed to dflow
- default_step_config:
- type:
dict, optional, default:{}argument path:default_step_configThe default step configuration.
- template_config:
- type:
dict, optional, default:{'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1'}argument path:default_step_config/template_configThe configs passed to the PythonOPTemplate.
- image:
- type:
str, optional, default:registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1argument path:default_step_config/template_config/imageThe image to run the step.
- timeout:
- type:
int|NoneType, optional, default:Noneargument path:default_step_config/template_config/timeoutThe time limit of the OP. Unit is second.
- retry_on_transient_error:
- type:
int|NoneType, optional, default:Noneargument path:default_step_config/template_config/retry_on_transient_errorThe number of retry times if a TransientError is raised.
- timeout_as_transient_error:
- type:
bool, optional, default:Falseargument path:default_step_config/template_config/timeout_as_transient_errorTreat the timeout as TransientError.
- envs:
- type:
dict|NoneType, optional, default:Noneargument path:default_step_config/template_config/envsThe environmental variables.
- template_slice_config:
- type:
dict, optionalargument path:default_step_config/template_slice_configThe configs passed to the Slices.
- group_size:
- type:
int|NoneType, optional, default:Noneargument path:default_step_config/template_slice_config/group_sizeThe number of tasks running on a single node. It is efficient for a large number of short tasks.
- pool_size:
- type:
int|NoneType, optional, default:Noneargument path:default_step_config/template_slice_config/pool_sizeThe number of tasks running at the same time on one node.
- continue_on_failed:
- type:
bool, optional, default:Falseargument path:default_step_config/continue_on_failedIf continue the the step is failed (FatalError, TransientError, A certain number of retrial is reached…).
- continue_on_num_success:
- type:
int|NoneType, optional, default:Noneargument path:default_step_config/continue_on_num_successOnly in the sliced OP case. Continue the workflow if a certain number of the sliced jobs are successful.
- continue_on_success_ratio:
- type:
float|NoneType, optional, default:Noneargument path:default_step_config/continue_on_success_ratioOnly in the sliced OP case. Continue the workflow if a certain ratio of the sliced jobs are successful.
- parallelism:
- type:
int|NoneType, optional, default:Noneargument path:default_step_config/parallelismThe parallelism for the step
- executor:
- type:
dict|NoneType, optional, default:Noneargument path:default_step_config/executorThe executor of the step.
Depending on the value of type, different sub args are accepted.
- type:
-
The type of the executor.
When type is set to
dispatcher:
- parallelism:
- type:
int|NoneType, optional, default:Noneargument path:parallelismThe parallelism for the workflow. Accept an int that stands for the maximum number of running pods for the workflow. None for default
- bohrium_config:
- type:
dict|NoneType, optional, default:Noneargument path:bohrium_configConfigurations for the Bohrium platform.
- username:
- type:
strargument path:bohrium_config/usernameThe username of the Bohrium platform
- password:
- type:
str, optionalargument path:bohrium_config/passwordThe password of the Bohrium platform
- project_id:
- type:
intargument path:bohrium_config/project_idThe project ID of the Bohrium platform
- ticket:
- type:
str, optionalargument path:bohrium_config/ticket
- host:
- type:
str, optional, default:https://workflows.deepmodeling.comargument path:bohrium_config/hostThe host name of the Bohrium platform. Will overwrite dflow_config[‘host’]
- k8s_api_server:
- type:
str, optional, default:https://workflows.deepmodeling.comargument path:bohrium_config/k8s_api_serverThe k8s server of the Bohrium platform. Will overwrite dflow_config[‘k8s_api_server’]
- repo_key:
- type:
str, optional, default:oss-bohriumargument path:bohrium_config/repo_keyThe repo key of the Bohrium platform. Will overwrite dflow_s3_config[‘repo_key’]
- storage_client:
- type:
str, optional, default:dflow.plugins.bohrium.TiefblueClientargument path:bohrium_config/storage_clientThe storage client of the Bohrium platform. Will overwrite dflow_s3_config[‘storage_client’]
- step_configs:
- type:
dict, optional, default:{}argument path:step_configsConfigurations for executing dflow steps
- run_train_config:
- type:
dict, optional, default:{'template_config': {'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1', 'timeout': None, 'retry_on_transient_error': None, 'timeout_as_transient_error': False, 'envs': None}, 'continue_on_failed': False, 'continue_on_num_success': None, 'continue_on_success_ratio': None, 'parallelism': None, 'executor': None}argument path:step_configs/run_train_configConfiguration for run train
- template_config:
- type:
dict, optional, default:{'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1'}argument path:step_configs/run_train_config/template_configThe configs passed to the PythonOPTemplate.
- image:
- type:
str, optional, default:registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1argument path:step_configs/run_train_config/template_config/imageThe image to run the step.
- timeout:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_train_config/template_config/timeoutThe time limit of the OP. Unit is second.
- retry_on_transient_error:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_train_config/template_config/retry_on_transient_errorThe number of retry times if a TransientError is raised.
- timeout_as_transient_error:
- type:
bool, optional, default:Falseargument path:step_configs/run_train_config/template_config/timeout_as_transient_errorTreat the timeout as TransientError.
- envs:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/run_train_config/template_config/envsThe environmental variables.
- template_slice_config:
- type:
dict, optionalargument path:step_configs/run_train_config/template_slice_configThe configs passed to the Slices.
- group_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_train_config/template_slice_config/group_sizeThe number of tasks running on a single node. It is efficient for a large number of short tasks.
- pool_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_train_config/template_slice_config/pool_sizeThe number of tasks running at the same time on one node.
- continue_on_failed:
- type:
bool, optional, default:Falseargument path:step_configs/run_train_config/continue_on_failedIf continue the the step is failed (FatalError, TransientError, A certain number of retrial is reached…).
- continue_on_num_success:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_train_config/continue_on_num_successOnly in the sliced OP case. Continue the workflow if a certain number of the sliced jobs are successful.
- continue_on_success_ratio:
- type:
float|NoneType, optional, default:Noneargument path:step_configs/run_train_config/continue_on_success_ratioOnly in the sliced OP case. Continue the workflow if a certain ratio of the sliced jobs are successful.
- parallelism:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_train_config/parallelismThe parallelism for the step
- executor:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/run_train_config/executorThe executor of the step.
Depending on the value of type, different sub args are accepted.
- type:
- type:
str(flag key)argument path:step_configs/run_train_config/executor/typepossible choices:dispatcherThe type of the executor.
When type is set to
dispatcher:
- prep_explore_config:
- type:
dict, optional, default:{'template_config': {'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1', 'timeout': None, 'retry_on_transient_error': None, 'timeout_as_transient_error': False, 'envs': None}, 'continue_on_failed': False, 'continue_on_num_success': None, 'continue_on_success_ratio': None, 'parallelism': None, 'executor': None}argument path:step_configs/prep_explore_configConfiguration for prepare exploration
- template_config:
- type:
dict, optional, default:{'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1'}argument path:step_configs/prep_explore_config/template_configThe configs passed to the PythonOPTemplate.
- image:
- type:
str, optional, default:registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1argument path:step_configs/prep_explore_config/template_config/imageThe image to run the step.
- timeout:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/prep_explore_config/template_config/timeoutThe time limit of the OP. Unit is second.
- retry_on_transient_error:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/prep_explore_config/template_config/retry_on_transient_errorThe number of retry times if a TransientError is raised.
- timeout_as_transient_error:
- type:
bool, optional, default:Falseargument path:step_configs/prep_explore_config/template_config/timeout_as_transient_errorTreat the timeout as TransientError.
- envs:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/prep_explore_config/template_config/envsThe environmental variables.
- template_slice_config:
- type:
dict, optionalargument path:step_configs/prep_explore_config/template_slice_configThe configs passed to the Slices.
- group_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/prep_explore_config/template_slice_config/group_sizeThe number of tasks running on a single node. It is efficient for a large number of short tasks.
- pool_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/prep_explore_config/template_slice_config/pool_sizeThe number of tasks running at the same time on one node.
- continue_on_failed:
- type:
bool, optional, default:Falseargument path:step_configs/prep_explore_config/continue_on_failedIf continue the the step is failed (FatalError, TransientError, A certain number of retrial is reached…).
- continue_on_num_success:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/prep_explore_config/continue_on_num_successOnly in the sliced OP case. Continue the workflow if a certain number of the sliced jobs are successful.
- continue_on_success_ratio:
- type:
float|NoneType, optional, default:Noneargument path:step_configs/prep_explore_config/continue_on_success_ratioOnly in the sliced OP case. Continue the workflow if a certain ratio of the sliced jobs are successful.
- parallelism:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/prep_explore_config/parallelismThe parallelism for the step
- executor:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/prep_explore_config/executorThe executor of the step.
Depending on the value of type, different sub args are accepted.
- type:
- type:
str(flag key)argument path:step_configs/prep_explore_config/executor/typepossible choices:dispatcherThe type of the executor.
When type is set to
dispatcher:
- run_explore_config:
- type:
dict, optional, default:{'template_config': {'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1', 'timeout': None, 'retry_on_transient_error': None, 'timeout_as_transient_error': False, 'envs': None}, 'continue_on_failed': False, 'continue_on_num_success': None, 'continue_on_success_ratio': None, 'parallelism': None, 'executor': None}argument path:step_configs/run_explore_configConfiguration for run exploration
- template_config:
- type:
dict, optional, default:{'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1'}argument path:step_configs/run_explore_config/template_configThe configs passed to the PythonOPTemplate.
- image:
- type:
str, optional, default:registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1argument path:step_configs/run_explore_config/template_config/imageThe image to run the step.
- timeout:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_explore_config/template_config/timeoutThe time limit of the OP. Unit is second.
- retry_on_transient_error:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_explore_config/template_config/retry_on_transient_errorThe number of retry times if a TransientError is raised.
- timeout_as_transient_error:
- type:
bool, optional, default:Falseargument path:step_configs/run_explore_config/template_config/timeout_as_transient_errorTreat the timeout as TransientError.
- envs:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/run_explore_config/template_config/envsThe environmental variables.
- template_slice_config:
- type:
dict, optionalargument path:step_configs/run_explore_config/template_slice_configThe configs passed to the Slices.
- group_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_explore_config/template_slice_config/group_sizeThe number of tasks running on a single node. It is efficient for a large number of short tasks.
- pool_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_explore_config/template_slice_config/pool_sizeThe number of tasks running at the same time on one node.
- continue_on_failed:
- type:
bool, optional, default:Falseargument path:step_configs/run_explore_config/continue_on_failedIf continue the the step is failed (FatalError, TransientError, A certain number of retrial is reached…).
- continue_on_num_success:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_explore_config/continue_on_num_successOnly in the sliced OP case. Continue the workflow if a certain number of the sliced jobs are successful.
- continue_on_success_ratio:
- type:
float|NoneType, optional, default:Noneargument path:step_configs/run_explore_config/continue_on_success_ratioOnly in the sliced OP case. Continue the workflow if a certain ratio of the sliced jobs are successful.
- parallelism:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_explore_config/parallelismThe parallelism for the step
- executor:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/run_explore_config/executorThe executor of the step.
Depending on the value of type, different sub args are accepted.
- type:
- type:
str(flag key)argument path:step_configs/run_explore_config/executor/typepossible choices:dispatcherThe type of the executor.
When type is set to
dispatcher:
- prep_fp_config:
- type:
dict, optional, default:{'template_config': {'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1', 'timeout': None, 'retry_on_transient_error': None, 'timeout_as_transient_error': False, 'envs': None}, 'continue_on_failed': False, 'continue_on_num_success': None, 'continue_on_success_ratio': None, 'parallelism': None, 'executor': None}argument path:step_configs/prep_fp_configConfiguration for prepare fp
- template_config:
- type:
dict, optional, default:{'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1'}argument path:step_configs/prep_fp_config/template_configThe configs passed to the PythonOPTemplate.
- image:
- type:
str, optional, default:registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1argument path:step_configs/prep_fp_config/template_config/imageThe image to run the step.
- timeout:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/prep_fp_config/template_config/timeoutThe time limit of the OP. Unit is second.
- retry_on_transient_error:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/prep_fp_config/template_config/retry_on_transient_errorThe number of retry times if a TransientError is raised.
- timeout_as_transient_error:
- type:
bool, optional, default:Falseargument path:step_configs/prep_fp_config/template_config/timeout_as_transient_errorTreat the timeout as TransientError.
- envs:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/prep_fp_config/template_config/envsThe environmental variables.
- template_slice_config:
- type:
dict, optionalargument path:step_configs/prep_fp_config/template_slice_configThe configs passed to the Slices.
- group_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/prep_fp_config/template_slice_config/group_sizeThe number of tasks running on a single node. It is efficient for a large number of short tasks.
- pool_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/prep_fp_config/template_slice_config/pool_sizeThe number of tasks running at the same time on one node.
- continue_on_failed:
- type:
bool, optional, default:Falseargument path:step_configs/prep_fp_config/continue_on_failedIf continue the the step is failed (FatalError, TransientError, A certain number of retrial is reached…).
- continue_on_num_success:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/prep_fp_config/continue_on_num_successOnly in the sliced OP case. Continue the workflow if a certain number of the sliced jobs are successful.
- continue_on_success_ratio:
- type:
float|NoneType, optional, default:Noneargument path:step_configs/prep_fp_config/continue_on_success_ratioOnly in the sliced OP case. Continue the workflow if a certain ratio of the sliced jobs are successful.
- parallelism:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/prep_fp_config/parallelismThe parallelism for the step
- executor:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/prep_fp_config/executorThe executor of the step.
Depending on the value of type, different sub args are accepted.
- type:
- type:
str(flag key)argument path:step_configs/prep_fp_config/executor/typepossible choices:dispatcherThe type of the executor.
When type is set to
dispatcher:
- run_fp_config:
- type:
dict, optional, default:{'template_config': {'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1', 'timeout': None, 'retry_on_transient_error': None, 'timeout_as_transient_error': False, 'envs': None}, 'continue_on_failed': False, 'continue_on_num_success': None, 'continue_on_success_ratio': None, 'parallelism': None, 'executor': None}argument path:step_configs/run_fp_configConfiguration for run fp
- template_config:
- type:
dict, optional, default:{'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1'}argument path:step_configs/run_fp_config/template_configThe configs passed to the PythonOPTemplate.
- image:
- type:
str, optional, default:registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1argument path:step_configs/run_fp_config/template_config/imageThe image to run the step.
- timeout:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_fp_config/template_config/timeoutThe time limit of the OP. Unit is second.
- retry_on_transient_error:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_fp_config/template_config/retry_on_transient_errorThe number of retry times if a TransientError is raised.
- timeout_as_transient_error:
- type:
bool, optional, default:Falseargument path:step_configs/run_fp_config/template_config/timeout_as_transient_errorTreat the timeout as TransientError.
- envs:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/run_fp_config/template_config/envsThe environmental variables.
- template_slice_config:
- type:
dict, optionalargument path:step_configs/run_fp_config/template_slice_configThe configs passed to the Slices.
- group_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_fp_config/template_slice_config/group_sizeThe number of tasks running on a single node. It is efficient for a large number of short tasks.
- pool_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_fp_config/template_slice_config/pool_sizeThe number of tasks running at the same time on one node.
- continue_on_failed:
- type:
bool, optional, default:Falseargument path:step_configs/run_fp_config/continue_on_failedIf continue the the step is failed (FatalError, TransientError, A certain number of retrial is reached…).
- continue_on_num_success:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_fp_config/continue_on_num_successOnly in the sliced OP case. Continue the workflow if a certain number of the sliced jobs are successful.
- continue_on_success_ratio:
- type:
float|NoneType, optional, default:Noneargument path:step_configs/run_fp_config/continue_on_success_ratioOnly in the sliced OP case. Continue the workflow if a certain ratio of the sliced jobs are successful.
- parallelism:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/run_fp_config/parallelismThe parallelism for the step
- executor:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/run_fp_config/executorThe executor of the step.
Depending on the value of type, different sub args are accepted.
- type:
- type:
str(flag key)argument path:step_configs/run_fp_config/executor/typepossible choices:dispatcherThe type of the executor.
When type is set to
dispatcher:
- select_confs_config:
- type:
dict, optional, default:{'template_config': {'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1', 'timeout': None, 'retry_on_transient_error': None, 'timeout_as_transient_error': False, 'envs': None}, 'continue_on_failed': False, 'continue_on_num_success': None, 'continue_on_success_ratio': None, 'parallelism': None, 'executor': None}argument path:step_configs/select_confs_configConfiguration for the select confs
- template_config:
- type:
dict, optional, default:{'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1'}argument path:step_configs/select_confs_config/template_configThe configs passed to the PythonOPTemplate.
- image:
- type:
str, optional, default:registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1argument path:step_configs/select_confs_config/template_config/imageThe image to run the step.
- timeout:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/select_confs_config/template_config/timeoutThe time limit of the OP. Unit is second.
- retry_on_transient_error:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/select_confs_config/template_config/retry_on_transient_errorThe number of retry times if a TransientError is raised.
- timeout_as_transient_error:
- type:
bool, optional, default:Falseargument path:step_configs/select_confs_config/template_config/timeout_as_transient_errorTreat the timeout as TransientError.
- envs:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/select_confs_config/template_config/envsThe environmental variables.
- template_slice_config:
- type:
dict, optionalargument path:step_configs/select_confs_config/template_slice_configThe configs passed to the Slices.
- group_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/select_confs_config/template_slice_config/group_sizeThe number of tasks running on a single node. It is efficient for a large number of short tasks.
- pool_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/select_confs_config/template_slice_config/pool_sizeThe number of tasks running at the same time on one node.
- continue_on_failed:
- type:
bool, optional, default:Falseargument path:step_configs/select_confs_config/continue_on_failedIf continue the the step is failed (FatalError, TransientError, A certain number of retrial is reached…).
- continue_on_num_success:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/select_confs_config/continue_on_num_successOnly in the sliced OP case. Continue the workflow if a certain number of the sliced jobs are successful.
- continue_on_success_ratio:
- type:
float|NoneType, optional, default:Noneargument path:step_configs/select_confs_config/continue_on_success_ratioOnly in the sliced OP case. Continue the workflow if a certain ratio of the sliced jobs are successful.
- parallelism:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/select_confs_config/parallelismThe parallelism for the step
- executor:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/select_confs_config/executorThe executor of the step.
Depending on the value of type, different sub args are accepted.
- type:
- type:
str(flag key)argument path:step_configs/select_confs_config/executor/typepossible choices:dispatcherThe type of the executor.
When type is set to
dispatcher:
- collect_data_config:
- type:
dict, optional, default:{'template_config': {'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1', 'timeout': None, 'retry_on_transient_error': None, 'timeout_as_transient_error': False, 'envs': None}, 'continue_on_failed': False, 'continue_on_num_success': None, 'continue_on_success_ratio': None, 'parallelism': None, 'executor': None}argument path:step_configs/collect_data_configConfiguration for the collect data
- template_config:
- type:
dict, optional, default:{'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1'}argument path:step_configs/collect_data_config/template_configThe configs passed to the PythonOPTemplate.
- image:
- type:
str, optional, default:registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1argument path:step_configs/collect_data_config/template_config/imageThe image to run the step.
- timeout:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/collect_data_config/template_config/timeoutThe time limit of the OP. Unit is second.
- retry_on_transient_error:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/collect_data_config/template_config/retry_on_transient_errorThe number of retry times if a TransientError is raised.
- timeout_as_transient_error:
- type:
bool, optional, default:Falseargument path:step_configs/collect_data_config/template_config/timeout_as_transient_errorTreat the timeout as TransientError.
- envs:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/collect_data_config/template_config/envsThe environmental variables.
- template_slice_config:
- type:
dict, optionalargument path:step_configs/collect_data_config/template_slice_configThe configs passed to the Slices.
- group_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/collect_data_config/template_slice_config/group_sizeThe number of tasks running on a single node. It is efficient for a large number of short tasks.
- pool_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/collect_data_config/template_slice_config/pool_sizeThe number of tasks running at the same time on one node.
- continue_on_failed:
- type:
bool, optional, default:Falseargument path:step_configs/collect_data_config/continue_on_failedIf continue the the step is failed (FatalError, TransientError, A certain number of retrial is reached…).
- continue_on_num_success:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/collect_data_config/continue_on_num_successOnly in the sliced OP case. Continue the workflow if a certain number of the sliced jobs are successful.
- continue_on_success_ratio:
- type:
float|NoneType, optional, default:Noneargument path:step_configs/collect_data_config/continue_on_success_ratioOnly in the sliced OP case. Continue the workflow if a certain ratio of the sliced jobs are successful.
- parallelism:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/collect_data_config/parallelismThe parallelism for the step
- executor:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/collect_data_config/executorThe executor of the step.
Depending on the value of type, different sub args are accepted.
- type:
- type:
str(flag key)argument path:step_configs/collect_data_config/executor/typepossible choices:dispatcherThe type of the executor.
When type is set to
dispatcher:
- evaluate_config:
- type:
dict, optional, default:{'template_config': {'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1', 'timeout': None, 'retry_on_transient_error': None, 'timeout_as_transient_error': False, 'envs': None}, 'continue_on_failed': False, 'continue_on_num_success': None, 'continue_on_success_ratio': None, 'parallelism': None, 'executor': None}argument path:step_configs/evaluate_configConfiguration for model evaluation
- template_config:
- type:
dict, optional, default:{'image': 'registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1'}argument path:step_configs/evaluate_config/template_configThe configs passed to the PythonOPTemplate.
- image:
- type:
str, optional, default:registry.dp.tech/dptech/deepmd-kit:v3.0.0a1-2024Q1argument path:step_configs/evaluate_config/template_config/imageThe image to run the step.
- timeout:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/evaluate_config/template_config/timeoutThe time limit of the OP. Unit is second.
- retry_on_transient_error:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/evaluate_config/template_config/retry_on_transient_errorThe number of retry times if a TransientError is raised.
- timeout_as_transient_error:
- type:
bool, optional, default:Falseargument path:step_configs/evaluate_config/template_config/timeout_as_transient_errorTreat the timeout as TransientError.
- envs:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/evaluate_config/template_config/envsThe environmental variables.
- template_slice_config:
- type:
dict, optionalargument path:step_configs/evaluate_config/template_slice_configThe configs passed to the Slices.
- group_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/evaluate_config/template_slice_config/group_sizeThe number of tasks running on a single node. It is efficient for a large number of short tasks.
- pool_size:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/evaluate_config/template_slice_config/pool_sizeThe number of tasks running at the same time on one node.
- continue_on_failed:
- type:
bool, optional, default:Falseargument path:step_configs/evaluate_config/continue_on_failedIf continue the the step is failed (FatalError, TransientError, A certain number of retrial is reached…).
- continue_on_num_success:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/evaluate_config/continue_on_num_successOnly in the sliced OP case. Continue the workflow if a certain number of the sliced jobs are successful.
- continue_on_success_ratio:
- type:
float|NoneType, optional, default:Noneargument path:step_configs/evaluate_config/continue_on_success_ratioOnly in the sliced OP case. Continue the workflow if a certain ratio of the sliced jobs are successful.
- parallelism:
- type:
int|NoneType, optional, default:Noneargument path:step_configs/evaluate_config/parallelismThe parallelism for the step
- executor:
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/evaluate_config/executorThe executor of the step.
Depending on the value of type, different sub args are accepted.
- type:
- type:
str(flag key)argument path:step_configs/evaluate_config/executor/typepossible choices:dispatcherThe type of the executor.
When type is set to
dispatcher:
- upload_python_packages:
- type:
NoneType|str|typing.List[str], optional, default:None, alias: upload_python_packageargument path:upload_python_packagesUpload python package, for debug purpose
Task definition
- type:
- type:
strargument path:typeTask type, finetune or dist
- max_iter:
- type:
int, optional, default:1argument path:max_iterMaximum number of iterations
- init_fp:
- type:
bool, optional, default:Falseargument path:init_fpInitialize fine-tuning
- init_train:
- type:
bool, optional, default:Falseargument path:init_trainInitialize training
Input definition
- init_confs:
- type:
dictargument path:init_confsThe initial configurations for exploration
- prefix:
- type:
NoneType|str, optional, default:Noneargument path:init_confs/prefix
- fmt:
- type:
str, optional, default:extxyzargument path:init_confs/fmtASE compatible format of input structure files
- confs_paths:
- type:
NoneType|str|typing.List[str], optional, default:None, alias: filesargument path:init_confs/confs_paths
- confs_uri:
- type:
NoneType|str|typing.List[str], optional, default:Noneargument path:init_confs/confs_uri
- init_fp_confs:
- type:
dict, optional, default:{}argument path:init_fp_confsThe configurations for initial first-principles calculations
- prefix:
- type:
NoneType|str, optional, default:Noneargument path:init_fp_confs/prefix
- fmt:
- type:
str, optional, default:extxyzargument path:init_fp_confs/fmtASE compatible format of input structure files
- confs_paths:
- type:
NoneType|str|typing.List[str], optional, default:None, alias: filesargument path:init_fp_confs/confs_paths
- confs_uri:
- type:
NoneType|str|typing.List[str], optional, default:Noneargument path:init_fp_confs/confs_uri
- init_data_prefix:
- type:
NoneType|str, optional, default:Noneargument path:init_data_prefixThe prefix of initial data systems
- init_data_sys:
- type:
NoneType|str|typing.List[str], optional, default:Noneargument path:init_data_sysThe inital data systems
- init_data_uri:
- type:
NoneType|str, optional, default:Noneargument path:init_data_uriThe URI of initial data
- base_model_path:
- type:
NoneType|str|typing.List[str], optional, default:None, aliases: teacher_model_path, pretrain_model_path, teacher_models_pathsargument path:base_model_pathPath to the base model.In finetune task, this is the path to the pretrained model.In distillation task, this is the path to the teacher model.
- base_model_uri:
- type:
NoneType|str, optional, default:None, aliases: teacher_model_uri, pretrain_model_uriargument path:base_model_uriURI of the base model.
Exploration
- exploration:
- type:
dict, alias: exploreargument path:explorationThe configuration for exploration
- test_set_config:
- type:
dict, optional, default:{'test_size': 0.1}, alias: test_setargument path:exploration/test_set_configSet the portion of test set. Only available for dist
Depending on the value of type, different sub args are accepted.
- type:
-
The type of the exploration
ase: Exploration by ASEcalypso: Exploration by Calypsocalypso:merge: Exploration by Calypso
When type is set to
ase:Exploration by ASE
- config:
- type:
dict, optional, default:{}argument path:exploration[ase]/configConfiguration of ase exploration
- calculator:
- type:
str, alias: calcargument path:exploration[ase]/config/calculatorThe type of calculator to use, e.g., ‘mace’, ‘mattersim’.
- stages:
- type:
typing.List[typing.List[dict]]argument path:exploration[ase]/stagesExploration stages.The definition of exploration stages of type List[List[ExplorationTaskGroup]. The outer list provides the enumeration of the exploration stages. Then each stage is defined by a list of exploration task groups. Each task group is described in the task group definition
When type is set to
calypso:Exploration by Calypso
- config:
- type:
dictargument path:exploration[calypso]/configConfiguration of ase exploration
- calculator:
- type:
str, alias: calcargument path:exploration[calypso]/config/calculatorThe type of calculator to use, e.g., ‘mace’, ‘mattersim’.
- run_calypso_command:
- type:
str, optional, default:calypso.xargument path:exploration[calypso]/config/run_calypso_commandcommand of running calypso.
- stages:
- type:
typing.List[typing.List[dict]]argument path:exploration[calypso]/stagesExploration stages.The definition of exploration stages of type List[List[ExplorationTaskGroup]. The outer list provides the enumeration of the exploration stages. Then each stage is defined by a list of exploration task groups. Each task group is described in the task group definition
When type is set to
calypso:merge:Exploration by Calypso
- config:
- type:
dictargument path:exploration[calypso:merge]/configConfiguration of ase exploration
- calculator:
- type:
str, alias: calcargument path:exploration[calypso:merge]/config/calculatorThe type of calculator to use, e.g., ‘mace’, ‘mattersim’.
- run_calypso_command:
- type:
str, optional, default:calypso.xargument path:exploration[calypso:merge]/config/run_calypso_commandcommand of running calypso.
- stages:
- type:
typing.List[typing.List[dict]]argument path:exploration[calypso:merge]/stagesExploration stages.The definition of exploration stages of type List[List[ExplorationTaskGroup]. The outer list provides the enumeration of the exploration stages. Then each stage is defined by a list of exploration task groups. Each task group is described in the task group definition
Explore task group definition
ASE task group
- temps:
- type:
listargument path:tempsList of temperatures for MD simulation.
- press:
- type:
NoneType|list, optional, default:Noneargument path:pressList of pressures for MD simulation (optional).
- ens:
- type:
str, optional, default:nptargument path:ensEnsemble type (e.g., ‘npt’, ‘nvt’).
- dt:
- type:
float, optional, default:2argument path:dtMD time step (fs or ps).
- nsteps:
- type:
int, optional, default:1000argument path:nstepsNumber of MD steps.
- trj_freq:
- type:
int, optional, default:100argument path:trj_freqTrajectory output frequency.
- tau_t:
- type:
float, optional, default:100argument path:tau_tThermostat time constant.
- tau_p:
- type:
float, optional, default:500argument path:tau_pBarostat time constant.
- no_pbc:
- type:
bool, optional, default:Falseargument path:no_pbcDisable periodic boundary conditions.
CALYPSO task group
- numb_of_species:
- type:
intargument path:numb_of_speciesNumber of different atomic species in the system.
- name_of_atoms:
- type:
str|listargument path:name_of_atomsList of atomic symbols (e.g., [‘Li’, ‘O’]) or nested lists for random selection.
- numb_of_atoms:
- type:
listargument path:numb_of_atomsList of number of atoms for each species.
- distance_of_ions:
- type:
dict|list|NoneType, optional, default:Noneargument path:distance_of_ionsDistance matrix between ions or dict of covalent radii adjustments. If None, uses default covalent radii.
- atomic_number:
- type:
NoneType|list, optional, default:Noneargument path:atomic_numberList of atomic numbers for each species. Auto-generated if None.
- pop_size:
- type:
int, optional, default:30argument path:pop_sizePopulation size for CALYPSO genetic algorithm.
- max_step:
- type:
int, optional, default:5argument path:max_stepMaximum number of CALYPSO evolution steps.
- system_name:
- type:
str, optional, default:CALYPSOargument path:system_nameName of the system for CALYPSO.
- numb_of_formula:
- type:
list, optional, default:[1, 1]argument path:numb_of_formulaNumber of formula units range [min, max].
- pressure:
- type:
float, optional, default:0.0argument path:pressureExternal pressure for ASE optimization (GPa).
- fmax:
- type:
float, optional, default:0.01argument path:fmaxMaximum force criterion for structure optimization (eV/Å).
- volume:
- type:
float, optional, default:0argument path:volumeVolume constraint for structure generation. 0 means no constraint.
- ialgo:
- type:
int, optional, default:2argument path:ialgoCALYPSO algorithm type (1 or 2).
- pso_ratio:
- type:
float, optional, default:0.6argument path:pso_ratioPSO (Particle Swarm Optimization) ratio.
- icode:
- type:
int, optional, default:15argument path:icodeLocal optimization code (e.g., 1=VASP, 2=SIESTA, 15=ASE).
- numb_of_lbest:
- type:
int, optional, default:4argument path:numb_of_lbestNumber of local best structures to keep.
- numb_of_local_optim:
- type:
int, optional, default:4argument path:numb_of_local_optimNumber of structures to perform local optimization.
- command:
- type:
str, optional, default:sh submit.shargument path:commandCommand to execute for structure optimization.
- max_time:
- type:
int, optional, default:9000argument path:max_timeMaximum time allowed for each optimization (seconds).
- gen_type:
- type:
int, optional, default:1argument path:gen_typeStructure generation type.
- pick_up:
- type:
bool, optional, default:Falseargument path:pick_upWhether to pick up from previous run.
- pick_step:
- type:
int, optional, default:1argument path:pick_stepStep number to pick up from.
- parallel:
- type:
bool, optional, default:Falseargument path:parallelEnable parallel CALYPSO execution.
- split:
- type:
bool, optional, default:Trueargument path:splitSplit CALYPSO tasks.
- spec_space_group:
- type:
list, optional, default:[2, 230]argument path:spec_space_groupSpecified space group range [min, max].
- vsc:
- type:
bool, optional, default:Falseargument path:vscVariable stoichiometry composition.
- ctrl_range:
- type:
list, optional, default:[[1, 10]]argument path:ctrl_rangeControl range for variable composition [[min, max]].
- max_numb_atoms:
- type:
int, optional, default:100argument path:max_numb_atomsMaximum number of atoms in generated structures.
- opt_step:
- type:
int, optional, default:1000argument path:opt_stepMaximum optimization steps for ASE.
- ens:
- type:
str, optional, default:lbfgsargument path:ensOptimizer/ensemble for ASE (e.g., ‘lbfgs’, ‘bfgs’, ‘fire’).
Frame selection
- test_size:
- type:
float, optional, default:0.1argument path:test_sizeThe number of data frames split from training data as test set.If test_size<1, it is the portion of test set. If test_size>=1,it is the number of frames in the test set.
- frame_filter:
- type:
dict|typing.List[dict], optional, default:[]argument path:frame_filterDepending on the value of type, different sub args are accepted.
- type:
- type:
str(flag key)argument path:frame_filter/typethe type of the frame selector
distance: The parameters of atom distance filterbox_skewness: The parameters of box skewness filterbox_length: The parameters of box length filter
When type is set to
distance:The parameters of atom distance filter
- custom_safe_dist:
- type:
dict, optional, default:{}argument path:frame_filter[distance]/custom_safe_distCustom safe distance (in unit of bohr) for each element
- safe_dist_ratio:
- type:
float, optional, default:1.0argument path:frame_filter[distance]/safe_dist_ratioThe ratio multiplied to the safe distance
When type is set to
box_skewness:The parameters of box skewness filter
- theta:
- type:
float, optional, default:60.0argument path:frame_filter[box_skewness]/thetaThe threshold for angles between the edges of the cell. If all angles are larger than this value the check is passed
When type is set to
box_length:The parameters of box length filter
- length_ratio:
- type:
float, optional, default:5.0argument path:frame_filter[box_length]/length_ratioThe threshold for the length ratio between the edges of the cell. If all length ratios are smaller than this value the check is passed
- h_filter:
- type:
dict|NoneType, optional, default:Noneargument path:h_filterSelect configurations based on entropy contribution
- k:
- type:
int, optional, default:32argument path:h_filter/kNumber of nearest neighbors to consider
- cutoff:
- type:
float, optional, default:5.0argument path:h_filter/cutoffCutoff distance (in unit of angstrom)
- batch_size:
- type:
int, optional, default:1000argument path:h_filter/batch_sizeBatch size for calculating the similarity matrix
- h:
- type:
float, optional, default:0.015argument path:h_filter/hBandwidth of the Gaussian kernel (in unit of angstrom).It controls the level of ‘similarity’ between two configurations
- chunk_size:
- type:
int, optional, default:10argument path:h_filter/chunk_sizeThe chunk size of adding new configurations.
Labeling
- fp:
- type:
dict, optionalargument path:fpThe configuration for FP
Depending on the value of type, different sub args are accepted.
- type:
-
Tpyes of first-principles calculators
When type is set to
vasp:- inputs_config:
- type:
dictargument path:fp[vasp]/inputs_configConfiguration for preparing vasp inputs
- incar:
- type:
strargument path:fp[vasp]/inputs_config/incarThe path to the template incar file
- pp_files:
- type:
dictargument path:fp[vasp]/inputs_config/pp_filesThe pseudopotential files set by a dict, e.g. {“Al” : “path/to/the/al/pp/file”, “Mg” : “path/to/the/mg/pp/file”}
- kspacing:
- type:
floatargument path:fp[vasp]/inputs_config/kspacingThe spacing of k-point sampling. ksapcing will overwrite the incar template
- kgamma:
- type:
bool, optional, default:Trueargument path:fp[vasp]/inputs_config/kgammaIf the k-mesh includes the gamma point. kgamma will overwrite the incar template
- run_config:
- type:
dictargument path:fp[vasp]/run_configConfiguration for running vasp tasks
- command:
- type:
str, optional, default:vaspargument path:fp[vasp]/run_config/commandThe command of VASP
- out:
- type:
str, optional, default:structures.extxyzargument path:fp[vasp]/run_config/outThe output dir name of labeled data. In deepmd/npy format provided by dpdata.
- log:
- type:
str, optional, default:fp.logargument path:fp[vasp]/run_config/logThe log file name of VASP
- extra_output_files:
- type:
typing.List, optional, default:[]argument path:fp[vasp]/extra_output_filesExtra output file names, support wildcards
When type is set to
ase:- inputs_config:
- type:
dictargument path:fp[ase]/inputs_configConfiguration for preparing vasp inputs
- run_config:
- type:
dictargument path:fp[ase]/run_configConfiguration for running vasp tasks
- model_style:
- type:
str, optional, default:dp, aliases: style, modelargument path:fp[ase]/run_config/model_styleDistillation model style, e.g., ‘mace’, ‘mattersim’.
- model_args:
- type:
typing.Dict, optional, default:{}argument path:fp[ase]/run_config/model_argsModel arguments, e.g., {‘device’:’cuda’}, etc.
- extra_output_files:
- type:
typing.List, optional, default:[]argument path:fp[ase]/extra_output_filesExtra output file names, support wildcards
When type is set to
foo:- inputs_config:
- type:
dictargument path:fp[foo]/inputs_configConfiguration for preparing vasp inputs
- run_config:
- type:
dictargument path:fp[foo]/run_configConfiguration for running vasp tasks
- command:
- type:
str, optional, default:fooargument path:fp[foo]/run_config/commandCommand to run the foo task.
- extra_output_files:
- type:
typing.List, optional, default:[]argument path:fp[foo]/extra_output_filesExtra output file names, support wildcards
Model training
- train:
- type:
dictargument path:trainThe configuration for training
Depending on the value of type, different sub args are accepted.
- type:
-
the type of the training model
When type is set to
dp:- config:
- type:
dict, optional, default:{'command': 'dp', 'impl': 'tensorflow', 'finetune_args': '', 'multitask': False, 'head': None, 'train_args': '', 'finetune_mode': False, 'mixed_type': False}argument path:train[dp]/configConfiguration of training
- command:
- type:
str, optional, default:dpargument path:train[dp]/config/commandThe command for DP, ‘dp’ for default
- impl:
- type:
str, optional, default:tensorflow, alias: backendargument path:train[dp]/config/implThe implementation/backend of DP. It can be ‘tensorflow’ or ‘pytorch’. ‘tensorflow’ for default.
- finetune_args:
- type:
str, optional, default: (empty string)argument path:train[dp]/config/finetune_argsExtra arguments for finetuning
- multitask:
- type:
bool, optional, default:Falseargument path:train[dp]/config/multitaskDo multitask training
- head:
- type:
NoneType|str, optional, default:Noneargument path:train[dp]/config/headHead to use in the multitask training
- train_args:
- type:
str, optional, default: (empty string)argument path:train[dp]/config/train_argsExtra arguments for dp train
- finetune_mode:
- type:
bool, optional, default:Falseargument path:train[dp]/config/finetune_modeWhether to run in finetune mode
- mixed_type:
- type:
bool, optional, default:Falseargument path:train[dp]/config/mixed_typeWhether to use mixed type system for training
- template_script:
- type:
dict|str|typing.List[str], optional, default:{}argument path:train[dp]/template_scriptFile names of the template training script. It can be a List[str], the length of which is the same as numb_models. Each template script in the list is used to train a model. Can be a str, the models share the same template training script.
- optional_files:
- type:
NoneType|list, optional, default:Noneargument path:train[dp]/optional_filesOptional files for training
When type is set to
mattersim:- config:
- type:
dict, optional, default:{'run_name': 'train', 'save_path': './', 'save_checkpoint': True, 'ckpt_interval': 10, 'device': 'cuda', 'cutoff': 5.0, 'threebody_cutoff': 4.0, 'epochs': 10, 'batch_size': 8, 'lr': 0.0002, 'step_size': 10, 'include_forces': True, 'include_stresses': False, 'force_loss_ratio': 1.0, 'stress_loss_ratio': 0.1, 'early_stop_patience': 10, 'seed': 42, 're_normalize': False, 'scale_key': 'per_species_forces_rms', 'shift_key': 'per_species_energy_mean_linear_reg', 'init_scale': None, 'init_shift': None, 'trainable_scale': False, 'trainable_shift': False}argument path:train[mattersim]/configConfiguration of training
- run_name:
- type:
str, optional, default:trainargument path:train[mattersim]/config/run_nameName of the run.
- save_path:
- type:
str, optional, default:./argument path:train[mattersim]/config/save_pathPath to save the model.
- save_checkpoint:
- type:
bool, optional, default:Trueargument path:train[mattersim]/config/save_checkpointSave checkpoint during training.
- ckpt_interval:
- type:
int, optional, default:10argument path:train[mattersim]/config/ckpt_intervalSave checkpoint every ckpt_interval epochs.
- device:
- type:
str, optional, default:cudaargument path:train[mattersim]/config/deviceDevice to use for training (e.g., ‘cuda’ or ‘cpu’).
- cutoff:
- type:
float, optional, default:5.0argument path:train[mattersim]/config/cutoffCutoff radius for two-body interactions.
- threebody_cutoff:
- type:
float, optional, default:4.0argument path:train[mattersim]/config/threebody_cutoffCutoff radius for three-body interactions.
- epochs:
- type:
int, optional, default:10argument path:train[mattersim]/config/epochsNumber of training epochs.
- batch_size:
- type:
int, optional, default:8argument path:train[mattersim]/config/batch_sizeBatch size for training.
- lr:
- type:
float, optional, default:0.0002argument path:train[mattersim]/config/lrLearning rate.
- step_size:
- type:
int, optional, default:10argument path:train[mattersim]/config/step_sizeStep epoch for learning rate scheduler.
- include_forces:
- type:
bool, optional, default:Trueargument path:train[mattersim]/config/include_forcesInclude forces in training.
- include_stresses:
- type:
bool, optional, default:Falseargument path:train[mattersim]/config/include_stressesInclude stresses in training.
- force_loss_ratio:
- type:
float, optional, default:1.0argument path:train[mattersim]/config/force_loss_ratioWeight for force loss.
- stress_loss_ratio:
- type:
float, optional, default:0.1argument path:train[mattersim]/config/stress_loss_ratioWeight for stress loss.
- early_stop_patience:
- type:
int, optional, default:10argument path:train[mattersim]/config/early_stop_patiencePatience for early stopping.
- seed:
- type:
int, optional, default:42argument path:train[mattersim]/config/seedRandom seed for reproducibility.
- re_normalize:
- type:
bool, optional, default:Falseargument path:train[mattersim]/config/re_normalizeRe-normalize energy and forces.
- scale_key:
- type:
str, optional, default:per_species_forces_rmsargument path:train[mattersim]/config/scale_keyKey for scaling forces.
- shift_key:
- type:
str, optional, default:per_species_energy_mean_linear_regargument path:train[mattersim]/config/shift_keyKey for shifting energy.
- init_scale:
- type:
float|NoneType, optional, default:Noneargument path:train[mattersim]/config/init_scaleInitial scale value.
- init_shift:
- type:
float|NoneType, optional, default:Noneargument path:train[mattersim]/config/init_shiftInitial shift value.
- trainable_scale:
- type:
bool, optional, default:Falseargument path:train[mattersim]/config/trainable_scaleAllow scale to be trainable.
- trainable_shift:
- type:
bool, optional, default:Falseargument path:train[mattersim]/config/trainable_shiftAllow shift to be trainable.
- template_script:
- type:
dict|str|typing.List[str], optional, default:{}argument path:train[mattersim]/template_scriptFile names of the template training script. It can be a List[str], the length of which is the same as numb_models. Each template script in the list is used to train a model. Can be a str, the models share the same template training script.
- optional_files:
- type:
NoneType|list, optional, default:Noneargument path:train[mattersim]/optional_filesOptional files for training
Evaluate
- max_sel:
- type:
int, optional, default:50argument path:max_selMaximum number of selected configurations
- model:
- type:
str, optional, default:dpargument path:modelThe model type used in the evaluation. It should be consistent with the model type used in training.
- converge:
- type:
dict, optional, default:{}argument path:convergeThe method of convergence check.
Depending on the value of type, different sub args are accepted.
- type:
- type:
str(flag key)argument path:converge/typethe type of the condidate selection and convergence check method.
force_rmse: Converge by RMSE of atomic forcesforce_rmse_idv: Converge by RMSE of atomic forcesenergy_rmse: Converge by RMSE of energy per atom
When type is set to
force_rmse:Converge by RMSE of atomic forces
- RMSE:
- type:
float, optional, default:0.01argument path:converge[force_rmse]/RMSE
When type is set to
force_rmse_idv:Converge by RMSE of atomic forces
- RMSE:
- type:
float, optional, default:0.01argument path:converge[force_rmse_idv]/RMSE
When type is set to
energy_rmse:Converge by RMSE of energy per atom
- RMSE:
- type:
float, optional, default:0.01argument path:converge[energy_rmse]/RMSE