Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
On this page

Show all

Parameter Overview

Updated on 2024-08-14 GMT+08:00

You can use JobStep to create a job phase. The following is an example of defining a JobStep.

Table 1 JobStep

Parameter

Description

Mandatory

Data Type

name

Name of a job phase. The name contains a maximum of 64 characters, including only letters, digits, underscores (_), and hyphens (-). It must start with a letter and must be unique in a workflow.

Yes

str

algorithm

Algorithm object

Yes

BaseAlgorithm, Algorithm, AIGalleryAlgorithm

spec

Job specifications

Yes

JobSpec

inputs

Inputs of a job phase

Yes

JobInput or JobInput list

outputs

Outputs of a job phase

Yes

JobOutput or JobOutput list

title

Title for frontend display

No

str

description

Description of a job phase

No

str

policy

Phase execution policy

No

StepPolicy

depend_steps

Dependency phases

No

Step or step list

Table 2 JobInput

Parameter

Description

Mandatory

Data Type

name

Input name of the job phase. The name can contain a maximum of 64 characters, including only letters, digits, underscores (_), and hyphens (-), and must start with a letter. The input name of a step must be unique.

Yes

str

data

Input data object of a job phase

Yes

Dataset or OBS object. Currently, only Dataset, DatasetPlaceholder, DatasetConsumption, OBSPath, OBSConsumption, OBSPlaceholder, and DataConsumptionSelector are supported.

Table 3 JobOutput

Parameter

Description

Mandatory

Data Type

name

Output name of the job phase. The name can contain a maximum of 64 characters, including only letters, digits, underscores (_), and hyphens (-), and must start with a letter. The output name of a step must be unique.

Yes

str

obs_config

OBS output configuration

No

OBSOutputConfig

model_config

Model output configuration

No

ModelConfig

metrics_config

Metrics configuration

No

MetricsConfig

Table 4 OBSOutputConfig

Parameter

Description

Mandatory

Data Type

obs_path

Existing OBS directory

Yes

str, Placeholder, Storage

metric_file

Name of the file that stores metric information

No

str, Placeholder

Table 5 BaseAlgorithm

Parameter

Description

Mandatory

Data Type

id

Algorithm ID

No

str

subscription_id

Subscription ID of the subscribed algorithm

No

str

item_version_id

Version ID of the subscribed algorithm

No

str

code_dir

Code directory

No

str, Placeholder, Storage

boot_file

Boot file

No

str, Placeholder, Storage

command

Boot command

No

str, Placeholder

parameters

Algorithm hyperparameters

No

AlgorithmParameters list

engine

Information about the image used by the job

No

JobEngine

environments

Environment variables

No

dict

Table 6 Algorithm

Parameter

Description

Mandatory

Data Type

algorithm_id

Algorithm ID

Yes

str

parameters

Algorithm hyperparameters

No

AlgorithmParameters list

Table 7 AIGalleryAlgorithm

Parameter

Description

Mandatory

Data Type

subscription_id

Subscription ID of the subscribed algorithm

Yes

str

item_version_id

Version ID of the subscribed algorithm

Yes

str

parameters

Algorithm hyperparameters

No

AlgorithmParameters list

Table 8 AlgorithmParameters

Parameter

Description

Mandatory

Data Type

name

Name of an algorithm hyperparameter

Yes

str

value

Value of an algorithm hyperparameter

Yes

int, bool, float, str, Placeholder, Storage

Table 9 JobEngine

Parameter

Description

Mandatory

Data Type

engine_id

Image ID

No

str, Placeholder

engine_name

Image name

No

str, Placeholder

engine_version

Image version

No

str, Placeholder

image_url

Image URL

No

str, Placeholder

Table 10 JobSpec

Parameter

Description

Mandatory

Data Type

resource

Resource

Yes

JobResource

log_export_path

Log output path

No

LogExportPath

schedule_policy

Job scheduling policy

No

SchedulePolicy

volumes

Information about the file system mounted to the job

No

list[Volume]

Table 11 JobResource

Parameter

Description

Mandatory

Data Type

flavor

Resource specifications

Yes

Placeholder

node_count

Number of nodes. The default value is 1. If there are multiple nodes, distributed training is supported.

No

int, Placeholder

Table 12 SchedulePolicy

Parameter

Description

Mandatory

Data Type

priority

Job scheduling priority. The value can only be 1, 2, or 3, indicating low, medium, and high priorities, respectively.

Yes

int, Placeholder

Table 13 Volume

Parameter

Description

Mandatory

Data Type

nfs

NFS file system object

No

NFS

pfs

OBS parallel file system object. In a volume object, either PFS or NFS can be specified.

No

PFS, Placeholder

Table 14 NFS

Parameter

Description

Mandatory

Data Type

nfs_server_path

Service address of the NFS file system.

Yes

str, Placeholder

local_path

Path mounted to the container.

Yes

str, Placeholder

read_only

Indicates if the mount mode is set to read-only.

No

bool, Placeholder

Table 15 PFS

Parameter

Description

Mandatory

Data Type

pfs_path

Path of the parallel file system

Yes

str, Placeholder

local_path

Path mounted to the container.

Yes

str, Placeholder

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback