Arguments of the submit script#
Note
One can load, modify, and export the input file by using our effective web-based tool DP-GUI online or hosted using the command line interface dpgen2 gui. All parameters below can be set in DP-GUI. By clicking “SAVE JSON”, one can download the input file.
- 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': 'dptechnology/dpgen2:latest'}argument path:default_step_config/template_configThe configs passed to the PythonOPTemplate.
- image:#
- type:
str, optional, default:dptechnology/dpgen2:latestargument path:default_step_config/template_config/imageThe image to run the step.
- timeout:#
- type:
NoneType|int, optional, default:Noneargument path:default_step_config/template_config/timeoutThe time limit of the OP. Unit is second.
- retry_on_transient_error:#
- type:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|float, 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:
NoneType|int, optional, default:Noneargument path:default_step_config/parallelismThe parallelism for the step
- 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:
strargument path:bohrium_config/passwordThe password of the Bohrium platform
- project_id:#
- type:
intargument path:bohrium_config/project_idThe project ID of the Bohrium platform
- 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
- prep_train_config:#
- type:
dict, optional, default:{'template_config': {'image': 'dptechnology/dpgen2:latest', '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_train_configConfiguration for prepare train
- template_config:#
- type:
dict, optional, default:{'image': 'dptechnology/dpgen2:latest'}argument path:step_configs/prep_train_config/template_configThe configs passed to the PythonOPTemplate.
- image:#
- type:
str, optional, default:dptechnology/dpgen2:latestargument path:step_configs/prep_train_config/template_config/imageThe image to run the step.
- timeout:#
- type:
NoneType|int, optional, default:Noneargument path:step_configs/prep_train_config/template_config/timeoutThe time limit of the OP. Unit is second.
- retry_on_transient_error:#
- type:
NoneType|int, optional, default:Noneargument path:step_configs/prep_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/prep_train_config/template_config/timeout_as_transient_errorTreat the timeout as TransientError.
- envs:#
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/prep_train_config/template_config/envsThe environmental variables.
- template_slice_config:#
- type:
dict, optionalargument path:step_configs/prep_train_config/template_slice_configThe configs passed to the Slices.
- group_size:#
- type:
NoneType|int, optional, default:Noneargument path:step_configs/prep_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:
NoneType|int, optional, default:Noneargument path:step_configs/prep_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/prep_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:
NoneType|int, optional, default:Noneargument path:step_configs/prep_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:
NoneType|float, optional, default:Noneargument path:step_configs/prep_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:
NoneType|int, optional, default:Noneargument path:step_configs/prep_train_config/parallelismThe parallelism for the step
- executor:#
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/prep_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/prep_train_config/executor/typepossible choices:dispatcherThe type of the executor.
When type is set to
dispatcher:
- run_train_config:#
- type:
dict, optional, default:{'template_config': {'image': 'dptechnology/dpgen2:latest', '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': 'dptechnology/dpgen2:latest'}argument path:step_configs/run_train_config/template_configThe configs passed to the PythonOPTemplate.
- image:#
- type:
str, optional, default:dptechnology/dpgen2:latestargument path:step_configs/run_train_config/template_config/imageThe image to run the step.
- timeout:#
- type:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|float, 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:
NoneType|int, 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': 'dptechnology/dpgen2:latest', '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': 'dptechnology/dpgen2:latest'}argument path:step_configs/prep_explore_config/template_configThe configs passed to the PythonOPTemplate.
- image:#
- type:
str, optional, default:dptechnology/dpgen2:latestargument path:step_configs/prep_explore_config/template_config/imageThe image to run the step.
- timeout:#
- type:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|float, 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:
NoneType|int, 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': 'dptechnology/dpgen2:latest', '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': 'dptechnology/dpgen2:latest'}argument path:step_configs/run_explore_config/template_configThe configs passed to the PythonOPTemplate.
- image:#
- type:
str, optional, default:dptechnology/dpgen2:latestargument path:step_configs/run_explore_config/template_config/imageThe image to run the step.
- timeout:#
- type:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|float, 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:
NoneType|int, 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': 'dptechnology/dpgen2:latest', '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': 'dptechnology/dpgen2:latest'}argument path:step_configs/prep_fp_config/template_configThe configs passed to the PythonOPTemplate.
- image:#
- type:
str, optional, default:dptechnology/dpgen2:latestargument path:step_configs/prep_fp_config/template_config/imageThe image to run the step.
- timeout:#
- type:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|float, 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:
NoneType|int, 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': 'dptechnology/dpgen2:latest', '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': 'dptechnology/dpgen2:latest'}argument path:step_configs/run_fp_config/template_configThe configs passed to the PythonOPTemplate.
- image:#
- type:
str, optional, default:dptechnology/dpgen2:latestargument path:step_configs/run_fp_config/template_config/imageThe image to run the step.
- timeout:#
- type:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|float, 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:
NoneType|int, 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': 'dptechnology/dpgen2:latest', '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': 'dptechnology/dpgen2:latest'}argument path:step_configs/select_confs_config/template_configThe configs passed to the PythonOPTemplate.
- image:#
- type:
str, optional, default:dptechnology/dpgen2:latestargument path:step_configs/select_confs_config/template_config/imageThe image to run the step.
- timeout:#
- type:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|float, 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:
NoneType|int, 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': 'dptechnology/dpgen2:latest', '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': 'dptechnology/dpgen2:latest'}argument path:step_configs/collect_data_config/template_configThe configs passed to the PythonOPTemplate.
- image:#
- type:
str, optional, default:dptechnology/dpgen2:latestargument path:step_configs/collect_data_config/template_config/imageThe image to run the step.
- timeout:#
- type:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|int, 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:
NoneType|float, 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:
NoneType|int, 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:
- cl_step_config:#
- type:
dict, optional, default:{'template_config': {'image': 'dptechnology/dpgen2:latest', '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/cl_step_configConfiguration for the concurrent learning step
- template_config:#
- type:
dict, optional, default:{'image': 'dptechnology/dpgen2:latest'}argument path:step_configs/cl_step_config/template_configThe configs passed to the PythonOPTemplate.
- image:#
- type:
str, optional, default:dptechnology/dpgen2:latestargument path:step_configs/cl_step_config/template_config/imageThe image to run the step.
- timeout:#
- type:
NoneType|int, optional, default:Noneargument path:step_configs/cl_step_config/template_config/timeoutThe time limit of the OP. Unit is second.
- retry_on_transient_error:#
- type:
NoneType|int, optional, default:Noneargument path:step_configs/cl_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:step_configs/cl_step_config/template_config/timeout_as_transient_errorTreat the timeout as TransientError.
- envs:#
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/cl_step_config/template_config/envsThe environmental variables.
- template_slice_config:#
- type:
dict, optionalargument path:step_configs/cl_step_config/template_slice_configThe configs passed to the Slices.
- group_size:#
- type:
NoneType|int, optional, default:Noneargument path:step_configs/cl_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:
NoneType|int, optional, default:Noneargument path:step_configs/cl_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:step_configs/cl_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:
NoneType|int, optional, default:Noneargument path:step_configs/cl_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:
NoneType|float, optional, default:Noneargument path:step_configs/cl_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:
NoneType|int, optional, default:Noneargument path:step_configs/cl_step_config/parallelismThe parallelism for the step
- executor:#
- type:
dict|NoneType, optional, default:Noneargument path:step_configs/cl_step_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/cl_step_config/executor/typepossible choices:dispatcherThe type of the executor.
When type is set to
dispatcher:
- upload_python_packages:#
- type:
str|typing.List[str]|NoneType, optional, default:None, alias: upload_python_packageargument path:upload_python_packagesUpload python package, for debug purpose
- inputs:#
- type:
dictargument path:inputsThe input parameter and artifacts for dpgen2
- type_map:#
- type:
typing.List[str]argument path:inputs/type_mapThe type map. e.g. [“Al”, “Mg”]. Al and Mg will have type 0 and 1, respectively.
- mass_map:#
- type:
typing.List[float]argument path:inputs/mass_mapThe mass map. e.g. [27., 24.]. Al and Mg will be set with mass 27. and 24. amu, respectively.
- init_data_prefix:#
- type:
str|NoneType, optional, default:Noneargument path:inputs/init_data_prefixThe prefix of initial data systems
- mixed_type:#
- type:
bool, optional, default:Falseargument path:inputs/mixed_typeUse deepmd/npy/mixed format for storing training data.
- do_finetune:#
- type:
bool, optional, default:Falseargument path:inputs/do_finetuneFinetune the pretrained model during the first iteration. If it is set to True, then in the first iteration, the internal flag finetune_mode is set to “finetune”. In this step, we finetune the pretrained model in the train step. After that, in the following iterations, init_model_policy is forced to be “yes”, the flag finetune_mode is set as “no”, which means we use –init-frz-model or –init-model to train based on models from the previous iteration. The “do_finetune” flag is set to False by default, while the internal flag finetune_mode is set to “no”, which means anything related to finetuning will not be done.
- init_data_sys:#
- type:
str|typing.List[str]|NoneType, optional, default:Noneargument path:inputs/init_data_sysThe inital data systems
- init_data_uri:#
- type:
str|NoneType, optional, default:Noneargument path:inputs/init_data_uriThe URI of initial data
- multitask:#
- type:
bool, optional, default:Falseargument path:inputs/multitaskDo multitask training
- head:#
- type:
str|NoneType, optional, default:Noneargument path:inputs/headHead to use in the multitask training
- multi_init_data:#
- type:
dict|NoneType, optional, default:Noneargument path:inputs/multi_init_dataThe inital data for multitask, it should be a dict, whose keys are task names and each value is a dictcontaining fields prefix and sys for initial data of each task
- multi_init_data_uri:#
- type:
str|NoneType, optional, default:Noneargument path:inputs/multi_init_data_uriThe URI of initial data for multitask
- valid_data_prefix:#
- type:
str|NoneType, optional, default:Noneargument path:inputs/valid_data_prefixThe prefix of validation data systems
- valid_data_sys:#
- type:
str|typing.List[str]|NoneType, optional, default:Noneargument path:inputs/valid_data_sysThe validation data systems
- valid_data_uri:#
- type:
str|NoneType, optional, default:Noneargument path:inputs/valid_data_uriThe URI of validation data
- use_ele_temp:#
- type:
int, optional, default:0argument path:inputs/use_ele_tempWhether to use electronic temperature, 0 for no, 1 for frame temperature, and 2 for atomic temperature
- multi_valid_data:#
- type:
dict|NoneType, optional, default:Noneargument path:inputs/multi_valid_dataThe validation data for multitask, it should be a dict, whose keys are task names and each value is a dictcontaining fields prefix and sys for initial data of each task
- multi_valid_data_uri:#
- type:
str|NoneType, optional, default:Noneargument path:inputs/multi_valid_data_uriThe URI of validation data for multitask
- train:#
- type:
dictargument path:trainThe configuration for training
Depending on the value of type, different sub args are accepted.
- type:#
When type is set to
dp:- config:#
- type:
dict, optional, default:{'command': 'dp', 'impl': 'tensorflow', 'init_model_policy': 'no', 'init_model_old_ratio': 0.9, 'init_model_numb_steps': 400000, 'init_model_start_lr': 0.0001, 'init_model_start_pref_e': 0.1, 'init_model_start_pref_f': 100, 'init_model_start_pref_v': 0.0, 'init_model_with_finetune': False, 'finetune_args': '', 'multitask': False, 'head': None, 'train_args': '', 'split_last_iter_valid_ratio': None}argument path:train[dp]/configNumber of models trained for evaluating the model deviation
- 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.
- init_model_policy:#
- type:
str, optional, default:noargument path:train[dp]/config/init_model_policyThe policy of init-model training. It can be
‘no’: No init-model training. Traing from scratch.
‘yes’: Do init-model training.
‘old_data_larger_than:XXX’: Do init-model if the training data size of the previous model is larger than XXX. XXX is an int number.
- init_model_old_ratio:#
- type:
float, optional, default:0.9argument path:train[dp]/config/init_model_old_ratioThe frequency ratio of old data over new data
- init_model_numb_steps:#
- type:
int, optional, default:400000, alias: init_model_stop_batchargument path:train[dp]/config/init_model_numb_stepsThe number of training steps when init-model
- init_model_start_lr:#
- type:
float, optional, default:0.0001argument path:train[dp]/config/init_model_start_lrThe start learning rate when init-model
- init_model_start_pref_e:#
- type:
float, optional, default:0.1argument path:train[dp]/config/init_model_start_pref_eThe start energy prefactor in loss when init-model
- init_model_start_pref_f:#
- type:
float, optional, default:100argument path:train[dp]/config/init_model_start_pref_fThe start force prefactor in loss when init-model
- init_model_start_pref_v:#
- type:
float, optional, default:0.0argument path:train[dp]/config/init_model_start_pref_vThe start virial prefactor in loss when init-model
- init_model_with_finetune:#
- type:
bool, optional, default:Falseargument path:train[dp]/config/init_model_with_finetuneUse finetune for init model
- 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:
str|NoneType, 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
- split_last_iter_valid_ratio:#
- type:
NoneType|float, optional, default:Noneargument path:train[dp]/config/split_last_iter_valid_ratioRatio of valid data if split data of last iter
- numb_models:#
- type:
int, optional, default:4argument path:train[dp]/numb_modelsNumber of models trained for evaluating the model deviation
- template_script:#
- type:
str|typing.List[str]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.
- init_models_paths:#
- type:
typing.List[str]|NoneType, optional, default:None, alias: training_iter0_model_pathargument path:train[dp]/init_models_pathsthe paths to initial models
- init_models_uri:#
- type:
str|NoneType, optional, default:Noneargument path:train[dp]/init_models_uriThe URI of initial models
- optional_files:#
- type:
list|NoneType, optional, default:Noneargument path:train[dp]/optional_filesOptional files for training
When type is set to
dp-dist:- config:#
- type:
dict, optional, default:{'command': 'dp', 'impl': 'tensorflow', 'init_model_policy': 'no', 'init_model_old_ratio': 0.9, 'init_model_numb_steps': 400000, 'init_model_start_lr': 0.0001, 'init_model_start_pref_e': 0.1, 'init_model_start_pref_f': 100, 'init_model_start_pref_v': 0.0, 'init_model_with_finetune': False, 'finetune_args': '', 'multitask': False, 'head': None, 'train_args': '', 'split_last_iter_valid_ratio': None}argument path:train[dp-dist]/configConfiguration of training
- command:#
- type:
str, optional, default:dpargument path:train[dp-dist]/config/commandThe command for DP, ‘dp’ for default
- impl:#
- type:
str, optional, default:tensorflow, alias: backendargument path:train[dp-dist]/config/implThe implementation/backend of DP. It can be ‘tensorflow’ or ‘pytorch’. ‘tensorflow’ for default.
- init_model_policy:#
- type:
str, optional, default:noargument path:train[dp-dist]/config/init_model_policyThe policy of init-model training. It can be
‘no’: No init-model training. Traing from scratch.
‘yes’: Do init-model training.
‘old_data_larger_than:XXX’: Do init-model if the training data size of the previous model is larger than XXX. XXX is an int number.
- init_model_old_ratio:#
- type:
float, optional, default:0.9argument path:train[dp-dist]/config/init_model_old_ratioThe frequency ratio of old data over new data
- init_model_numb_steps:#
- type:
int, optional, default:400000, alias: init_model_stop_batchargument path:train[dp-dist]/config/init_model_numb_stepsThe number of training steps when init-model
- init_model_start_lr:#
- type:
float, optional, default:0.0001argument path:train[dp-dist]/config/init_model_start_lrThe start learning rate when init-model
- init_model_start_pref_e:#
- type:
float, optional, default:0.1argument path:train[dp-dist]/config/init_model_start_pref_eThe start energy prefactor in loss when init-model
- init_model_start_pref_f:#
- type:
float, optional, default:100argument path:train[dp-dist]/config/init_model_start_pref_fThe start force prefactor in loss when init-model
- init_model_start_pref_v:#
- type:
float, optional, default:0.0argument path:train[dp-dist]/config/init_model_start_pref_vThe start virial prefactor in loss when init-model
- init_model_with_finetune:#
- type:
bool, optional, default:Falseargument path:train[dp-dist]/config/init_model_with_finetuneUse finetune for init model
- finetune_args:#
- type:
str, optional, default: (empty string)argument path:train[dp-dist]/config/finetune_argsExtra arguments for finetuning
- multitask:#
- type:
bool, optional, default:Falseargument path:train[dp-dist]/config/multitaskDo multitask training
- head:#
- type:
str|NoneType, optional, default:Noneargument path:train[dp-dist]/config/headHead to use in the multitask training
- train_args:#
- type:
str, optional, default: (empty string)argument path:train[dp-dist]/config/train_argsExtra arguments for dp train
- split_last_iter_valid_ratio:#
- type:
NoneType|float, optional, default:Noneargument path:train[dp-dist]/config/split_last_iter_valid_ratioRatio of valid data if split data of last iter
- template_script:#
- type:
str|typing.List[str]argument path:train[dp-dist]/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.
- student_model_path:#
- type:
str, optionalargument path:train[dp-dist]/student_model_pathThe path of student model
- student_model_uri:#
- type:
str|NoneType, optional, default:Noneargument path:train[dp-dist]/student_model_uriThe URI of student model
- optional_files:#
- type:
list|NoneType, optional, default:Noneargument path:train[dp-dist]/optional_filesOptional files for training
- explore:#
- type:
dictargument path:exploreThe configuration for exploration
Depending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:explore/typeThe type of the exploration
lmp: The exploration by LAMMPS simulationscalypso: The exploration by CALYPSO structure predictioncalypso:default: The exploration by CALYPSO structure predictioncalypso:merge: The exploration by CALYPSO structure predictiondiffcsp: The exploration by DiffCSP
When type is set to
lmp:The exploration by LAMMPS simulations
- config:#
- type:
dict, optional, default:{'command': 'lmp', 'teacher_model_path': None, 'shuffle_models': False, 'head': None, 'use_ele_temp': 0, 'model_frozen_head': None, 'use_hdf5': False, 'extra_output_files': []}argument path:explore[lmp]/configConfiguration of lmp exploration
- command:#
- type:
str, optional, default:lmpargument path:explore[lmp]/config/commandThe command of LAMMPS
- teacher_model_path:#
- type:
str|NoneType|BinaryFileInput, optional, default:Noneargument path:explore[lmp]/config/teacher_model_pathThe teacher model in Knowledge Distillation
- shuffle_models:#
- type:
bool, optional, default:Falseargument path:explore[lmp]/config/shuffle_modelsRandomly pick a model from the group of models to drive theexploration MD simulation
- head:#
- type:
str|NoneType, optional, default:Noneargument path:explore[lmp]/config/headSelect a head from multitask
- use_ele_temp:#
- type:
int, optional, default:0argument path:explore[lmp]/config/use_ele_tempWhether to use electronic temperature, 0 for no, 1 for frame temperature, and 2 for atomic temperature
- model_frozen_head:#
- type:
str|NoneType, optional, default:Noneargument path:explore[lmp]/config/model_frozen_headSelect a head from multitask
- use_hdf5:#
- type:
bool, optional, default:Falseargument path:explore[lmp]/config/use_hdf5Use HDF5 to store trajs and model_devis
- extra_output_files:#
- type:
list, optional, default:[]argument path:explore[lmp]/config/extra_output_filesExtra output file names, support wildcards
- max_numb_iter:#
- type:
int, optional, default:10argument path:explore[lmp]/max_numb_iterMaximum number of iterations per stage
- fatal_at_max:#
- type:
bool, optional, default:Trueargument path:explore[lmp]/fatal_at_maxFatal when the number of iteration per stage reaches the max_numb_iter
- output_nopbc:#
- type:
bool, optional, default:Falseargument path:explore[lmp]/output_nopbcRemove pbc of the output configurations
- convergence:#
- type:
dictargument path:explore[lmp]/convergenceThe method of convergence check.
Depending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:explore[lmp]/convergence/typethe type of the condidate selection and convergence check method.
fixed-levels: The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations will be randomly sampled from candidates for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.fixed-levels-max-select: The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations with maximal model deviation in the candidates are sent for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.adaptive-lower: The method of adaptive adjust the lower trust levels. In each step of iterations, a number (set by numb_candi_f or numb_candi_v) or a ratio (set by rate_candi_f or rate_candi_v) of configurations with a model deviation lower than the higher trust level (level_f_hi, level_v_hi) are treated as candidates. The lowest model deviation of the candidates are treated as the lower trust level. If the lower trust level does not change significant (controlled by conv_tolerance) in n_checked_steps, the stage is treated as converged.
When type is set to
fixed-levels:The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations will be randomly sampled from candidates for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.
- level_f_lo:#
- type:
floatargument path:explore[lmp]/convergence[fixed-levels]/level_f_loThe lower trust level of force model deviation
- level_f_hi:#
- type:
floatargument path:explore[lmp]/convergence[fixed-levels]/level_f_hiThe higher trust level of force model deviation
- level_v_lo:#
- type:
NoneType|float, optional, default:Noneargument path:explore[lmp]/convergence[fixed-levels]/level_v_loThe lower trust level of virial model deviation
- level_v_hi:#
- type:
NoneType|float, optional, default:Noneargument path:explore[lmp]/convergence[fixed-levels]/level_v_hiThe higher trust level of virial model deviation
- conv_accuracy:#
- type:
float, optional, default:0.9argument path:explore[lmp]/convergence[fixed-levels]/conv_accuracyIf the ratio of accurate frames is larger than this value, the stage is converged
When type is set to
fixed-levels-max-select:The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations with maximal model deviation in the candidates are sent for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.
- level_f_lo:#
- type:
floatargument path:explore[lmp]/convergence[fixed-levels-max-select]/level_f_loThe lower trust level of force model deviation
- level_f_hi:#
- type:
floatargument path:explore[lmp]/convergence[fixed-levels-max-select]/level_f_hiThe higher trust level of force model deviation
- level_v_lo:#
- type:
NoneType|float, optional, default:Noneargument path:explore[lmp]/convergence[fixed-levels-max-select]/level_v_loThe lower trust level of virial model deviation
- level_v_hi:#
- type:
NoneType|float, optional, default:Noneargument path:explore[lmp]/convergence[fixed-levels-max-select]/level_v_hiThe higher trust level of virial model deviation
- conv_accuracy:#
- type:
float, optional, default:0.9argument path:explore[lmp]/convergence[fixed-levels-max-select]/conv_accuracyIf the ratio of accurate frames is larger than this value, the stage is converged
When type is set to
adaptive-lower:The method of adaptive adjust the lower trust levels. In each step of iterations, a number (set by numb_candi_f or numb_candi_v) or a ratio (set by rate_candi_f or rate_candi_v) of configurations with a model deviation lower than the higher trust level (level_f_hi, level_v_hi) are treated as candidates. The lowest model deviation of the candidates are treated as the lower trust level. If the lower trust level does not change significant (controlled by conv_tolerance) in n_checked_steps, the stage is treated as converged.
- level_f_hi:#
- type:
float, optional, default:0.5argument path:explore[lmp]/convergence[adaptive-lower]/level_f_hiThe higher trust level of force model deviation
- numb_candi_f:#
- type:
int, optional, default:200argument path:explore[lmp]/convergence[adaptive-lower]/numb_candi_fThe number of force frames that has a model deviation lower than level_f_hi treated as candidate.
- rate_candi_f:#
- type:
float, optional, default:0.01argument path:explore[lmp]/convergence[adaptive-lower]/rate_candi_fThe ratio of force frames that has a model deviation lower than level_f_hi treated as candidate.
- level_v_hi:#
- type:
NoneType|float, optional, default:Noneargument path:explore[lmp]/convergence[adaptive-lower]/level_v_hiThe higher trust level of virial model deviation
- numb_candi_v:#
- type:
int, optional, default:0argument path:explore[lmp]/convergence[adaptive-lower]/numb_candi_vThe number of virial frames that has a model deviation lower than level_v_hi treated as candidate.
- rate_candi_v:#
- type:
float, optional, default:0.0argument path:explore[lmp]/convergence[adaptive-lower]/rate_candi_vThe ratio of virial frames that has a model deviation lower than level_v_hi treated as candidate.
- n_checked_steps:#
- type:
int, optional, default:2argument path:explore[lmp]/convergence[adaptive-lower]/n_checked_stepsThe number of steps to check the convergence.
- conv_tolerance:#
- type:
float, optional, default:0.05argument path:explore[lmp]/convergence[adaptive-lower]/conv_toleranceThe convergence tolerance.
- candi_sel_prob:#
- type:
str, optional, default:uniformargument path:explore[lmp]/convergence[adaptive-lower]/candi_sel_probThe method for selecting candidates. It can be ‘uniform’: all candidates are of the same probability. ‘inv_pop_f’ or ‘inv_pop_f:nhist’: the probability is inversely propotional to the population of a histogram between leven_f_lo and level_f_hi. The number of bins in the histogram is set by nhist, which should be an integer. The default is 10.
- configurations:#
- type:
list, alias: configurationargument path:explore[lmp]/configurationsA list of initial configurations.
This argument takes a list with each element containing the following:
Depending on the value of type, different sub args are accepted.
- type:#
the type of the initial configuration generator.
alloy: Generate alloys with a certain lattice or user proided structure, the elements randomly occuping the lattice with user provided probability .file: Generate alloys from user provided file(s). The file(s) are assume to be load by dpdata.
When type is set to
alloy:Generate alloys with a certain lattice or user proided structure, the elements randomly occuping the lattice with user provided probability .
- numb_confs:#
- type:
int, optional, default:1argument path:explore[lmp]/configurations[alloy]/numb_confsThe number of configurations to generate
- lattice:#
- type:
list|tupleargument path:explore[lmp]/configurations[alloy]/latticeThe lattice. Should be a list providing [ “lattice_type”, lattice_const ], or a list providing [ “/path/to/dpdata/system”, “fmt” ]. The two styles are distinguished by the type of the second element. Currently “lattice_type” can be “bcc”, “fcc”, “hcp”, “sc” or “diamond”.
- replicate:#
- type:
list|NoneType, optional, default:Noneargument path:explore[lmp]/configurations[alloy]/replicateThe number of replicates in each direction
- concentration:#
- type:
list|NoneType, optional, default:Noneargument path:explore[lmp]/configurations[alloy]/concentrationThe concentration of each element. List[List[float]] or List[float] or None. If List[float], the concentrations of each element. The length of the list should be the same as the type_map. If List[List[float]], a list of concentrations (List[float]) is randomly picked from the List. If None, the elements are assumed to be of equal concentration.
- cell_pert_frac:#
- type:
float, optional, default:0.0argument path:explore[lmp]/configurations[alloy]/cell_pert_fracThe faction of cell perturbation
- atom_pert_dist:#
- type:
float, optional, default:0.0argument path:explore[lmp]/configurations[alloy]/atom_pert_distThe distance of atomic position perturbation
When type is set to
file:Generate alloys from user provided file(s). The file(s) are assume to be load by dpdata.
- files:#
- type:
str|listargument path:explore[lmp]/configurations[file]/filesThe paths to the configuration files. widecards are supported.
- prefix:#
- type:
str|NoneType, optional, default:Noneargument path:explore[lmp]/configurations[file]/prefixThe prefix of file paths.
- fmt:#
- type:
str, optional, default:autoargument path:explore[lmp]/configurations[file]/fmtThe format (dpdata accepted formats) of the files.
- remove_pbc:#
- type:
bool, optional, default:Falseargument path:explore[lmp]/configurations[file]/remove_pbcThe remove the pbc of the data. shift the coords to the center of box so it can be used with lammps.
- stages:#
- type:
typing.List[typing.List[dict]]argument path:explore[lmp]/stagesThe 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
- filters:#
- type:
list|dict, optional, default:[]argument path:explore[lmp]/filtersA list of configuration filters
Depending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:explore[lmp]/filters/typethe type of the configuration filter.
distance: Configuration filter of type distancebox_skewness: Configuration filter of type box_skewnessbox_length: Configuration filter of type box_length
When type is set to
distance:Configuration filter of type distance
- max_workers:#
- type:
NoneType|int, optional, default:Noneargument path:explore[lmp]/filters[distance]/max_workersThe maximum number of processes used to filter configurations, None represents as many as the processors of the machine, and 1 for serial
- custom_safe_dist:#
- type:
dict, optional, default:{}argument path:explore[lmp]/filters[distance]/custom_safe_distCustom safe distance (in unit of bohr) for each element
- safe_dist_ratio:#
- type:
float, optional, default:1.0argument path:explore[lmp]/filters[distance]/safe_dist_ratioThe ratio multiplied to the safe distance
When type is set to
box_skewness:Configuration filter of type box_skewness
- max_workers:#
- type:
NoneType|int, optional, default:Noneargument path:explore[lmp]/filters[box_skewness]/max_workersThe maximum number of processes used to filter configurations, None represents as many as the processors of the machine, and 1 for serial
- theta:#
- type:
float, optional, default:60.0argument path:explore[lmp]/filters[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:Configuration filter of type box_length
- max_workers:#
- type:
NoneType|int, optional, default:Noneargument path:explore[lmp]/filters[box_length]/max_workersThe maximum number of processes used to filter configurations, None represents as many as the processors of the machine, and 1 for serial
- length_ratio:#
- type:
float, optional, default:5.0argument path:explore[lmp]/filters[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
When type is set to
calypso:The exploration by CALYPSO structure prediction
- config:#
- type:
dict, optional, default:{'command': 'lmp', 'teacher_model_path': None, 'shuffle_models': False, 'head': None, 'use_ele_temp': 0, 'model_frozen_head': None, 'use_hdf5': False, 'extra_output_files': []}argument path:explore[calypso]/configConfiguration of calypso exploration
- model_devi_group_size:#
- type:
int, optionalargument path:explore[calypso]/config/model_devi_group_sizegroup size for model deviation.
- run_calypso_command:#
- type:
str, optional, default:calypso.xargument path:explore[calypso]/config/run_calypso_commandcommand of running calypso.
- run_opt_command:#
- type:
str, optionalargument path:explore[calypso]/config/run_opt_commandcommand of running optimization with dp.
- max_numb_iter:#
- type:
int, optional, default:10argument path:explore[calypso]/max_numb_iterMaximum number of iterations per stage
- fatal_at_max:#
- type:
bool, optional, default:Trueargument path:explore[calypso]/fatal_at_maxFatal when the number of iteration per stage reaches the max_numb_iter
- output_nopbc:#
- type:
bool, optional, default:Falseargument path:explore[calypso]/output_nopbcRemove pbc of the output configurations
- convergence:#
- type:
dictargument path:explore[calypso]/convergenceThe method of convergence check.
Depending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:explore[calypso]/convergence/typethe type of the condidate selection and convergence check method.
fixed-levels: The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations will be randomly sampled from candidates for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.fixed-levels-max-select: The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations with maximal model deviation in the candidates are sent for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.adaptive-lower: The method of adaptive adjust the lower trust levels. In each step of iterations, a number (set by numb_candi_f or numb_candi_v) or a ratio (set by rate_candi_f or rate_candi_v) of configurations with a model deviation lower than the higher trust level (level_f_hi, level_v_hi) are treated as candidates. The lowest model deviation of the candidates are treated as the lower trust level. If the lower trust level does not change significant (controlled by conv_tolerance) in n_checked_steps, the stage is treated as converged.
When type is set to
fixed-levels:The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations will be randomly sampled from candidates for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.
- level_f_lo:#
- type:
floatargument path:explore[calypso]/convergence[fixed-levels]/level_f_loThe lower trust level of force model deviation
- level_f_hi:#
- type:
floatargument path:explore[calypso]/convergence[fixed-levels]/level_f_hiThe higher trust level of force model deviation
- level_v_lo:#
- type:
NoneType|float, optional, default:Noneargument path:explore[calypso]/convergence[fixed-levels]/level_v_loThe lower trust level of virial model deviation
- level_v_hi:#
- type:
NoneType|float, optional, default:Noneargument path:explore[calypso]/convergence[fixed-levels]/level_v_hiThe higher trust level of virial model deviation
- conv_accuracy:#
- type:
float, optional, default:0.9argument path:explore[calypso]/convergence[fixed-levels]/conv_accuracyIf the ratio of accurate frames is larger than this value, the stage is converged
When type is set to
fixed-levels-max-select:The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations with maximal model deviation in the candidates are sent for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.
- level_f_lo:#
- type:
floatargument path:explore[calypso]/convergence[fixed-levels-max-select]/level_f_loThe lower trust level of force model deviation
- level_f_hi:#
- type:
floatargument path:explore[calypso]/convergence[fixed-levels-max-select]/level_f_hiThe higher trust level of force model deviation
- level_v_lo:#
- type:
NoneType|float, optional, default:Noneargument path:explore[calypso]/convergence[fixed-levels-max-select]/level_v_loThe lower trust level of virial model deviation
- level_v_hi:#
- type:
NoneType|float, optional, default:Noneargument path:explore[calypso]/convergence[fixed-levels-max-select]/level_v_hiThe higher trust level of virial model deviation
- conv_accuracy:#
- type:
float, optional, default:0.9argument path:explore[calypso]/convergence[fixed-levels-max-select]/conv_accuracyIf the ratio of accurate frames is larger than this value, the stage is converged
When type is set to
adaptive-lower:The method of adaptive adjust the lower trust levels. In each step of iterations, a number (set by numb_candi_f or numb_candi_v) or a ratio (set by rate_candi_f or rate_candi_v) of configurations with a model deviation lower than the higher trust level (level_f_hi, level_v_hi) are treated as candidates. The lowest model deviation of the candidates are treated as the lower trust level. If the lower trust level does not change significant (controlled by conv_tolerance) in n_checked_steps, the stage is treated as converged.
- level_f_hi:#
- type:
float, optional, default:0.5argument path:explore[calypso]/convergence[adaptive-lower]/level_f_hiThe higher trust level of force model deviation
- numb_candi_f:#
- type:
int, optional, default:200argument path:explore[calypso]/convergence[adaptive-lower]/numb_candi_fThe number of force frames that has a model deviation lower than level_f_hi treated as candidate.
- rate_candi_f:#
- type:
float, optional, default:0.01argument path:explore[calypso]/convergence[adaptive-lower]/rate_candi_fThe ratio of force frames that has a model deviation lower than level_f_hi treated as candidate.
- level_v_hi:#
- type:
NoneType|float, optional, default:Noneargument path:explore[calypso]/convergence[adaptive-lower]/level_v_hiThe higher trust level of virial model deviation
- numb_candi_v:#
- type:
int, optional, default:0argument path:explore[calypso]/convergence[adaptive-lower]/numb_candi_vThe number of virial frames that has a model deviation lower than level_v_hi treated as candidate.
- rate_candi_v:#
- type:
float, optional, default:0.0argument path:explore[calypso]/convergence[adaptive-lower]/rate_candi_vThe ratio of virial frames that has a model deviation lower than level_v_hi treated as candidate.
- n_checked_steps:#
- type:
int, optional, default:2argument path:explore[calypso]/convergence[adaptive-lower]/n_checked_stepsThe number of steps to check the convergence.
- conv_tolerance:#
- type:
float, optional, default:0.05argument path:explore[calypso]/convergence[adaptive-lower]/conv_toleranceThe convergence tolerance.
- candi_sel_prob:#
- type:
str, optional, default:uniformargument path:explore[calypso]/convergence[adaptive-lower]/candi_sel_probThe method for selecting candidates. It can be ‘uniform’: all candidates are of the same probability. ‘inv_pop_f’ or ‘inv_pop_f:nhist’: the probability is inversely propotional to the population of a histogram between leven_f_lo and level_f_hi. The number of bins in the histogram is set by nhist, which should be an integer. The default is 10.
- configurations:#
- type:
list, alias: configurationargument path:explore[calypso]/configurationsA list of initial configurations.
This argument takes a list with each element containing the following:
Depending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:explore[calypso]/configurations/typethe type of the initial configuration generator.
alloy: Generate alloys with a certain lattice or user proided structure, the elements randomly occuping the lattice with user provided probability .file: Generate alloys from user provided file(s). The file(s) are assume to be load by dpdata.
When type is set to
alloy:Generate alloys with a certain lattice or user proided structure, the elements randomly occuping the lattice with user provided probability .
- numb_confs:#
- type:
int, optional, default:1argument path:explore[calypso]/configurations[alloy]/numb_confsThe number of configurations to generate
- lattice:#
- type:
list|tupleargument path:explore[calypso]/configurations[alloy]/latticeThe lattice. Should be a list providing [ “lattice_type”, lattice_const ], or a list providing [ “/path/to/dpdata/system”, “fmt” ]. The two styles are distinguished by the type of the second element. Currently “lattice_type” can be “bcc”, “fcc”, “hcp”, “sc” or “diamond”.
- replicate:#
- type:
list|NoneType, optional, default:Noneargument path:explore[calypso]/configurations[alloy]/replicateThe number of replicates in each direction
- concentration:#
- type:
list|NoneType, optional, default:Noneargument path:explore[calypso]/configurations[alloy]/concentrationThe concentration of each element. List[List[float]] or List[float] or None. If List[float], the concentrations of each element. The length of the list should be the same as the type_map. If List[List[float]], a list of concentrations (List[float]) is randomly picked from the List. If None, the elements are assumed to be of equal concentration.
- cell_pert_frac:#
- type:
float, optional, default:0.0argument path:explore[calypso]/configurations[alloy]/cell_pert_fracThe faction of cell perturbation
- atom_pert_dist:#
- type:
float, optional, default:0.0argument path:explore[calypso]/configurations[alloy]/atom_pert_distThe distance of atomic position perturbation
When type is set to
file:Generate alloys from user provided file(s). The file(s) are assume to be load by dpdata.
- files:#
- type:
str|listargument path:explore[calypso]/configurations[file]/filesThe paths to the configuration files. widecards are supported.
- prefix:#
- type:
str|NoneType, optional, default:Noneargument path:explore[calypso]/configurations[file]/prefixThe prefix of file paths.
- fmt:#
- type:
str, optional, default:autoargument path:explore[calypso]/configurations[file]/fmtThe format (dpdata accepted formats) of the files.
- remove_pbc:#
- type:
bool, optional, default:Falseargument path:explore[calypso]/configurations[file]/remove_pbcThe remove the pbc of the data. shift the coords to the center of box so it can be used with lammps.
- stages:#
- type:
typing.List[typing.List[dict]]argument path:explore[calypso]/stagesThe 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
- filters:#
- type:
list|dict, optional, default:[]argument path:explore[calypso]/filtersA list of configuration filters
Depending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:explore[calypso]/filters/typethe type of the configuration filter.
distance: Configuration filter of type distancebox_skewness: Configuration filter of type box_skewnessbox_length: Configuration filter of type box_length
When type is set to
distance:Configuration filter of type distance
- max_workers:#
- type:
NoneType|int, optional, default:Noneargument path:explore[calypso]/filters[distance]/max_workersThe maximum number of processes used to filter configurations, None represents as many as the processors of the machine, and 1 for serial
- custom_safe_dist:#
- type:
dict, optional, default:{}argument path:explore[calypso]/filters[distance]/custom_safe_distCustom safe distance (in unit of bohr) for each element
- safe_dist_ratio:#
- type:
float, optional, default:1.0argument path:explore[calypso]/filters[distance]/safe_dist_ratioThe ratio multiplied to the safe distance
When type is set to
box_skewness:Configuration filter of type box_skewness
- max_workers:#
- type:
NoneType|int, optional, default:Noneargument path:explore[calypso]/filters[box_skewness]/max_workersThe maximum number of processes used to filter configurations, None represents as many as the processors of the machine, and 1 for serial
- theta:#
- type:
float, optional, default:60.0argument path:explore[calypso]/filters[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:Configuration filter of type box_length
- max_workers:#
- type:
NoneType|int, optional, default:Noneargument path:explore[calypso]/filters[box_length]/max_workersThe maximum number of processes used to filter configurations, None represents as many as the processors of the machine, and 1 for serial
- length_ratio:#
- type:
float, optional, default:5.0argument path:explore[calypso]/filters[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
When type is set to
calypso:default:The exploration by CALYPSO structure prediction
- config:#
- type:
dict, optional, default:{'command': 'lmp', 'teacher_model_path': None, 'shuffle_models': False, 'head': None, 'use_ele_temp': 0, 'model_frozen_head': None, 'use_hdf5': False, 'extra_output_files': []}argument path:explore[calypso:default]/configConfiguration of calypso exploration
- model_devi_group_size:#
- type:
int, optionalargument path:explore[calypso:default]/config/model_devi_group_sizegroup size for model deviation.
- run_calypso_command:#
- type:
str, optional, default:calypso.xargument path:explore[calypso:default]/config/run_calypso_commandcommand of running calypso.
- run_opt_command:#
- type:
str, optionalargument path:explore[calypso:default]/config/run_opt_commandcommand of running optimization with dp.
- max_numb_iter:#
- type:
int, optional, default:10argument path:explore[calypso:default]/max_numb_iterMaximum number of iterations per stage
- fatal_at_max:#
- type:
bool, optional, default:Trueargument path:explore[calypso:default]/fatal_at_maxFatal when the number of iteration per stage reaches the max_numb_iter
- output_nopbc:#
- type:
bool, optional, default:Falseargument path:explore[calypso:default]/output_nopbcRemove pbc of the output configurations
- convergence:#
- type:
dictargument path:explore[calypso:default]/convergenceThe method of convergence check.
Depending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:explore[calypso:default]/convergence/typethe type of the condidate selection and convergence check method.
fixed-levels: The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations will be randomly sampled from candidates for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.fixed-levels-max-select: The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations with maximal model deviation in the candidates are sent for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.adaptive-lower: The method of adaptive adjust the lower trust levels. In each step of iterations, a number (set by numb_candi_f or numb_candi_v) or a ratio (set by rate_candi_f or rate_candi_v) of configurations with a model deviation lower than the higher trust level (level_f_hi, level_v_hi) are treated as candidates. The lowest model deviation of the candidates are treated as the lower trust level. If the lower trust level does not change significant (controlled by conv_tolerance) in n_checked_steps, the stage is treated as converged.
When type is set to
fixed-levels:The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations will be randomly sampled from candidates for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.
- level_f_lo:#
- type:
floatargument path:explore[calypso:default]/convergence[fixed-levels]/level_f_loThe lower trust level of force model deviation
- level_f_hi:#
- type:
floatargument path:explore[calypso:default]/convergence[fixed-levels]/level_f_hiThe higher trust level of force model deviation
- level_v_lo:#
- type:
NoneType|float, optional, default:Noneargument path:explore[calypso:default]/convergence[fixed-levels]/level_v_loThe lower trust level of virial model deviation
- level_v_hi:#
- type:
NoneType|float, optional, default:Noneargument path:explore[calypso:default]/convergence[fixed-levels]/level_v_hiThe higher trust level of virial model deviation
- conv_accuracy:#
- type:
float, optional, default:0.9argument path:explore[calypso:default]/convergence[fixed-levels]/conv_accuracyIf the ratio of accurate frames is larger than this value, the stage is converged
When type is set to
fixed-levels-max-select:The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations with maximal model deviation in the candidates are sent for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.
- level_f_lo:#
- type:
floatargument path:explore[calypso:default]/convergence[fixed-levels-max-select]/level_f_loThe lower trust level of force model deviation
- level_f_hi:#
- type:
floatargument path:explore[calypso:default]/convergence[fixed-levels-max-select]/level_f_hiThe higher trust level of force model deviation
- level_v_lo:#
- type:
NoneType|float, optional, default:Noneargument path:explore[calypso:default]/convergence[fixed-levels-max-select]/level_v_loThe lower trust level of virial model deviation
- level_v_hi:#
- type:
NoneType|float, optional, default:Noneargument path:explore[calypso:default]/convergence[fixed-levels-max-select]/level_v_hiThe higher trust level of virial model deviation
- conv_accuracy:#
- type:
float, optional, default:0.9argument path:explore[calypso:default]/convergence[fixed-levels-max-select]/conv_accuracyIf the ratio of accurate frames is larger than this value, the stage is converged
When type is set to
adaptive-lower:The method of adaptive adjust the lower trust levels. In each step of iterations, a number (set by numb_candi_f or numb_candi_v) or a ratio (set by rate_candi_f or rate_candi_v) of configurations with a model deviation lower than the higher trust level (level_f_hi, level_v_hi) are treated as candidates. The lowest model deviation of the candidates are treated as the lower trust level. If the lower trust level does not change significant (controlled by conv_tolerance) in n_checked_steps, the stage is treated as converged.
- level_f_hi:#
- type:
float, optional, default:0.5argument path:explore[calypso:default]/convergence[adaptive-lower]/level_f_hiThe higher trust level of force model deviation
- numb_candi_f:#
- type:
int, optional, default:200argument path:explore[calypso:default]/convergence[adaptive-lower]/numb_candi_fThe number of force frames that has a model deviation lower than level_f_hi treated as candidate.
- rate_candi_f:#
- type:
float, optional, default:0.01argument path:explore[calypso:default]/convergence[adaptive-lower]/rate_candi_fThe ratio of force frames that has a model deviation lower than level_f_hi treated as candidate.
- level_v_hi:#
- type:
NoneType|float, optional, default:Noneargument path:explore[calypso:default]/convergence[adaptive-lower]/level_v_hiThe higher trust level of virial model deviation
- numb_candi_v:#
- type:
int, optional, default:0argument path:explore[calypso:default]/convergence[adaptive-lower]/numb_candi_vThe number of virial frames that has a model deviation lower than level_v_hi treated as candidate.
- rate_candi_v:#
- type:
float, optional, default:0.0argument path:explore[calypso:default]/convergence[adaptive-lower]/rate_candi_vThe ratio of virial frames that has a model deviation lower than level_v_hi treated as candidate.
- n_checked_steps:#
- type:
int, optional, default:2argument path:explore[calypso:default]/convergence[adaptive-lower]/n_checked_stepsThe number of steps to check the convergence.
- conv_tolerance:#
- type:
float, optional, default:0.05argument path:explore[calypso:default]/convergence[adaptive-lower]/conv_toleranceThe convergence tolerance.
- candi_sel_prob:#
- type:
str, optional, default:uniformargument path:explore[calypso:default]/convergence[adaptive-lower]/candi_sel_probThe method for selecting candidates. It can be ‘uniform’: all candidates are of the same probability. ‘inv_pop_f’ or ‘inv_pop_f:nhist’: the probability is inversely propotional to the population of a histogram between leven_f_lo and level_f_hi. The number of bins in the histogram is set by nhist, which should be an integer. The default is 10.
- configurations:#
- type:
list, alias: configurationargument path:explore[calypso:default]/configurationsA list of initial configurations.
This argument takes a list with each element containing the following:
Depending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:explore[calypso:default]/configurations/typethe type of the initial configuration generator.
alloy: Generate alloys with a certain lattice or user proided structure, the elements randomly occuping the lattice with user provided probability .file: Generate alloys from user provided file(s). The file(s) are assume to be load by dpdata.
When type is set to
alloy:Generate alloys with a certain lattice or user proided structure, the elements randomly occuping the lattice with user provided probability .
- numb_confs:#
- type:
int, optional, default:1argument path:explore[calypso:default]/configurations[alloy]/numb_confsThe number of configurations to generate
- lattice:#
- type:
list|tupleargument path:explore[calypso:default]/configurations[alloy]/latticeThe lattice. Should be a list providing [ “lattice_type”, lattice_const ], or a list providing [ “/path/to/dpdata/system”, “fmt” ]. The two styles are distinguished by the type of the second element. Currently “lattice_type” can be “bcc”, “fcc”, “hcp”, “sc” or “diamond”.
- replicate:#
- type:
list|NoneType, optional, default:Noneargument path:explore[calypso:default]/configurations[alloy]/replicateThe number of replicates in each direction
- concentration:#
- type:
list|NoneType, optional, default:Noneargument path:explore[calypso:default]/configurations[alloy]/concentrationThe concentration of each element. List[List[float]] or List[float] or None. If List[float], the concentrations of each element. The length of the list should be the same as the type_map. If List[List[float]], a list of concentrations (List[float]) is randomly picked from the List. If None, the elements are assumed to be of equal concentration.
- cell_pert_frac:#
- type:
float, optional, default:0.0argument path:explore[calypso:default]/configurations[alloy]/cell_pert_fracThe faction of cell perturbation
- atom_pert_dist:#
- type:
float, optional, default:0.0argument path:explore[calypso:default]/configurations[alloy]/atom_pert_distThe distance of atomic position perturbation
When type is set to
file:Generate alloys from user provided file(s). The file(s) are assume to be load by dpdata.
- files:#
- type:
str|listargument path:explore[calypso:default]/configurations[file]/filesThe paths to the configuration files. widecards are supported.
- prefix:#
- type:
str|NoneType, optional, default:Noneargument path:explore[calypso:default]/configurations[file]/prefixThe prefix of file paths.
- fmt:#
- type:
str, optional, default:autoargument path:explore[calypso:default]/configurations[file]/fmtThe format (dpdata accepted formats) of the files.
- remove_pbc:#
- type:
bool, optional, default:Falseargument path:explore[calypso:default]/configurations[file]/remove_pbcThe remove the pbc of the data. shift the coords to the center of box so it can be used with lammps.
- stages:#
- type:
typing.List[typing.List[dict]]argument path:explore[calypso:default]/stagesThe 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
- filters:#
- type:
list|dict, optional, default:[]argument path:explore[calypso:default]/filtersA list of configuration filters
Depending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:explore[calypso:default]/filters/typethe type of the configuration filter.
distance: Configuration filter of type distancebox_skewness: Configuration filter of type box_skewnessbox_length: Configuration filter of type box_length
When type is set to
distance:Configuration filter of type distance
- max_workers:#
- type:
NoneType|int, optional, default:Noneargument path:explore[calypso:default]/filters[distance]/max_workersThe maximum number of processes used to filter configurations, None represents as many as the processors of the machine, and 1 for serial
- custom_safe_dist:#
- type:
dict, optional, default:{}argument path:explore[calypso:default]/filters[distance]/custom_safe_distCustom safe distance (in unit of bohr) for each element
- safe_dist_ratio:#
- type:
float, optional, default:1.0argument path:explore[calypso:default]/filters[distance]/safe_dist_ratioThe ratio multiplied to the safe distance
When type is set to
box_skewness:Configuration filter of type box_skewness
- max_workers:#
- type:
NoneType|int, optional, default:Noneargument path:explore[calypso:default]/filters[box_skewness]/max_workersThe maximum number of processes used to filter configurations, None represents as many as the processors of the machine, and 1 for serial
- theta:#
- type:
float, optional, default:60.0argument path:explore[calypso:default]/filters[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:Configuration filter of type box_length
- max_workers:#
- type:
NoneType|int, optional, default:Noneargument path:explore[calypso:default]/filters[box_length]/max_workersThe maximum number of processes used to filter configurations, None represents as many as the processors of the machine, and 1 for serial
- length_ratio:#
- type:
float, optional, default:5.0argument path:explore[calypso:default]/filters[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
When type is set to
calypso:merge:The exploration by CALYPSO structure prediction
- config:#
- type:
dict, optional, default:{'command': 'lmp', 'teacher_model_path': None, 'shuffle_models': False, 'head': None, 'use_ele_temp': 0, 'model_frozen_head': None, 'use_hdf5': False, 'extra_output_files': []}argument path:explore[calypso:merge]/configConfiguration of calypso exploration
- model_devi_group_size:#
- type:
int, optionalargument path:explore[calypso:merge]/config/model_devi_group_sizegroup size for model deviation.
- run_calypso_command:#
- type:
str, optional, default:calypso.xargument path:explore[calypso:merge]/config/run_calypso_commandcommand of running calypso.
- run_opt_command:#
- type:
str, optionalargument path:explore[calypso:merge]/config/run_opt_commandcommand of running optimization with dp.
- max_numb_iter:#
- type:
int, optional, default:10argument path:explore[calypso:merge]/max_numb_iterMaximum number of iterations per stage
- fatal_at_max:#
- type:
bool, optional, default:Trueargument path:explore[calypso:merge]/fatal_at_maxFatal when the number of iteration per stage reaches the max_numb_iter
- output_nopbc:#
- type:
bool, optional, default:Falseargument path:explore[calypso:merge]/output_nopbcRemove pbc of the output configurations
- convergence:#
- type:
dictargument path:explore[calypso:merge]/convergenceThe method of convergence check.
Depending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:explore[calypso:merge]/convergence/typethe type of the condidate selection and convergence check method.
fixed-levels: The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations will be randomly sampled from candidates for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.fixed-levels-max-select: The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations with maximal model deviation in the candidates are sent for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.adaptive-lower: The method of adaptive adjust the lower trust levels. In each step of iterations, a number (set by numb_candi_f or numb_candi_v) or a ratio (set by rate_candi_f or rate_candi_v) of configurations with a model deviation lower than the higher trust level (level_f_hi, level_v_hi) are treated as candidates. The lowest model deviation of the candidates are treated as the lower trust level. If the lower trust level does not change significant (controlled by conv_tolerance) in n_checked_steps, the stage is treated as converged.
When type is set to
fixed-levels:The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations will be randomly sampled from candidates for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.
- level_f_lo:#
- type:
floatargument path:explore[calypso:merge]/convergence[fixed-levels]/level_f_loThe lower trust level of force model deviation
- level_f_hi:#
- type:
floatargument path:explore[calypso:merge]/convergence[fixed-levels]/level_f_hiThe higher trust level of force model deviation
- level_v_lo:#
- type:
NoneType|float, optional, default:Noneargument path:explore[calypso:merge]/convergence[fixed-levels]/level_v_loThe lower trust level of virial model deviation
- level_v_hi:#
- type:
NoneType|float, optional, default:Noneargument path:explore[calypso:merge]/convergence[fixed-levels]/level_v_hiThe higher trust level of virial model deviation
- conv_accuracy:#
- type:
float, optional, default:0.9argument path:explore[calypso:merge]/convergence[fixed-levels]/conv_accuracyIf the ratio of accurate frames is larger than this value, the stage is converged
When type is set to
fixed-levels-max-select:The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations with maximal model deviation in the candidates are sent for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.
- level_f_lo:#
- type:
floatargument path:explore[calypso:merge]/convergence[fixed-levels-max-select]/level_f_loThe lower trust level of force model deviation
- level_f_hi:#
- type:
floatargument path:explore[calypso:merge]/convergence[fixed-levels-max-select]/level_f_hiThe higher trust level of force model deviation
- level_v_lo:#
- type:
NoneType|float, optional, default:Noneargument path:explore[calypso:merge]/convergence[fixed-levels-max-select]/level_v_loThe lower trust level of virial model deviation
- level_v_hi:#
- type:
NoneType|float, optional, default:Noneargument path:explore[calypso:merge]/convergence[fixed-levels-max-select]/level_v_hiThe higher trust level of virial model deviation
- conv_accuracy:#
- type:
float, optional, default:0.9argument path:explore[calypso:merge]/convergence[fixed-levels-max-select]/conv_accuracyIf the ratio of accurate frames is larger than this value, the stage is converged
When type is set to
adaptive-lower:The method of adaptive adjust the lower trust levels. In each step of iterations, a number (set by numb_candi_f or numb_candi_v) or a ratio (set by rate_candi_f or rate_candi_v) of configurations with a model deviation lower than the higher trust level (level_f_hi, level_v_hi) are treated as candidates. The lowest model deviation of the candidates are treated as the lower trust level. If the lower trust level does not change significant (controlled by conv_tolerance) in n_checked_steps, the stage is treated as converged.
- level_f_hi:#
- type:
float, optional, default:0.5argument path:explore[calypso:merge]/convergence[adaptive-lower]/level_f_hiThe higher trust level of force model deviation
- numb_candi_f:#
- type:
int, optional, default:200argument path:explore[calypso:merge]/convergence[adaptive-lower]/numb_candi_fThe number of force frames that has a model deviation lower than level_f_hi treated as candidate.
- rate_candi_f:#
- type:
float, optional, default:0.01argument path:explore[calypso:merge]/convergence[adaptive-lower]/rate_candi_fThe ratio of force frames that has a model deviation lower than level_f_hi treated as candidate.
- level_v_hi:#
- type:
NoneType|float, optional, default:Noneargument path:explore[calypso:merge]/convergence[adaptive-lower]/level_v_hiThe higher trust level of virial model deviation
- numb_candi_v:#
- type:
int, optional, default:0argument path:explore[calypso:merge]/convergence[adaptive-lower]/numb_candi_vThe number of virial frames that has a model deviation lower than level_v_hi treated as candidate.
- rate_candi_v:#
- type:
float, optional, default:0.0argument path:explore[calypso:merge]/convergence[adaptive-lower]/rate_candi_vThe ratio of virial frames that has a model deviation lower than level_v_hi treated as candidate.
- n_checked_steps:#
- type:
int, optional, default:2argument path:explore[calypso:merge]/convergence[adaptive-lower]/n_checked_stepsThe number of steps to check the convergence.
- conv_tolerance:#
- type:
float, optional, default:0.05argument path:explore[calypso:merge]/convergence[adaptive-lower]/conv_toleranceThe convergence tolerance.
- candi_sel_prob:#
- type:
str, optional, default:uniformargument path:explore[calypso:merge]/convergence[adaptive-lower]/candi_sel_probThe method for selecting candidates. It can be ‘uniform’: all candidates are of the same probability. ‘inv_pop_f’ or ‘inv_pop_f:nhist’: the probability is inversely propotional to the population of a histogram between leven_f_lo and level_f_hi. The number of bins in the histogram is set by nhist, which should be an integer. The default is 10.
- configurations:#
- type:
list, alias: configurationargument path:explore[calypso:merge]/configurationsA list of initial configurations.
This argument takes a list with each element containing the following:
Depending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:explore[calypso:merge]/configurations/typethe type of the initial configuration generator.
alloy: Generate alloys with a certain lattice or user proided structure, the elements randomly occuping the lattice with user provided probability .file: Generate alloys from user provided file(s). The file(s) are assume to be load by dpdata.
When type is set to
alloy:Generate alloys with a certain lattice or user proided structure, the elements randomly occuping the lattice with user provided probability .
- numb_confs:#
- type:
int, optional, default:1argument path:explore[calypso:merge]/configurations[alloy]/numb_confsThe number of configurations to generate
- lattice:#
- type:
list|tupleargument path:explore[calypso:merge]/configurations[alloy]/latticeThe lattice. Should be a list providing [ “lattice_type”, lattice_const ], or a list providing [ “/path/to/dpdata/system”, “fmt” ]. The two styles are distinguished by the type of the second element. Currently “lattice_type” can be “bcc”, “fcc”, “hcp”, “sc” or “diamond”.
- replicate:#
- type:
list|NoneType, optional, default:Noneargument path:explore[calypso:merge]/configurations[alloy]/replicateThe number of replicates in each direction
- concentration:#
- type:
list|NoneType, optional, default:Noneargument path:explore[calypso:merge]/configurations[alloy]/concentrationThe concentration of each element. List[List[float]] or List[float] or None. If List[float], the concentrations of each element. The length of the list should be the same as the type_map. If List[List[float]], a list of concentrations (List[float]) is randomly picked from the List. If None, the elements are assumed to be of equal concentration.
- cell_pert_frac:#
- type:
float, optional, default:0.0argument path:explore[calypso:merge]/configurations[alloy]/cell_pert_fracThe faction of cell perturbation
- atom_pert_dist:#
- type:
float, optional, default:0.0argument path:explore[calypso:merge]/configurations[alloy]/atom_pert_distThe distance of atomic position perturbation
When type is set to
file:Generate alloys from user provided file(s). The file(s) are assume to be load by dpdata.
- files:#
- type:
str|listargument path:explore[calypso:merge]/configurations[file]/filesThe paths to the configuration files. widecards are supported.
- prefix:#
- type:
str|NoneType, optional, default:Noneargument path:explore[calypso:merge]/configurations[file]/prefixThe prefix of file paths.
- fmt:#
- type:
str, optional, default:autoargument path:explore[calypso:merge]/configurations[file]/fmtThe format (dpdata accepted formats) of the files.
- remove_pbc:#
- type:
bool, optional, default:Falseargument path:explore[calypso:merge]/configurations[file]/remove_pbcThe remove the pbc of the data. shift the coords to the center of box so it can be used with lammps.
- stages:#
- type:
typing.List[typing.List[dict]]argument path:explore[calypso:merge]/stagesThe 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
- filters:#
- type:
list|dict, optional, default:[]argument path:explore[calypso:merge]/filtersA list of configuration filters
Depending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:explore[calypso:merge]/filters/typethe type of the configuration filter.
distance: Configuration filter of type distancebox_skewness: Configuration filter of type box_skewnessbox_length: Configuration filter of type box_length
When type is set to
distance:Configuration filter of type distance
- max_workers:#
- type:
NoneType|int, optional, default:Noneargument path:explore[calypso:merge]/filters[distance]/max_workersThe maximum number of processes used to filter configurations, None represents as many as the processors of the machine, and 1 for serial
- custom_safe_dist:#
- type:
dict, optional, default:{}argument path:explore[calypso:merge]/filters[distance]/custom_safe_distCustom safe distance (in unit of bohr) for each element
- safe_dist_ratio:#
- type:
float, optional, default:1.0argument path:explore[calypso:merge]/filters[distance]/safe_dist_ratioThe ratio multiplied to the safe distance
When type is set to
box_skewness:Configuration filter of type box_skewness
- max_workers:#
- type:
NoneType|int, optional, default:Noneargument path:explore[calypso:merge]/filters[box_skewness]/max_workersThe maximum number of processes used to filter configurations, None represents as many as the processors of the machine, and 1 for serial
- theta:#
- type:
float, optional, default:60.0argument path:explore[calypso:merge]/filters[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:Configuration filter of type box_length
- max_workers:#
- type:
NoneType|int, optional, default:Noneargument path:explore[calypso:merge]/filters[box_length]/max_workersThe maximum number of processes used to filter configurations, None represents as many as the processors of the machine, and 1 for serial
- length_ratio:#
- type:
float, optional, default:5.0argument path:explore[calypso:merge]/filters[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
When type is set to
diffcsp:The exploration by DiffCSP
- config:#
- type:
dictargument path:explore[diffcsp]/configConfiguration of DiffCSP exploration
- gen_tasks:#
- type:
int, optional, default:1argument path:explore[diffcsp]/config/gen_tasksNumber of DiffCSP generation tasks
- gen_command:#
- type:
strargument path:explore[diffcsp]/config/gen_commandCommand for DiffCSP generation
- relax_group_size:#
- type:
int, optional, default:100argument path:explore[diffcsp]/config/relax_group_sizeGroup size for relaxation
- use_hdf5:#
- type:
bool, optional, default:Falseargument path:explore[diffcsp]/config/use_hdf5Use HDF5 to store trajs and model_devis
- max_numb_iter:#
- type:
int, optional, default:10argument path:explore[diffcsp]/max_numb_iterMaximum number of iterations per stage
- fatal_at_max:#
- type:
bool, optional, default:Trueargument path:explore[diffcsp]/fatal_at_maxFatal when the number of iteration per stage reaches the max_numb_iter
- output_nopbc:#
- type:
bool, optional, default:Falseargument path:explore[diffcsp]/output_nopbcRemove pbc of the output configurations
- convergence:#
- type:
dictargument path:explore[diffcsp]/convergenceThe method of convergence check.
Depending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:explore[diffcsp]/convergence/typethe type of the condidate selection and convergence check method.
fixed-levels: The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations will be randomly sampled from candidates for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.fixed-levels-max-select: The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations with maximal model deviation in the candidates are sent for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.adaptive-lower: The method of adaptive adjust the lower trust levels. In each step of iterations, a number (set by numb_candi_f or numb_candi_v) or a ratio (set by rate_candi_f or rate_candi_v) of configurations with a model deviation lower than the higher trust level (level_f_hi, level_v_hi) are treated as candidates. The lowest model deviation of the candidates are treated as the lower trust level. If the lower trust level does not change significant (controlled by conv_tolerance) in n_checked_steps, the stage is treated as converged.
When type is set to
fixed-levels:The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations will be randomly sampled from candidates for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.
- level_f_lo:#
- type:
floatargument path:explore[diffcsp]/convergence[fixed-levels]/level_f_loThe lower trust level of force model deviation
- level_f_hi:#
- type:
floatargument path:explore[diffcsp]/convergence[fixed-levels]/level_f_hiThe higher trust level of force model deviation
- level_v_lo:#
- type:
NoneType|float, optional, default:Noneargument path:explore[diffcsp]/convergence[fixed-levels]/level_v_loThe lower trust level of virial model deviation
- level_v_hi:#
- type:
NoneType|float, optional, default:Noneargument path:explore[diffcsp]/convergence[fixed-levels]/level_v_hiThe higher trust level of virial model deviation
- conv_accuracy:#
- type:
float, optional, default:0.9argument path:explore[diffcsp]/convergence[fixed-levels]/conv_accuracyIf the ratio of accurate frames is larger than this value, the stage is converged
When type is set to
fixed-levels-max-select:The configurations with force model deviation between level_f_lo, level_f_hi or virial model deviation between level_v_lo and level_v_hi are treated as candidates (The virial model deviation check is optional). The configurations with maximal model deviation in the candidates are sent for FP calculations. If the ratio of accurate (below level_f_lo and level_v_lo) is higher then conv_accuracy, the stage is treated as converged.
- level_f_lo:#
- type:
floatargument path:explore[diffcsp]/convergence[fixed-levels-max-select]/level_f_loThe lower trust level of force model deviation
- level_f_hi:#
- type:
floatargument path:explore[diffcsp]/convergence[fixed-levels-max-select]/level_f_hiThe higher trust level of force model deviation
- level_v_lo:#
- type:
NoneType|float, optional, default:Noneargument path:explore[diffcsp]/convergence[fixed-levels-max-select]/level_v_loThe lower trust level of virial model deviation
- level_v_hi:#
- type:
NoneType|float, optional, default:Noneargument path:explore[diffcsp]/convergence[fixed-levels-max-select]/level_v_hiThe higher trust level of virial model deviation
- conv_accuracy:#
- type:
float, optional, default:0.9argument path:explore[diffcsp]/convergence[fixed-levels-max-select]/conv_accuracyIf the ratio of accurate frames is larger than this value, the stage is converged
When type is set to
adaptive-lower:The method of adaptive adjust the lower trust levels. In each step of iterations, a number (set by numb_candi_f or numb_candi_v) or a ratio (set by rate_candi_f or rate_candi_v) of configurations with a model deviation lower than the higher trust level (level_f_hi, level_v_hi) are treated as candidates. The lowest model deviation of the candidates are treated as the lower trust level. If the lower trust level does not change significant (controlled by conv_tolerance) in n_checked_steps, the stage is treated as converged.
- level_f_hi:#
- type:
float, optional, default:0.5argument path:explore[diffcsp]/convergence[adaptive-lower]/level_f_hiThe higher trust level of force model deviation
- numb_candi_f:#
- type:
int, optional, default:200argument path:explore[diffcsp]/convergence[adaptive-lower]/numb_candi_fThe number of force frames that has a model deviation lower than level_f_hi treated as candidate.
- rate_candi_f:#
- type:
float, optional, default:0.01argument path:explore[diffcsp]/convergence[adaptive-lower]/rate_candi_fThe ratio of force frames that has a model deviation lower than level_f_hi treated as candidate.
- level_v_hi:#
- type:
NoneType|float, optional, default:Noneargument path:explore[diffcsp]/convergence[adaptive-lower]/level_v_hiThe higher trust level of virial model deviation
- numb_candi_v:#
- type:
int, optional, default:0argument path:explore[diffcsp]/convergence[adaptive-lower]/numb_candi_vThe number of virial frames that has a model deviation lower than level_v_hi treated as candidate.
- rate_candi_v:#
- type:
float, optional, default:0.0argument path:explore[diffcsp]/convergence[adaptive-lower]/rate_candi_vThe ratio of virial frames that has a model deviation lower than level_v_hi treated as candidate.
- n_checked_steps:#
- type:
int, optional, default:2argument path:explore[diffcsp]/convergence[adaptive-lower]/n_checked_stepsThe number of steps to check the convergence.
- conv_tolerance:#
- type:
float, optional, default:0.05argument path:explore[diffcsp]/convergence[adaptive-lower]/conv_toleranceThe convergence tolerance.
- candi_sel_prob:#
- type:
str, optional, default:uniformargument path:explore[diffcsp]/convergence[adaptive-lower]/candi_sel_probThe method for selecting candidates. It can be ‘uniform’: all candidates are of the same probability. ‘inv_pop_f’ or ‘inv_pop_f:nhist’: the probability is inversely propotional to the population of a histogram between leven_f_lo and level_f_hi. The number of bins in the histogram is set by nhist, which should be an integer. The default is 10.
- stages:#
- type:
typing.List[typing.List[dict]]argument path:explore[diffcsp]/stagesThe 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
- filters:#
- type:
list|dict, optional, default:[]argument path:explore[diffcsp]/filtersA list of configuration filters
Depending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:explore[diffcsp]/filters/typethe type of the configuration filter.
distance: Configuration filter of type distancebox_skewness: Configuration filter of type box_skewnessbox_length: Configuration filter of type box_length
When type is set to
distance:Configuration filter of type distance
- max_workers:#
- type:
NoneType|int, optional, default:Noneargument path:explore[diffcsp]/filters[distance]/max_workersThe maximum number of processes used to filter configurations, None represents as many as the processors of the machine, and 1 for serial
- custom_safe_dist:#
- type:
dict, optional, default:{}argument path:explore[diffcsp]/filters[distance]/custom_safe_distCustom safe distance (in unit of bohr) for each element
- safe_dist_ratio:#
- type:
float, optional, default:1.0argument path:explore[diffcsp]/filters[distance]/safe_dist_ratioThe ratio multiplied to the safe distance
When type is set to
box_skewness:Configuration filter of type box_skewness
- max_workers:#
- type:
NoneType|int, optional, default:Noneargument path:explore[diffcsp]/filters[box_skewness]/max_workersThe maximum number of processes used to filter configurations, None represents as many as the processors of the machine, and 1 for serial
- theta:#
- type:
float, optional, default:60.0argument path:explore[diffcsp]/filters[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:Configuration filter of type box_length
- max_workers:#
- type:
NoneType|int, optional, default:Noneargument path:explore[diffcsp]/filters[box_length]/max_workersThe maximum number of processes used to filter configurations, None represents as many as the processors of the machine, and 1 for serial
- length_ratio:#
- type:
float, optional, default:5.0argument path:explore[diffcsp]/filters[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
- fp:#
- type:
dictargument path:fpThe configuration for FP
Depending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:fp/typethe type of the fp
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:dataargument 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
- task_max:#
- type:
int, optional, default:10argument path:fp[vasp]/task_maxMaximum number of vasp tasks for each iteration
- extra_output_files:#
- type:
list, optional, default:[]argument path:fp[vasp]/extra_output_filesExtra output file names, support wildcards
When type is set to
gaussian:- inputs_config:#
- type:
dictargument path:fp[gaussian]/inputs_configConfiguration for preparing vasp inputs
- keywords:#
- type:
str|listargument path:fp[gaussian]/inputs_config/keywordsGaussian keywords, e.g. force b3lyp/6-31g**. If a list, run multiple steps.
- multiplicity:#
- type:
str|int, optional, default:autoargument path:fp[gaussian]/inputs_config/multiplicityspin multiplicity state. It can be a number. If auto, multiplicity will be detected automatically, with the following rules:
fragment_guesses=True multiplicity will +1 for each radical, and +2 for each oxygen molecule
fragment_guesses=False multiplicity will be 1 or 2, but +2 for each oxygen molecule.
- charge:#
- type:
int, optional, default:0argument path:fp[gaussian]/inputs_config/chargemolecule charge. Only used when charge is not provided by the system
- basis_set:#
- type:
str, optionalargument path:fp[gaussian]/inputs_config/basis_setcustom basis set
- keywords_high_multiplicity:#
- type:
str, optionalargument path:fp[gaussian]/inputs_config/keywords_high_multiplicitykeywords for points with multiple raicals. multiplicity should be auto. If not set, fallback to normal keywords
- fragment_guesses:#
- type:
bool, optional, default:Falseargument path:fp[gaussian]/inputs_config/fragment_guessesinitial guess generated from fragment guesses. If True, multiplicity should be auto
- nproc:#
- type:
int, optional, default:1argument path:fp[gaussian]/inputs_config/nprocNumber of CPUs to use
- run_config:#
- type:
dictargument path:fp[gaussian]/run_configConfiguration for running vasp tasks
- command:#
- type:
str, optional, default:g16argument path:fp[gaussian]/run_config/commandThe command of Gaussian
- out:#
- type:
str, optional, default:dataargument path:fp[gaussian]/run_config/outThe output dir name of labeled data. In deepmd/npy format provided by dpdata.
- post_command:#
- type:
str|NoneType, optional, default:Noneargument path:fp[gaussian]/run_config/post_commandThe command after Gaussian
- task_max:#
- type:
int, optional, default:10argument path:fp[gaussian]/task_maxMaximum number of vasp tasks for each iteration
- extra_output_files:#
- type:
list, optional, default:[]argument path:fp[gaussian]/extra_output_filesExtra output file names, support wildcards
When type is set to
deepmd:- inputs_config:#
- type:
dictargument path:fp[deepmd]/inputs_configConfiguration for preparing vasp inputs
- run_config:#
- type:
dictargument path:fp[deepmd]/run_configConfiguration for running vasp tasks
- teacher_model_path:#
- type:
str|BinaryFileInputargument path:fp[deepmd]/run_config/teacher_model_pathThe path of teacher model, which can be loaded by deepmd.infer.DeepPot
- out:#
- type:
str, optional, default:dataargument path:fp[deepmd]/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[deepmd]/run_config/logThe log file name of dp
- task_max:#
- type:
int, optional, default:10argument path:fp[deepmd]/task_maxMaximum number of vasp tasks for each iteration
- extra_output_files:#
- type:
list, optional, default:[]argument path:fp[deepmd]/extra_output_filesExtra output file names, support wildcards
When type is set to
fpop_abacus:- inputs_config:#
- type:
dictargument path:fp[fpop_abacus]/inputs_configConfiguration for preparing vasp inputs
- input_file:#
- type:
strargument path:fp[fpop_abacus]/inputs_config/input_fileA template INPUT file.
- pp_files:#
- type:
dictargument path:fp[fpop_abacus]/inputs_config/pp_filesThe pseudopotential files for the elements. For example: {“H”: “/path/to/H.upf”, “O”: “/path/to/O.upf”}.
- element_mass:#
- type:
dict|NoneType, optional, default:Noneargument path:fp[fpop_abacus]/inputs_config/element_massSpecify the mass of some elements. For example: {“H”: 1.0079, “O”: 15.9994}.
- kpt_file:#
- type:
str|NoneType, optional, default:Noneargument path:fp[fpop_abacus]/inputs_config/kpt_fileThe KPT file, by default None.
- orb_files:#
- type:
dict|NoneType, optional, default:Noneargument path:fp[fpop_abacus]/inputs_config/orb_filesThe numerical orbital fiels for the elements, by default None. For example: {“H”: “/path/to/H.orb”, “O”: “/path/to/O.orb”}.
- deepks_descriptor:#
- type:
str|NoneType, optional, default:Noneargument path:fp[fpop_abacus]/inputs_config/deepks_descriptorThe deepks descriptor file, by default None.
- deepks_model:#
- type:
str|NoneType, optional, default:Noneargument path:fp[fpop_abacus]/inputs_config/deepks_modelThe deepks model file, by default None.
- run_config:#
- type:
dictargument path:fp[fpop_abacus]/run_configConfiguration for running vasp tasks
- command:#
- type:
str, optional, default:abacusargument path:fp[fpop_abacus]/run_config/commandThe command of abacus
- task_max:#
- type:
int, optional, default:10argument path:fp[fpop_abacus]/task_maxMaximum number of vasp tasks for each iteration
- extra_output_files:#
- type:
list, optional, default:[]argument path:fp[fpop_abacus]/extra_output_filesExtra output file names, support wildcards
When type is set to
fpop_cp2k:- inputs_config:#
- type:
dictargument path:fp[fpop_cp2k]/inputs_configConfiguration for preparing vasp inputs
- inp_file:#
- type:
strargument path:fp[fpop_cp2k]/inputs_config/inp_fileThe path to the user-submitted CP2K input file.
- run_config:#
- type:
dictargument path:fp[fpop_cp2k]/run_configConfiguration for running vasp tasks
- command:#
- type:
str, optional, default:cp2kargument path:fp[fpop_cp2k]/run_config/commandThe command of cp2k
- task_max:#
- type:
int, optional, default:10argument path:fp[fpop_cp2k]/task_maxMaximum number of vasp tasks for each iteration
- extra_output_files:#
- type:
list, optional, default:[]argument path:fp[fpop_cp2k]/extra_output_filesExtra output file names, support wildcards
- name:#
- type:
str, optional, default:dpgenargument path:nameThe workflow name, ‘dpgen’ for default
- parallelism:#
- type:
NoneType|int, 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
Task group definition#
LAMMPS task group#
- task_group:#
- type:
dictargument path:task_groupDepending on the value of type, different sub args are accepted.
- type:#
- type:
str(flag key)argument path:task_group/typethe type of the task group
lmp-md: Lammps MD tasks. DPGEN will generate the lammps input scriptlmp-template: Lammps MD tasks defined by templates. User provide lammps (and plumed) template for lammps tasks. The variables in templates are revised by the revisions key. Notice that the lines for pair style, dump and plumed are reserved for the revision of dpgen2, and the users should not write these lines by themselves. Rather, users notify dpgen2 the poistion of the line for pair_style by writting ‘pair_style deepmd’, the line for dump by writting ‘dump dpgen_dump’. If plumed is used, the line for fix plumed shouldbe written exactly as ‘fix dpgen_plm’.customized-lmp-template: Lammps MD tasks defined by user customized shell commands and templates. User provided shell script generates a series of folders, and each folder contains a lammps template task group.
When type is set to
lmp-md(or its aliaslmp-npt):Lammps MD tasks. DPGEN will generate the lammps input script
- conf_idx:#
- type:
list, alias: sys_idxargument path:task_group[lmp-md]/conf_idxThe configurations of configurations[conf_idx] will be used to generate the initial configurations of the tasks. This key provides the index of selected item in the configurations array.
- n_sample:#
- type:
NoneType|int, optional, default:Noneargument path:task_group[lmp-md]/n_sampleNumber of configurations. If this number is smaller than the number of configruations in configruations[conf_idx], then n_sample configruations are randomly sampled from configruations[conf_idx], otherwise all configruations in configruations[conf_idx] will be used. If not provided, all configruations in configruations[conf_idx] will be used.
- temps:#
- type:
list, alias: Tsargument path:task_group[lmp-md]/tempsA list of temperatures in K. Also used to initialize the temperature
- press:#
- type:
list, optional, alias: Psargument path:task_group[lmp-md]/pressA list of pressures in bar.
- ens:#
- type:
str, optional, default:nve, alias: ensembleargument path:task_group[lmp-md]/ensThe ensemble. Allowd options are ‘nve’, ‘nvt’, ‘npt’, ‘npt-a’, ‘npt-t’. ‘npt-a’ stands for anisotrpic box sampling and ‘npt-t’ stands for triclinic box sampling.
- dt:#
- type:
float, optional, default:0.001argument path:task_group[lmp-md]/dtThe time step
- nsteps:#
- type:
int, optional, default:100argument path:task_group[lmp-md]/nstepsThe number of steps
- trj_freq:#
- type:
int, optional, default:10, aliases: t_freq, trj_freq, traj_freqargument path:task_group[lmp-md]/trj_freqThe frequency of dumping configurations and thermodynamic states
- tau_t:#
- type:
float, optional, default:0.05argument path:task_group[lmp-md]/tau_tThe time scale of thermostat
- tau_p:#
- type:
float, optional, default:0.5argument path:task_group[lmp-md]/tau_pThe time scale of barostat
- pka_e:#
- type:
NoneType|float, optional, default:Noneargument path:task_group[lmp-md]/pka_eThe energy of primary knock-on atom
- neidelay:#
- type:
NoneType|int, optional, default:Noneargument path:task_group[lmp-md]/neidelayThe delay of updating the neighbor list
- no_pbc:#
- type:
bool, optional, default:Falseargument path:task_group[lmp-md]/no_pbcNot using the periodic boundary condition
- use_clusters:#
- type:
bool, optional, default:Falseargument path:task_group[lmp-md]/use_clustersCalculate atomic model deviation
- relative_f_epsilon:#
- type:
NoneType|float, optional, default:Noneargument path:task_group[lmp-md]/relative_f_epsilonCalculate relative force model deviation
- relative_v_epsilon:#
- type:
NoneType|float, optional, default:Noneargument path:task_group[lmp-md]/relative_v_epsilonCalculate relative virial model deviation
- ele_temp_f:#
- type:
NoneType|float, optional, default:Noneargument path:task_group[lmp-md]/ele_temp_fThe electron temperature set by frame style
- ele_temp_a:#
- type:
NoneType|float, optional, default:Noneargument path:task_group[lmp-md]/ele_temp_aThe electron temperature set by atomistic style
- pimd_bead:#
- type:
str|NoneType, optional, default:Noneargument path:task_group[lmp-md]/pimd_beadBead index for PIMD, None for non-PIMD
- input_extra_files:#
- type:
list, optional, default:[]argument path:task_group[lmp-md]/input_extra_filesExtra files that may be needed during exploration (e.g., ZBL parameter files)
When type is set to
lmp-template:Lammps MD tasks defined by templates. User provide lammps (and plumed) template for lammps tasks. The variables in templates are revised by the revisions key. Notice that the lines for pair style, dump and plumed are reserved for the revision of dpgen2, and the users should not write these lines by themselves. Rather, users notify dpgen2 the poistion of the line for pair_style by writting ‘pair_style deepmd’, the line for dump by writting ‘dump dpgen_dump’. If plumed is used, the line for fix plumed shouldbe written exactly as ‘fix dpgen_plm’.
- conf_idx:#
- type:
list, alias: sys_idxargument path:task_group[lmp-template]/conf_idxThe configurations of configurations[conf_idx] will be used to generate the initial configurations of the tasks. This key provides the index of selected item in the configurations array.
- n_sample:#
- type:
NoneType|int, optional, default:Noneargument path:task_group[lmp-template]/n_sampleNumber of configurations. If this number is smaller than the number of configruations in configruations[conf_idx], then n_sample configruations are randomly sampled from configruations[conf_idx], otherwise all configruations in configruations[conf_idx] will be used. If not provided, all configruations in configruations[conf_idx] will be used.
- lmp_template_fname:#
- type:
str, aliases: lmp_template, lmpargument path:task_group[lmp-template]/lmp_template_fnameThe file name of lammps input template
- plm_template_fname:#
- type:
str|NoneType, optional, default:None, aliases: plm_template, plmargument path:task_group[lmp-template]/plm_template_fnameThe file name of plumed input template
- revisions:#
- type:
dict, optional, default:{}argument path:task_group[lmp-template]/revisionsThe revisions. Should be a dict providing the key - list of desired values pair. Key is the word to be replaced in the templates, and it may appear in both the lammps and plumed input templates. All values in the value list will be enmerated.
- traj_freq:#
- type:
int, optional, default:10, aliases: t_freq, trj_freq, trj_freqargument path:task_group[lmp-template]/traj_freqThe frequency of dumping configurations and thermodynamic states
- extra_pair_style_args:#
- type:
str, optional, default: (empty string)argument path:task_group[lmp-template]/extra_pair_style_argsThe extra arguments for pair_style
- pimd_bead:#
- type:
str|NoneType, optional, default:Noneargument path:task_group[lmp-template]/pimd_beadBead index for PIMD, None for non-PIMD
- input_extra_files:#
- type:
list, optional, default:[]argument path:task_group[lmp-template]/input_extra_filesExtra files that may be needed during exploration (e.g., ZBL parameter files)
When type is set to
customized-lmp-template:Lammps MD tasks defined by user customized shell commands and templates. User provided shell script generates a series of folders, and each folder contains a lammps template task group.
- conf_idx:#
- type:
list, alias: sys_idxargument path:task_group[customized-lmp-template]/conf_idxThe configurations of configurations[conf_idx] will be used to generate the initial configurations of the tasks. This key provides the index of selected item in the configurations array.
- n_sample:#
- type:
NoneType|int, optional, default:Noneargument path:task_group[customized-lmp-template]/n_sampleNumber of configurations. If this number is smaller than the number of configruations in configruations[conf_idx], then n_sample configruations are randomly sampled from configruations[conf_idx], otherwise all configruations in configruations[conf_idx] will be used. If not provided, all configruations in configruations[conf_idx] will be used.
- custom_shell_commands:#
- type:
listargument path:task_group[customized-lmp-template]/custom_shell_commandsCustomized shell commands to be run for each configuration. The commands require input_lmp_conf_name as input conf file, input_lmp_tmpl_name and input_plm_tmpl_name as templates, and input_extra_files as extra input files. By running the commands a series folders in pattern output_dir_pattern are supposed to be generated, and each folder is supposed to contain a configuration file output_lmp_conf_name, a lammps template file output_lmp_tmpl_name and a plumed template file output_plm_tmpl_name.
- revisions:#
- type:
dict, optional, default:{}argument path:task_group[customized-lmp-template]/revisionsThe revisions. Should be a dict providing the key - list of desired values pair. Key is the word to be replaced in the templates, and it may appear in both the lammps and plumed input templates. All values in the value list will be enmerated.
- traj_freq:#
- type:
int, optional, default:10, aliases: t_freq, trj_freq, trj_freqargument path:task_group[customized-lmp-template]/traj_freqThe frequency of dumping configurations and thermodynamic states
- input_lmp_conf_name:#
- type:
str, optional, default:conf.lmpargument path:task_group[customized-lmp-template]/input_lmp_conf_nameInput conf file name for the shell commands.
- input_lmp_tmpl_name:#
- type:
str, optional, default:in.lammps, aliases: lmp_template, lmpargument path:task_group[customized-lmp-template]/input_lmp_tmpl_nameThe file name of lammps input template
- input_plm_tmpl_name:#
- type:
str|NoneType, optional, default:None, aliases: plm_template, plmargument path:task_group[customized-lmp-template]/input_plm_tmpl_nameThe file name of plumed input template
- input_extra_files:#
- type:
list, optional, default:[]argument path:task_group[customized-lmp-template]/input_extra_filesExtra files that may be needed to execute the shell commands
- output_dir_pattern:#
- type:
str|list, optional, default:*argument path:task_group[customized-lmp-template]/output_dir_patternPattern of resultant folders generated by the shell commands.
- output_lmp_conf_name:#
- type:
str, optional, default:conf.lmpargument path:task_group[customized-lmp-template]/output_lmp_conf_nameGenerated conf file name.
- output_lmp_tmpl_name:#
- type:
str, optional, default:in.lammpsargument path:task_group[customized-lmp-template]/output_lmp_tmpl_nameGenerated lmp input file name.
- output_plm_tmpl_name:#
- type:
str, optional, default:input.plumedargument path:task_group[customized-lmp-template]/output_plm_tmpl_nameGenerated plm input file name.
CALYPSO task group#
- task_group:
- type:
dictargument path:task_groupCALYPSO structure prediction tasks. DPGEN will generate the calypso input script
- numb_of_species:#
- type:
intargument path:task_group/numb_of_speciesnumber of species.
- name_of_atoms:#
- type:
listargument path:task_group/name_of_atomsname of atoms.
- atomic_number:#
- type:
list, optionalargument path:task_group/atomic_numberatomic number of each element.
- numb_of_atoms:#
- type:
listargument path:task_group/numb_of_atomsnumber of each atom.
- distance_of_ions:#
- type:
list|dict, optionalargument path:task_group/distance_of_ionsthe distance matrix between different elements.
- pop_size:#
- type:
int, optional, default:30argument path:task_group/pop_sizethe number of structures would be generated in each step.
- max_step:#
- type:
int, optional, default:5argument path:task_group/max_stepthe max iteration number of CALYPSO loop.
- system_name:#
- type:
str, optional, default:CALYPSOargument path:task_group/system_namesystem name.
- numb_of_formula:#
- type:
list, optional, default:[1, 1]argument path:task_group/numb_of_formulathe formula range of simulation cell.
- pressure:#
- type:
float, optional, default:0.001argument path:task_group/pressurethe aim pressure (in Kbar) when using MLP to optimize structures.
- fmax:#
- type:
float, optional, default:0.01argument path:task_group/fmaxthe converge criterion. The force on all individual atoms should be less than fmax.
- opt_step:#
- type:
float, optional, default:1000argument path:task_group/opt_stepthe converge criterion. The force on all individual atoms should be less than fmax.
- volume:#
- type:
float, optional, default:0argument path:task_group/volumethe volume of simulation cell in one formula.
- ialgo:#
- type:
int, optional, default:2argument path:task_group/ialgothe evolution algorithm of CALYPSO. 1: global pso, 2: local pso, 3: sabc.
- pso_ratio:#
- type:
float, optional, default:0.6argument path:task_group/pso_ratiothe ratio of structures generated by evolution algorithm in one step.
- icode:#
- type:
int, optional, default:15argument path:task_group/icodethe software of structure optimization. 1: VASP, 15: DP.
- numb_of_lbest:#
- type:
int, optional, default:4argument path:task_group/numb_of_lbestthe number of evolution direction when using LPSO.
- numb_of_local_optim:#
- type:
int, optional, default:3argument path:task_group/numb_of_local_optimthe number of making structure optimization when using dft.
- command:#
- type:
str, optional, default:sh submit.shargument path:task_group/commandthe command of running structure optimization.
- max_time:#
- type:
int, optional, default:9000argument path:task_group/max_timethe max time (in second) of structure optimization.
- pick_up:#
- type:
bool, optional, default:Falseargument path:task_group/pick_upwhether to continue the calculation.
- pick_step:#
- type:
int, optional, default:0argument path:task_group/pick_stepfrom which step to continue the calculation.
- parallel:#
- type:
bool, optional, default:Falseargument path:task_group/parallelwhether to run calypso in parallel.
- split:#
- type:
bool, optional, default:Trueargument path:task_group/splitsperate generating structures and structure optimizations. in dpgen2, split must be True.
- spec_space_group:#
- type:
list, optional, default:[2, 230]argument path:task_group/spec_space_groupthe range of spacegroup.
- vsc:#
- type:
bool, optional, default:Falseargument path:task_group/vscwhether to run calypso in variational stoichiometry way.
- ctrl_range:#
- type:
list, optional, default:[[1, 10]]argument path:task_group/ctrl_rangethe atom range of each atoms.
- max_numb_atoms:#
- type:
int, optional, default:100argument path:task_group/max_numb_atomsthe max number of atoms.