Skip to content

JobProps

Properties for defining a Job.

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

Initializer 

import { JobProps } from '@alicloud/ros-cdk-paidlc'
const jobProps: JobProps = { ... }

Properties

Name Type Description
displayName string | @alicloud/ros-cdk-core.IResolvable Property displayName: The name of the task is as follows: The name length does not exceed 256 characters.
jobSpecs @alicloud/ros-cdk-core.IResolvable | @alicloud/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.
jobType string | @alicloud/ros-cdk-core.IResolvable Property jobType: The type of job.
userCommand string | @alicloud/ros-cdk-core.IResolvable Property userCommand: Start commands of all nodes in the task.
workspaceId string | @alicloud/ros-cdk-core.IResolvable Property workspaceId: Work space ID, how to get working space ID, see listworkSpaces.
codeSource @alicloud/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.
dataSources @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DataSourcesProperty[] Property dataSources: List of data source used for task operation.
envs string | @alicloud/ros-cdk-core.IResolvable Property envs: Environment variable configuration.
jobMaxRunningTimeMinutes number | @alicloud/ros-cdk-core.IResolvable Property jobMaxRunningTimeMinutes: The longest running time is running, and the unit is minutes.
options string | @alicloud/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 number | @alicloud/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.
resourceId string | @alicloud/ros-cdk-core.IResolvable Property resourceId: Resource group ID, optional parameter.
settings @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property settings: Job settings.
successPolicy string | @alicloud/ros-cdk-core.IResolvable Property successPolicy: The successful strategy of distributed multi -machine tasks is currently only supported by TensorFlow's multi -machine task.
thirdpartyLibDir string | @alicloud/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.
thirdpartyLibs @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property thirdpartyLibs: Python third-party library list to be installed.
userVpc @alicloud/ros-cdk-core.IResolvable | UserVpcProperty Property userVpc: User VPC configuration.

displayNameRequired 

public readonly displayName: string | IResolvable;
  • Type: string | @alicloud/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 (-).

jobSpecsRequired 

public readonly jobSpecs: IResolvable | IResolvable | JobSpecsProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/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.

jobTypeRequired 

public readonly jobType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property jobType: The type of job.

Values: TFJob, PyTorchJob, XGBoostJob, OneFlowJob, ElasticBatch

userCommandRequired 

public readonly userCommand: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

workspaceIdRequired 

public readonly workspaceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

codeSourceOptional 

public readonly codeSource: 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.

dataSourcesOptional 

public readonly dataSources: IResolvable | IResolvable | DataSourcesProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DataSourcesProperty[]

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

envsOptional 

public readonly envs: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property envs: Environment variable configuration.

jobMaxRunningTimeMinutesOptional 

public readonly jobMaxRunningTimeMinutes: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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

optionsOptional 

public readonly options: string | IResolvable;
  • Type: string | @alicloud/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 

public readonly priority: number | IResolvable;
  • Type: number | @alicloud/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.

resourceIdOptional 

public readonly resourceId: string | IResolvable;
  • Type: string | @alicloud/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 

public readonly settings: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property settings: Job settings.

successPolicyOptional 

public readonly successPolicy: string | IResolvable;
  • Type: string | @alicloud/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.

thirdpartyLibDirOptional 

public readonly thirdpartyLibDir: string | IResolvable;
  • Type: string | @alicloud/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.

thirdpartyLibsOptional 

public readonly thirdpartyLibs: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

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

userVpcOptional 

public readonly userVpc: IResolvable | UserVpcProperty;

Property userVpc: User VPC configuration.