Skip to content

JobProps

Properties for defining a Job.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-paidlc-job

Initializer 

import ros_cdk_paidlc
ros_cdk_paidlc.JobProps(
  display_name: typing.Union[str, IResolvable],
  job_specs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, JobSpecsProperty]]],
  job_type: typing.Union[str, IResolvable],
  user_command: typing.Union[str, IResolvable],
  workspace_id: typing.Union[str, IResolvable],
  code_source: typing.Union[IResolvable, CodeSourceProperty] = None,
  data_sources: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DataSourcesProperty]]] = None,
  envs: typing.Union[str, IResolvable] = None,
  job_max_running_time_minutes: typing.Union[typing.Union[int, float], IResolvable] = None,
  options: typing.Union[str, IResolvable] = None,
  priority: typing.Union[typing.Union[int, float], IResolvable] = None,
  resource_id: typing.Union[str, IResolvable] = None,
  settings: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  success_policy: typing.Union[str, IResolvable] = None,
  thirdparty_lib_dir: typing.Union[str, IResolvable] = None,
  thirdparty_libs: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  user_vpc: typing.Union[IResolvable, UserVpcProperty] = None
)

Properties

Name Type Description
display_name typing.Union[str, ros_cdk_core.IResolvable] Property displayName: The name of the task is as follows: The name length does not exceed 256 characters.
job_specs typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, JobSpecsProperty]]] Property jobSpecs: Jobspecs describes various configurations of tasks during the mission, such as mirror address, start command, node resource statement, number of copies, etc.
job_type typing.Union[str, ros_cdk_core.IResolvable] Property jobType: The type of job.
user_command typing.Union[str, ros_cdk_core.IResolvable] Property userCommand: Start commands of all nodes in the task.
workspace_id typing.Union[str, ros_cdk_core.IResolvable] Property workspaceId: Work space ID, how to get working space ID, see listworkSpaces.
code_source typing.Union[ros_cdk_core.IResolvable, CodeSourceProperty] Property codeSource: The code source used in this task.Before the mission node starts, the DLC will automatically download the code configured in the code source, and mount to the local directory of the container.
data_sources typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DataSourcesProperty]]] Property dataSources: List of data source used for task operation.
envs typing.Union[str, ros_cdk_core.IResolvable] Property envs: Environment variable configuration.
job_max_running_time_minutes typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property jobMaxRunningTimeMinutes: The longest running time is running, and the unit is minutes.
options typing.Union[str, ros_cdk_core.IResolvable] Property options: The additional configuration of this task can adjust some of the behavior of the mounting data source through this parameter.If the task has a data source that mounted the OSS type, you can cover the default parameters of the jinofs by configure the configuration of this parameter to fs.OSS.DOWNLOAD.CONCURRENCY = 4, fs.oss.download.queue.size = 16.
priority typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property priority: The priority of the task, optional parameter, default value 1, the range of parameter values is 1 ~ 9.in: 1 is the minimum priority. 9 is the highest priority.
resource_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceId: Resource group ID, optional parameter.
settings typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property settings: Job settings.
success_policy typing.Union[str, ros_cdk_core.IResolvable] Property successPolicy: The successful strategy of distributed multi -machine tasks is currently only supported by TensorFlow's multi -machine task.
thirdparty_lib_dir typing.Union[str, ros_cdk_core.IResolvable] Property thirdpartyLibDir: The name folder of the Requirements.txt file is located; before each node runs the specified usercommand, PAI -DLC will take the requirements.txt file from the specified folder and call the PIP Install -R installation.
thirdparty_libs typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property thirdpartyLibs: Python third-party library list to be installed.
user_vpc typing.Union[ros_cdk_core.IResolvable, UserVpcProperty] Property userVpc: User VPC configuration.

display_nameRequired 

display_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property displayName: The name of the task is as follows: The name length does not exceed 256 characters.

Allow numbers, letters, lower strokes (_), English period (.) And short horizontal lines (-).

job_specsRequired 

job_specs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, JobSpecsProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, JobSpecsProperty]]]

Property jobSpecs: Jobspecs describes various configurations of tasks during the mission, such as mirror address, start command, node resource statement, number of copies, etc.

The DLC task consists of different types of nodes. The same type of nodes have exactly the same configuration. This configuration is called a Jobspec. Jobspecs describes the configuration of all types of nodes and is the array of Jobspec.

job_typeRequired 

job_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property jobType: The type of job.

Values: TFJob, PyTorchJob, XGBoostJob, OneFlowJob, ElasticBatch

user_commandRequired 

user_command: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property userCommand: Start commands of all nodes in the task.

workspace_idRequired 

workspace_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property workspaceId: Work space ID, how to get working space ID, see listworkSpaces.

code_sourceOptional 

code_source: typing.Union[IResolvable, CodeSourceProperty]

Property codeSource: The code source used in this task.Before the mission node starts, the DLC will automatically download the code configured in the code source, and mount to the local directory of the container.

data_sourcesOptional 

data_sources: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DataSourcesProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DataSourcesProperty]]]

Property dataSources: List of data source used for task operation.

envsOptional 

envs: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property envs: Environment variable configuration.

job_max_running_time_minutesOptional 

job_max_running_time_minutes: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property jobMaxRunningTimeMinutes: The longest running time is running, and the unit is minutes.

optionsOptional 

options: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property options: The additional configuration of this task can adjust some of the behavior of the mounting data source through this parameter.If the task has a data source that mounted the OSS type, you can cover the default parameters of the jinofs by configure the configuration of this parameter to fs.OSS.DOWNLOAD.CONCURRENCY = 4, fs.oss.download.queue.size = 16.

priorityOptional 

priority: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property priority: The priority of the task, optional parameter, default value 1, the range of parameter values is 1 ~ 9.in: 1 is the minimum priority. 9 is the highest priority.

resource_idOptional 

resource_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceId: Resource group ID, optional parameter.

The parameter value is empty indicating that submitted to the public resource group. If the current working space has been bound to a proprietary resource group, you can specify the corresponding resource group ID here; how to create a proprietary resource group and inquire about the proprietary resource group ID, please refer to the preparation and management of the DLC resource group cluster.

settingsOptional 

settings: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property settings: Job settings.

success_policyOptional 

success_policy: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property successPolicy: The successful strategy of distributed multi -machine tasks is currently only supported by TensorFlow's multi -machine task.

ChiefWorker: When it is specified as this value, as long as the Chief's POD is successful, it is considered that the entire task is successful. All workers: All workers must be successful to think that the entire task is successful.

thirdparty_lib_dirOptional 

thirdparty_lib_dir: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property thirdpartyLibDir: The name folder of the Requirements.txt file is located; before each node runs the specified usercommand, PAI -DLC will take the requirements.txt file from the specified folder and call the PIP Install -R installation.

thirdparty_libsOptional 

thirdparty_libs: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property thirdpartyLibs: Python third-party library list to be installed.

user_vpcOptional 

user_vpc: typing.Union[IResolvable, UserVpcProperty]

Property userVpc: User VPC configuration.