Skip to content

JobProps

Properties for defining a Job.

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

Initializer 

import com.aliyun.ros.cdk.paidlc.JobProps;
JobProps.builder()
    .displayName(java.lang.String)
    .displayName(IResolvable)
    .jobSpecs(IResolvable)
    .jobSpecs(java.util.List<IResolvable)
    .jobSpecs(JobSpecsProperty>)
    .jobType(java.lang.String)
    .jobType(IResolvable)
    .userCommand(java.lang.String)
    .userCommand(IResolvable)
    .workspaceId(java.lang.String)
    .workspaceId(IResolvable)
//  .codeSource(IResolvable)
//  .codeSource(CodeSourceProperty)
//  .dataSources(IResolvable)
//  .dataSources(java.util.List<IResolvable)
//  .dataSources(DataSourcesProperty>)
//  .envs(java.lang.String)
//  .envs(IResolvable)
//  .jobMaxRunningTimeMinutes(java.lang.Number)
//  .jobMaxRunningTimeMinutes(IResolvable)
//  .options(java.lang.String)
//  .options(IResolvable)
//  .priority(java.lang.Number)
//  .priority(IResolvable)
//  .resourceId(java.lang.String)
//  .resourceId(IResolvable)
//  .settings(IResolvable)
//  .settings(java.util.Map<java.lang.String, java.lang.Object>)
//  .successPolicy(java.lang.String)
//  .successPolicy(IResolvable)
//  .thirdpartyLibDir(java.lang.String)
//  .thirdpartyLibDir(IResolvable)
//  .thirdpartyLibs(IResolvable)
//  .thirdpartyLibs(java.util.List<java.lang.String)
//  .thirdpartyLibs(IResolvable>)
//  .userVpc(IResolvable)
//  .userVpc(UserVpcProperty)
    .build();

Properties

Name Type Description
displayName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property displayName: The name of the task is as follows: The name length does not exceed 256 characters.
jobSpecs com.aliyun.ros.cdk.core.IResolvable OR java.util.ListJobSpecsProperty> 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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property jobType: The type of job.
userCommand java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property userCommand: Start commands of all nodes in the task.
workspaceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property workspaceId: Work space ID, how to get working space ID, see listworkSpaces.
codeSource com.aliyun.ros.cdk.core.IResolvable OR 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 com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDataSourcesProperty> Property dataSources: List of data source used for task operation.
envs java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property envs: Environment variable configuration.
jobMaxRunningTimeMinutes java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property jobMaxRunningTimeMinutes: The longest running time is running, and the unit is minutes.
options java.lang.String OR com.aliyun.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 java.lang.Number OR com.aliyun.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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceId: Resource group ID, optional parameter.
settings com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property settings: Job settings.
successPolicy java.lang.String OR com.aliyun.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 java.lang.String OR com.aliyun.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 com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property thirdpartyLibs: Python third-party library list to be installed.
userVpc com.aliyun.ros.cdk.core.IResolvable OR UserVpcProperty Property userVpc: User VPC configuration.

displayNameRequired 

public java.lang.Object getDisplayName();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getJobSpecs();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListJobSpecsProperty>

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 java.lang.Object getJobType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property jobType: The type of job.

Values: TFJob, PyTorchJob, XGBoostJob, OneFlowJob, ElasticBatch

userCommandRequired 

public java.lang.Object getUserCommand();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

workspaceIdRequired 

public java.lang.Object getWorkspaceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

codeSourceOptional 

public java.lang.Object getCodeSource();

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 java.lang.Object getDataSources();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDataSourcesProperty>

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

envsOptional 

public java.lang.Object getEnvs();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property envs: Environment variable configuration.

jobMaxRunningTimeMinutesOptional 

public java.lang.Object getJobMaxRunningTimeMinutes();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

optionsOptional 

public java.lang.Object getOptions();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getPriority();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getResourceId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSettings();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property settings: Job settings.

successPolicyOptional 

public java.lang.Object getSuccessPolicy();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getThirdpartyLibDir();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getThirdpartyLibs();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

userVpcOptional 

public java.lang.Object getUserVpc();

Property userVpc: User VPC configuration.