Step Configs

Configurations for dflow steps

executor:
type: dict | NoneType, optional, default: None
argument path: executor

The executor of the step.

Depending on the value of type, different sub args are accepted.

type:
type: str (flag key)
argument path: executor/type
possible choices: lebesgue_v2

The type of the executor.

When type is set to lebesgue_v2:

extra:
type: dict, optional
argument path: executor[lebesgue_v2]/extra

The ‘extra’ key in the lebesgue executor. Note that we do not check if ‘the dict provided to the ‘extra’ key is valid or not.

scass_type:
type: str, optional
argument path: executor[lebesgue_v2]/extra/scass_type

The machine configuraiton.

program_id:
type: str, optional
argument path: executor[lebesgue_v2]/extra/program_id

The ID of the program.

job_type:
type: str, optional, default: container
argument path: executor[lebesgue_v2]/extra/job_type

The type of job.

template_cover_cmd_escape_bug:
type: bool, optional, default: True
argument path: executor[lebesgue_v2]/extra/template_cover_cmd_escape_bug

The key for hacking around a bug in Lebesgue.

parallelism:
type: int | NoneType, optional, default: None
argument path: parallelism

The parallelism for the step

continue_on_success_ratio:
type: NoneType | float, optional, default: None
argument path: continue_on_success_ratio

Only in the sliced OP case. Continue the workflow if a certain ratio of the sliced jobs are successful.

continue_on_num_success:
type: int | NoneType, optional, default: None
argument path: continue_on_num_success

Only in the sliced OP case. Continue the workflow if a certain number of the sliced jobs are successful.

continue_on_failed:
type: bool, optional, default: False
argument path: continue_on_failed

If continue the the step is failed (FatalError, TransientError, A certain number of retrial is reached…).

template_config:
type: dict, optional, default: {'image': 'dptechnology/dpgen2:latest'}
argument path: template_config

The configs passed to the PythonOPTemplate.

image:
type: str, optional, default: dptechnology/dpgen2:latest
argument path: template_config/image

The image to run the step.

timeout:
type: int | NoneType, optional, default: None
argument path: template_config/timeout

The time limit of the OP. Unit is second.

retry_on_transient_error:
type: NoneType | bool, optional, default: None
argument path: template_config/retry_on_transient_error

Retry the step if a TransientError is raised.

timeout_as_transient_error:
type: bool, optional, default: False
argument path: template_config/timeout_as_transient_error

Treat the timeout as TransientError.

envs:
type: dict | NoneType, optional, default: None
argument path: template_config/envs

The environmental variables.