Creating an Image Classification Dataset{
+Example Requests
- Creating an Image Classification Dataset
{
"workspace_id" : "0",
"dataset_name" : "dataset-457f",
"dataset_type" : 0,
@@ -1022,7 +1021,7 @@
}
} ]
}
- - Creating an Object Detection Dataset
{
+ - Creating an Object Detection Dataset
{
"workspace_id" : "0",
"dataset_name" : "dataset-95a6",
"dataset_type" : 1,
@@ -1047,7 +1046,7 @@
}
} ]
}
- - Creating a Table Dataset
{
+ - Creating a Table Dataset
{
"workspace_id" : "0",
"dataset_name" : "dataset-de83",
"dataset_type" : 400,
@@ -1084,44 +1083,44 @@
}
Example Responses
Status code: 201
-
Created
-
{
+Example Responses
Status code: 201
+
Created
+
{
"dataset_id" : "WxCREuCkBSAlQr9xrde"
}
Status Codes
-
Status Code
+Status Codes
+ Status Code
|
-Description
+ | Description
|
|---|
-201
+ | 201
|
-Created
+ | Created
|
-401
+ | 401
|
-Unauthorized
+ | Unauthorized
|
-403
+ | 403
|
-Forbidden
+ | Forbidden
|
-404
+ | 404
|
-Not Found
+ | Not Found
|
diff --git a/docs/modelarts/api-ref/CreateDatasetVersion.html b/docs/modelarts/api-ref/CreateDatasetVersion.html
index 0289102d..b15fad12 100644
--- a/docs/modelarts/api-ref/CreateDatasetVersion.html
+++ b/docs/modelarts/api-ref/CreateDatasetVersion.html
@@ -1,7 +1,7 @@
Creating a Dataset Labeling Version
- FunctionThis API is used to create a dataset labeling version.
+ FunctionThis API is used to create a dataset labeling version.
URIPOST /v2/{project_id}/datasets/{dataset_id}/versions
diff --git a/docs/modelarts/api-ref/CreateLabels.html b/docs/modelarts/api-ref/CreateLabels.html
index 98b58a86..258eaee7 100644
--- a/docs/modelarts/api-ref/CreateLabels.html
+++ b/docs/modelarts/api-ref/CreateLabels.html
@@ -1,7 +1,7 @@
Creating a Dataset Label
- FunctionThis API is used to create a dataset label.
+ FunctionThis API is used to create a dataset label.
URIPOST /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels
@@ -426,7 +426,7 @@
diff --git a/docs/modelarts/api-ref/modelarts_03_0412.html b/docs/modelarts/api-ref/CreateModelArtsAgency.html
similarity index 87%
rename from docs/modelarts/api-ref/modelarts_03_0412.html
rename to docs/modelarts/api-ref/CreateModelArtsAgency.html
index 4a2add09..7bd069c4 100644
--- a/docs/modelarts/api-ref/modelarts_03_0412.html
+++ b/docs/modelarts/api-ref/CreateModelArtsAgency.html
@@ -1,7 +1,7 @@
-
+
Creating a ModelArts Agency
- FunctionThis API is used to create a ModelArts agency for dependent services such as OBS, SWR, and IEF.
+ FunctionThis API is used to create a ModelArts agency for dependent services such as OBS, SWR, and IEF.
URIPOST /v2/{project_id}/agency
@@ -29,7 +29,7 @@
Request Parameters
- Table 2 Request body parametersParameter
+Table 2 Request body parametersParameter
|
Mandatory
|
@@ -72,7 +72,7 @@
}
Status Codes
- Status Code
+Status Code
|
Description
|
@@ -112,7 +112,7 @@
diff --git a/docs/modelarts/api-ref/CreateNotebook.html b/docs/modelarts/api-ref/CreateNotebook.html
new file mode 100644
index 00000000..c76bdb54
--- /dev/null
+++ b/docs/modelarts/api-ref/CreateNotebook.html
@@ -0,0 +1,685 @@
+
+
+Creating a Notebook Instance
+FunctionThis API is used to create a notebook instance based on the specified flavor, AI engine images, and storage. You can access the instance through a web page or SSH client. \r\n Calling this API is an asynchronous operation. The notebook instance status can be obtained by calling the API for querying the details about this instance.
+
+
+ URIPOST /v1/{project_id}/notebooks
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID.
+ |
+
+
+
+
+
+ Request Parameters
+ Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+description
+ |
+No
+ |
+String
+ |
+Instance description. The value can contain a maximum of 512 characters and cannot contain the following special characters: &<>"'/. By default, this parameter is left blank.
+ |
+
+duration
+ |
+No
+ |
+Long
+ |
+Running duration calculated from the current time, in milliseconds. The instance automatically stops when the duration expires.
+ |
+
+endpoints
+ |
+No
+ |
+Array of EndpointsReq objects
+ |
+Local IDE (such as PyCharm and vsCode) or SSH client for remotely accessing a notebook instance through SSH.
+ |
+
+feature
+ |
+No
+ |
+String
+ |
+Instance type. The default value is NOTEBOOK. Options: - DEFAULT: free CodeLab instance. You can create only one. - NOTEBOOK: billed instance.
+ |
+
+flavor
+ |
+Yes
+ |
+String
+ |
+Instance flavor. Currently, the following flavors are supported: \r\n-modelarts.vm.cpu.2u: General-purpose Intel CPU flavors, ideal for rapid data exploration and tests. \r\n- modelarts.vm.cpu.8u: General computing-plus Intel CPU flavors, ideal for compute-intensive applications. \r\n- modelarts.bm.gpu.v100NV32: One NVIDIA V100 GPU with 32 GB of memory, ideal for training and debugging deep learning algorithms. \r\n- modelarts.bm.d910.xlarge.1: One Arm-powered Ascend 910 processor with 32 GB of GPU memory, ideal for training and debugging deep learning models. \r\n- modelarts.bm.d910.xlarge.2: Two Arm-powered Ascend 910 processors, each with 32 GB of GPU memory, ideal for training and debugging deep learning models. \r\n- modelarts.bm.d910.xlarge.8: Eight Arm-powered Ascend 910 processors, each with 32 GB of GPU memory, ideal for training and debugging deep learning algorithms. \r\n\r\n The preceding flavors are for reference only. The flavors available in specific regions are displayed on the console.
+ |
+
+image_id
+ |
+Yes
+ |
+String
+ |
+ID of the image used for creating notebook instances. The ID is in Universally Unique Identifier (UUID) format. \r\n For details, see Querying Supported Images.
+ |
+
+name
+ |
+Yes
+ |
+String
+ |
+Instance name, which contains a maximum of 64 characters that can be duplicate. The name can contain uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_).
+ |
+
+pool_id
+ |
+No
+ |
+String
+ |
+ID of a dedicated resource pool, for example, pool41664192. This parameter is mandatory if a dedicated resource pool needs to be specified for creating an instance.
+ |
+
+volume
+ |
+Yes
+ |
+VolumeReq object
+ |
+Storage volume.
+ |
+
+workspace_id
+ |
+No
+ |
+String
+ |
+Workspace ID. If no workspaces are available, the default value is 0.
+ |
+
+
+
+
+
+ Table 3 EndpointsReqParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+allowed_access_ips
+ |
+No
+ |
+Array of strings
+ |
+Public IP addresses that can remotely access the notebook instance. A maximum of five public IP addresses are supported.
+ |
+
+dev_service
+ |
+No
+ |
+String
+ |
+Supported services. Options: - NOTEBOOK: You can access the notebook instance using HTTPS.- SSH: You can remotely access the notebook instance through SSH.
+ |
+
+ssh_keys
+ |
+No
+ |
+Array of strings
+ |
+Name of the SSH key pair, which can be created and viewed on the Key Pair page of the Elastic Cloud Server (ECS) console.
+ |
+
+
+
+
+
+ Table 4 VolumeReqParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+capacity
+ |
+No
+ |
+Integer
+ |
+Storage capacity. The default value is 5 GB for EVS and 50 GB for EFS. The maximum value is 4,096 GB.
+ |
+
+category
+ |
+Yes
+ |
+String
+ |
+Storage category. Options: \r\n-EFS: Scalable File Service (SFS), which is the default storage. \r\n-EVS: Elastic Volume Service (EVS). \r\n\r\n For details about the differences between the two types of storage, see Selecting a Storage Type in DevEnviron.\r\n.\r\n\r\n\r\n\r\n
+ |
+
+ownership
+ |
+Yes
+ |
+String
+ |
+Owner to which the resource belongs. Options: - MANAGED: Resources are managed by services.- DEDICATED: Resources are managed by the user account. This mode is supported only when the instance category is EFS.
+ |
+
+uri
+ |
+No
+ |
+String
+ |
+URI of the EFS. This parameter is mandatory only when the instance category is EFS and ownership is DEDICATED. An example URI is 192.168.0.1:/user-9sfdsdgdfgh5ea4d56871e75d6966aa274/mount/.
+ |
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 5 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+action_progress
+ |
+Array of JobProgress objects
+ |
+Instance initialization progress.
+ |
+
+description
+ |
+String
+ |
+Instance description
+ |
+
+endpoints
+ |
+Array of EndpointsRes objects
+ |
+Local IDE (such as PyCharm and vsCode) or SSH client for remotely accessing a notebook instance through SSH.
+ |
+
+fail_reason
+ |
+String
+ |
+Instance failure cause
+ |
+
+feature
+ |
+String
+ |
+Instance type. Options: - DEFAULT: free CodeLab instance. You can create only one. - NOTEBOOK: billed instance.
+ |
+
+flavor
+ |
+String
+ |
+Instance flavor
+ |
+
+id
+ |
+String
+ |
+Instance ID.
+ |
+
+image
+ |
+Image object
+ |
+Instance image
+ |
+
+lease
+ |
+Lease object
+ |
+Countdown to automatic instance stop.
+ |
+
+name
+ |
+String
+ |
+Instance name
+ |
+
+pool
+ |
+Pool object
+ |
+Basic information about the dedicated pool, which is returned by the instance created in the dedicated pool.
+ |
+
+status
+ |
+String
+ |
+Instance status Options: \r\n-INIT: The instance is being initialized. \r\n-CREATING: The instance is being created. \r\n-STARTING: The instance is starting. \r\n-STOPPING: The instance is stopping. \r\n-DELETING: The instance is being deleted.\r\n-RUNNING: The instance is running.\r\n-STOPPED: The instance is stopped.\r\n-SNAPSHOTTING: A snapshot is being taken for the instance (status when the image is being saved).\r\n-CREATE_FAILED: The instance fails to be created. \r\n-START_FAILED: The instance fails to be started. \r\n-DELETE_FAILED: The instance fails to be deleted.\r\n-ERROR: An error occurs. \r\n-DELETED: The instance is deleted. \r\n-FROZEN: The instance is frozen.
+ |
+
+token
+ |
+String
+ |
+Token used for notebook authentication
+ |
+
+url
+ |
+String
+ |
+URL for accessing the notebook instance
+ |
+
+volume
+ |
+VolumeRes object
+ |
+Storage volume
+ |
+
+workspace_id
+ |
+String
+ |
+Workspace ID. If no workspaces are available, the default value is 0.
+ |
+
+
+
+
+
+ Table 6 JobProgressParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+notebook_id
+ |
+String
+ |
+Instance ID.
+ |
+
+status
+ |
+String
+ |
+Job status in a specified step. Options: - WAITING: The job is waiting to begin. - PROCESSING: The job is being processed. - FAILED: The job failed. - COMPLETED: The task is complete.
+ |
+
+step
+ |
+Integer
+ |
+Job step. Options: - 1: Storage preparation. - 2: Computing resource preparation. - 3: Network configurations. - 4: Instance initialization.
+ |
+
+step_description
+ |
+String
+ |
+Description of a step in a job.
+ |
+
+
+
+
+
+ Table 7 EndpointsResParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+allowed_access_ips
+ |
+Array of strings
+ |
+Whitelist of public IP addresses that are allowed to access the notebook instance through SSH. By default, all public IP addresses can access the notebook instance. If this parameter is specified, only the clients with the specified IP addresses can access the notebook instance.
+ |
+
+dev_service
+ |
+String
+ |
+Supported services. Options: - NOTEBOOK: You can access the notebook instance using HTTPS.- SSH: You can remotely access the notebook instance through SSH.
+ |
+
+ssh_keys
+ |
+Array of strings
+ |
+List of SSH key pairs. You can set multiple key pairs to access an SSH instance at the same time.
+ |
+
+
+
+
+
+ Table 8 ImageParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Image ID
+ |
+
+name
+ |
+String
+ |
+Image name.
+ |
+
+swr_path
+ |
+String
+ |
+SWR image address
+ |
+
+type
+ |
+String
+ |
+Image type. Options: - BUILD_IN: built-in system image- DEDICATED: image saved by the user
+ |
+
+
+
+
+
+ Table 9 LeaseParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+create_time
+ |
+Long
+ |
+Time (UTC) when the instance is created, accurate to millisecond.
+ |
+
+duration
+ |
+Long
+ |
+Instance running duration, which is calculated based on the instance creation time. If the instance creation time plus the duration is greater than the current time, the system automatically stops the instance.
+ |
+
+enable
+ |
+Boolean
+ |
+Whether to enable auto stop of the instance.
+ |
+
+update_time
+ |
+Long
+ |
+Time (UTC) when the instance is last updated (excluding the keepalive heartbeat time), accurate to millisecond.
+ |
+
+
+
+
+
+ Table 10 PoolParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+ID of a dedicated resource pool
+ |
+
+name
+ |
+String
+ |
+Name of a dedicated resource pool
+ |
+
+
+
+
+
+ Table 11 VolumeResParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+capacity
+ |
+Integer
+ |
+Storage capacity. The default value is 5 GB for EVS and 50 GB for EFS. The maximum value is 4,096 GB.
+ |
+
+category
+ |
+String
+ |
+Storage category. Options: \r\n-EFS: Scalable File Service (SFS), which is the default storage. \r\n-EVS: Elastic Volume Service (EVS). \r\n\r\n For details about the differences between the two types of storage, see Selecting a Storage Type in DevEnviron.\r\n.\r\n\r\n\r\n\r\n
+ |
+
+mount_path
+ |
+String
+ |
+Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is /home/ma-user/work/.
+ |
+
+ownership
+ |
+String
+ |
+Owner to which the resource belongs. Options: - MANAGED: Resources are managed by services.- DEDICATED: Resources are managed by the user account. This mode is supported only when the instance category is EFS.
+ |
+
+status
+ |
+String
+ |
+EVS disk capacity expansion status, which is RESIZING during capacity expansion and does not affect the instance.
+ |
+
+
+
+
+
+ Example Requests{
+ "name" : "notebooks_test",
+ "feature" : "NOTEBOOK",
+ "workspace_id" : "0",
+ "description" : "api-test",
+ "flavor" : "modelarts.vm.cpu.2u",
+ "image_id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
+ "volume" : {
+ "category" : "efs",
+ "ownership" : "managed",
+ "capacity" : 50
+ }
+}
+
+ Example ResponsesStatus code: 200
+ OK
+ {
+ "action_progress" : [ {
+ "step" : 1,
+ "status" : "WAITING",
+ "description" : "Prepare the storage."
+ }, {
+ "step" : 2,
+ "status" : "WAITING",
+ "description" : "Prepare the compute resource."
+ }, {
+ "step" : 3,
+ "status" : "WAITING",
+ "description" : "Configuring the network."
+ }, {
+ "step" : 4,
+ "status" : "WAITING",
+ "description" : "Initialize the notebook instance."
+ } ],
+ "create_at" : 1638841744521,
+ "description" : "api-test",
+ "feature" : "NOTEBOOK",
+ "flavor" : "modelarts.vm.cpu.2u",
+ "id" : "f9937afa-4451-42db-a76b-72d624749f66",
+ "image" : {
+ "description" : "description",
+ "id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
+ "name" : "notebook2.0-mul-kernel-cpu-cp36",
+ "swr_path" : "swr..xxxx.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.2-release_v1",
+ "tag" : "3.3.2-release_v1",
+ "type" : "BUILD_IN"
+ },
+ "lease" : {
+ "create_at" : 1638841744515,
+ "duration" : 3600000,
+ "enable" : true,
+ "update_at" : 1638841744515
+ },
+ "name" : "notebooks_test",
+ "status" : "CREATING",
+ "token" : "3eff13f2-3d70-5456-6dc7-e3f99f562022",
+ "update_at" : 1638841744522,
+ "workspace_id" : "0"
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+OK
+ |
+
+201
+ |
+Created
+ |
+
+401
+ |
+Unauthorized
+ |
+
+403
+ |
+Forbidden
+ |
+
+404
+ |
+Not Found
+ |
+
+
+
+
+
+
+ Creating a Processing Task
+FunctionThis API is used to create a processing task. You can create data processing tasks. You can specify the id field of template composite parameter in the request body to create a task.- Data processing refers to extracting or generating data that is valuable and meaningful to a particular person from a large amount of, cluttered, and incomprehensible data. Data processing includes data validation, data cleansing, data selection, and data augmentation. * Data validation indicates that the dataset is verified to ensure data accuracy. * Data cleansing refers to the process of denoising, correcting, or supplementing data. * Data selection indicates the process of selecting data subsets from full data. * Data augmentation indicates that data volume is increased through simple data amplification operations such as scaling, cropping, transformation, and composition.
+
+ URIPOST /v2/{project_id}/processor-tasks
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+ |
+
+
+
+
+
+ Request Parameters
+ Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+create_version
+ |
+No
+ |
+Boolean
+ |
+Whether to synchronously create a task version when creating a task. Set this parameter to true only when creating a data processing task. For other types of tasks, this parameter is set to false or left blank. The options are as follows:
+- true: Create a task version when creating a task.
- false: Do not create a task version when creating a task. (Default value)
+ |
+
+data_source
+ |
+No
+ |
+ProcessorDataSource object
+ |
+Data source. Either this parameter or inputs is used. A data source path cannot be an OBS path in a KMS-encrypted bucket.
+ |
+
+description
+ |
+No
+ |
+String
+ |
+Description of a data processing task. The description contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'
+ |
+
+inputs
+ |
+No
+ |
+Array of ProcessorDataSource objects
+ |
+Data sources. Either this parameter or data_source is used. A data source path cannot be an OBS path in a KMS-encrypted bucket.
+ |
+
+name
+ |
+Yes
+ |
+String
+ |
+Name of a data processing task.
+ |
+
+template
+ |
+No
+ |
+TemplateParam object
+ |
+Data processing template, such as the algorithm ID and parameters.
+ |
+
+version_id
+ |
+No
+ |
+String
+ |
+Dataset version ID.
+ |
+
+work_path
+ |
+No
+ |
+WorkPath object
+ |
+Work directory of a data processing task. A work directory cannot be an OBS path in a KMS-encrypted bucket.
+ |
+
+workspace_id
+ |
+No
+ |
+String
+ |
+Workspace ID. If no workspace is created, the default value is 0. If a workspace is created and used, use the actual value.
+ |
+
+
+
+
+
+ Table 3 ProcessorDataSourceParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+No
+ |
+String
+ |
+Dataset name.
+ |
+
+source
+ |
+No
+ |
+String
+ |
+Data source path. The options are as follows:
+- If type is set to OBS, source is an OBS path.
- If type is set to TASK, source is a task ID.
- If type is set to DATASET, source is a dataset ID.
- If type is set to CUSTOM and the API is called by resource tenants, set source to the project_id of the actual user. Otherwise, this field is left blank.
+ |
+
+type
+ |
+No
+ |
+String
+ |
+Data source type. The options are as follows:
+- OBS: Data obtained from OBS
- TASK: Data processing task
- DATASET: Dataset
- CUSTOM: Data called by resource tenants
+ |
+
+version_id
+ |
+No
+ |
+String
+ |
+Version of a dataset.
+ |
+
+version_name
+ |
+No
+ |
+String
+ |
+Dataset version name.
+ |
+
+
+
+
+
+ Table 4 TemplateParamParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+No
+ |
+String
+ |
+Task type, that is, ID of a data processing template. The options are as follows:
+- sys_data_analyse: feature analysis
- sys_data_cleaning: data cleansing
- sys_data_augmentation: data augmentation
- sys_data_validation: data validation
- sys_data_selection: data selection
+ |
+
+name
+ |
+No
+ |
+String
+ |
+Template name.
+ |
+
+operator_params
+ |
+No
+ |
+Array of OperatorParam objects
+ |
+Operator parameter list.
+ |
+
+
+
+
+
+ Table 5 OperatorParamParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+advanced_params_switch
+ |
+No
+ |
+Boolean
+ |
+Advanced parameter switch.
+ |
+
+id
+ |
+No
+ |
+String
+ |
+ID of an operator.
+ |
+
+name
+ |
+No
+ |
+String
+ |
+Name of an operator.
+ |
+
+params
+ |
+No
+ |
+Object
+ |
+Operator parameter. The parameter type is map<string,object>. Currently, object only supports the types of Boolean, Integer, Long, String, List and Map<String,String>. For two special scenarios of object detection and image classification in a data preprocessing task, the value of task_type is object_detection or image_classification.
+ |
+
+
+
+
+
+ Table 6 WorkPathParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+No
+ |
+String
+ |
+Dataset name.
+ |
+
+output_path
+ |
+No
+ |
+String
+ |
+Output path.
+ |
+
+path
+ |
+No
+ |
+String
+ |
+Working path. The options are as follows:
+- If type is set to OBS, source is an OBS path.
- If type is set to DATASET, source is a dataset ID.
+ |
+
+type
+ |
+No
+ |
+String
+ |
+Type of a working path. The options are as follows:
+- OBS: OBS path
- DATASET: dataset
+ |
+
+version_id
+ |
+No
+ |
+String
+ |
+Version of a dataset.
+ |
+
+version_name
+ |
+No
+ |
+String
+ |
+Name of a dataset version. The value can contain 0 to 32 characters. Only digits, letters, underscores (_), and hyphens (-) are allowed.
+ |
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 7 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+task_id
+ |
+String
+ |
+ID of a data processing task.
+ |
+
+
+
+
+
+ Example Requests- Creating a Data Processing (Data Validation) Task
{
+ "name" : "PRE-e77c",
+ "inputs" : [ {
+ "type" : "DATASET",
+ "source" : "PYc9H2HGv5BJNwBGXyK",
+ "version_id" : "yoJ5ssClpNlOrsjjFDa"
+ } ],
+ "work_path" : {
+ "type" : "DATASET",
+ "path" : "PYc9H2HGv5BJNwBGXyK",
+ "version_name" : "V0010"
+ },
+ "description" : "",
+ "create_version" : true,
+ "template" : {
+ "id" : "sys_data_validation",
+ "operator_params" : [ {
+ "name" : "MetaValidation",
+ "advanced_params_switch" : false,
+ "params" : {
+ "task_type" : "image_classification",
+ "dataset_type" : "manifest",
+ "source_service" : "select",
+ "filter_func" : "data_validation_select",
+ "image_max_width" : "1920",
+ "image_max_height" : "1920",
+ "total_status" : "[0,1,2]"
+ }
+ } ]
+ },
+ "workspace_id" : "0"
+}
+ - Creating a Data Processing (Data Cleansing) Task
{
+ "name" : "PRE-330f",
+ "inputs" : [ {
+ "type" : "DATASET",
+ "source" : "gfghHSokody6AJigS5A",
+ "version_id" : "54IXbeJhfttGpL46lbv"
+ } ],
+ "work_path" : {
+ "type" : "DATASET",
+ "path" : "gfghHSokody6AJigS5A",
+ "version_name" : "V004"
+ },
+ "description" : "",
+ "create_version" : true,
+ "template" : {
+ "id" : "sys_data_cleaning",
+ "operator_params" : [ {
+ "name" : "PCC",
+ "advanced_params_switch" : false,
+ "params" : {
+ "task_type" : "image_classification",
+ "dataset_type" : "manifest",
+ "source_service" : "select",
+ "filter_func" : "data_cleaning_select",
+ "prototype_sample_path" : "obs://test-obs/classify/data/cat-rabbit/",
+ "criticism_sample_path" : "",
+ "n_clusters" : "auto",
+ "simlarity_threshold" : "0.9",
+ "embedding_distance" : "0.2",
+ "checkpoint_path" : "/home/work/user-job-dir/test-lxm/resnet_v1_50",
+ "total_status" : "[0,2]",
+ "do_validation" : "True"
+ }
+ } ]
+ },
+ "workspace_id" : "0"
+}
+ - Creating a Data Processing (Data Selection) Task
{
+ "name" : "PRE-aae5",
+ "inputs" : [ {
+ "type" : "DATASET",
+ "source" : "gLNSdlQ1iAAmPgl0Won",
+ "version_id" : "WAVPSYpKE3FggbgRxiK"
+ } ],
+ "work_path" : {
+ "type" : "DATASET",
+ "path" : "gLNSdlQ1iAAmPgl0Won",
+ "version_name" : "V003"
+ },
+ "description" : "",
+ "create_version" : true,
+ "template" : {
+ "id" : "sys_data_selection",
+ "operator_params" : [ {
+ "name" : "SimDeduplication",
+ "advanced_params_switch" : false,
+ "params" : {
+ "task_type" : "image_classification",
+ "dataset_type" : "manifest",
+ "source_service" : "select",
+ "filter_func" : "data_deduplication_select",
+ "simlarity_threshold" : "0.9",
+ "total_status" : "[0,2]",
+ "do_validation" : "True"
+ }
+ } ]
+ },
+ "workspace_id" : "0"
+}
+ - Creating a Data Processing (Data Augmentation) Task
{
+ "name" : "PRE-637c",
+ "inputs" : [ {
+ "type" : "DATASET",
+ "source" : "XGrRZuCV1qmMxnsmD5u",
+ "version_id" : "kjPDTOSi6BQqhtXZlFv"
+ } ],
+ "work_path" : {
+ "type" : "DATASET",
+ "path" : "XGrRZuCV1qmMxnsmD5u",
+ "version_name" : "V002"
+ },
+ "description" : "",
+ "create_version" : true,
+ "template" : {
+ "id" : "sys_data_augmentation",
+ "operator_params" : [ {
+ "name" : "AddNoise",
+ "advanced_params_switch" : false,
+ "params" : {
+ "task_type" : "image_classification",
+ "dataset_type" : "manifest",
+ "AddNoise" : "1",
+ "noise_type" : "Gauss",
+ "loc" : "0",
+ "scale" : "1",
+ "lam" : "2",
+ "p" : "0.01",
+ "total_status" : "[3]",
+ "filter_func" : "data_augmentation",
+ "do_validation" : "True"
+ }
+ } ]
+ },
+ "workspace_id" : "0"
+}
+
+
+ Example ResponsesStatus code: 200
+ OK
+ {
+ "task_id" : "SNEJua7qdZZN8GvkcEr"
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+OK
+ |
+
+401
+ |
+Unauthorized
+ |
+
+403
+ |
+Forbidden
+ |
+
+404
+ |
+Not Found
+ |
+
+
+
+
+
+
+ Creating a Data Processing Task Version
+FunctionThis API is used to create a data processing task version.
+
+ URIPOST /v2/{project_id}/processor-tasks/{task_id}/versions
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+ |
+
+task_id
+ |
+Yes
+ |
+String
+ |
+ID of a data processing task.
+ |
+
+
+
+
+
+ Request Parameters
+ Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+create_version
+ |
+No
+ |
+Boolean
+ |
+Whether to synchronously create a task version when creating a task. The options are as follows:
+
+ |
+
+data_source
+ |
+No
+ |
+ProcessorDataSource object
+ |
+Data source. Either this parameter or inputs is delivered.
+ |
+
+description
+ |
+No
+ |
+String
+ |
+Description of a data processing task. The description contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'
+ |
+
+inputs
+ |
+No
+ |
+Array of ProcessorDataSource objects
+ |
+Data source list. Either this parameter or data_source is delivered.
+ |
+
+name
+ |
+Yes
+ |
+String
+ |
+Name of a data processing task.
+ |
+
+task_id
+ |
+Yes
+ |
+String
+ |
+ID of a data processing task.
+ |
+
+template
+ |
+No
+ |
+TemplateParam object
+ |
+Data processing template, such as the algorithm ID and parameters.
+ |
+
+version_id
+ |
+No
+ |
+String
+ |
+Dataset version ID.
+ |
+
+work_path
+ |
+No
+ |
+WorkPath object
+ |
+Working directory of a data processing task.
+ |
+
+workspace_id
+ |
+No
+ |
+String
+ |
+Workspace ID. If no workspace is created, the default value is 0. If a workspace is created and used, use the actual value.
+ |
+
+
+
+
+
+ Table 3 ProcessorDataSourceParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+No
+ |
+String
+ |
+Dataset name.
+ |
+
+source
+ |
+No
+ |
+String
+ |
+Data source path. The options are as follows:
+If type is set to OBS, source is an OBS path.
+If type is set to TASK, source is a task ID.
+If type is set to DATASET, source is a dataset ID.
+If type is set to CUSTOM and the API is called by resource tenants, set source to the project_id of the actual user. Otherwise, this field is left blank.
+
+ |
+
+type
+ |
+No
+ |
+String
+ |
+Data source type. The options are as follows:
+OBS: Data obtained from OBS
+TASK: Data processing task
+DATASET: Dataset
+CUSTOM: Data called by resource tenants
+
+ |
+
+version_id
+ |
+No
+ |
+String
+ |
+Version of a dataset.
+ |
+
+version_name
+ |
+No
+ |
+String
+ |
+Dataset version name.
+ |
+
+
+
+
+
+ Table 4 TemplateParamParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+No
+ |
+String
+ |
+Task type, that is, ID of a data processing template. The options are as follows:
+sys_data_analyse: feature analysis
+sys_data_cleaning: data cleansing
+sys_data_augmentation: data augmentation
+sys_data_validation: data validation
+sys_data_selection: data selection
+
+ |
+
+name
+ |
+No
+ |
+String
+ |
+Template name.
+ |
+
+operator_params
+ |
+No
+ |
+Array of OperatorParam objects
+ |
+Operator parameter list.
+ |
+
+
+
+
+
+ Table 5 OperatorParamParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+advanced_params_switch
+ |
+No
+ |
+Boolean
+ |
+Advanced parameter switch.
+ |
+
+id
+ |
+No
+ |
+String
+ |
+ID of an operator.
+ |
+
+name
+ |
+No
+ |
+String
+ |
+Name of an operator.
+ |
+
+params
+ |
+No
+ |
+Object
+ |
+Operator parameter. The parameter type is map<string,object>. Currently, object only supports the types of Boolean, Integer, Long, String, List and Map<String,String>. For two special scenarios of object detection and image classification in a data preprocessing task, the value of task_type is object_detection or image_classification.
+ |
+
+
+
+
+
+ Table 6 WorkPathParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+No
+ |
+String
+ |
+Dataset name.
+ |
+
+output_path
+ |
+No
+ |
+String
+ |
+Output path.
+ |
+
+path
+ |
+No
+ |
+String
+ |
+Working path. The options are as follows:
+If type is set to OBS, source is an OBS path.
+If type is set to DATASET, source is a dataset ID.
+
+ |
+
+type
+ |
+No
+ |
+String
+ |
+Type of a working path. The options are as follows:
+OBS: OBS path
+DATASET: dataset
+
+ |
+
+version_id
+ |
+No
+ |
+String
+ |
+Version of a dataset.
+ |
+
+version_name
+ |
+No
+ |
+String
+ |
+Name of a dataset version. The value can contain 0 to 32 characters. Only digits, letters, underscores (_), and hyphens (-) are allowed.
+ |
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 7 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+version_id
+ |
+String
+ |
+Version ID of a data processing task.
+ |
+
+
+
+
+
+ Example RequestsCreating a Data Validation Task Version
+ {
+ "name" : "PRE-e77c",
+ "inputs" : [ {
+ "type" : "DATASET",
+ "source" : "PYc9H2HGv5BJNwBGXyK",
+ "version_id" : "Osc8SZ7TZStiRV4vYkZ"
+ } ],
+ "work_path" : {
+ "type" : "DATASET",
+ "path" : "PYc9H2HGv5BJNwBGXyK",
+ "version_name" : "V0011"
+ },
+ "description" : "",
+ "template" : {
+ "id" : "sys_data_validation",
+ "operator_params" : [ {
+ "name" : "MetaValidation",
+ "advanced_params_switch" : false,
+ "params" : {
+ "task_type" : "image_classification",
+ "dataset_type" : "manifest",
+ "source_service" : "select",
+ "filter_func" : "data_validation_select",
+ "image_max_width" : "1920",
+ "image_max_height" : "1920",
+ "total_status" : "[0,1,2]"
+ }
+ } ]
+ },
+ "workspace_id" : "0"
+}
+
+ Example ResponsesStatus code: 200
+ OK
+ {
+ "version_id" : "qSaudx2sbPvthHygckA"
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+OK
+ |
+
+401
+ |
+Unauthorized
+ |
+
+403
+ |
+Forbidden
+ |
+
+404
+ |
+Not Found
+ |
+
+
+
+
+
+
+ Starting Intelligent Tasks
+FunctionThis API is used to start an intelligent task, which can be an auto labeling task or an auto grouping task. You can specify task_type in the request body to start a type of tasks. The datasets whose data path or work path is an OBS path in a KMS-encrypted bucket support pre-labeling but do not support active learning and auto grouping.- Auto labeling: Learning and training are performed based on selected labels and images and an existing model is selected to quickly label the remaining images. Auto labeling includes active learning and pre-labeling. Active learning: The system uses semi-supervised learning and hard example filtering to perform auto labeling, reducing manual labeling workload and helping you find hard examples. Pre-labeling: Select a model displayed on the Model Management page for auto labeling.- Auto grouping: Unlabeled images are clustered using a clustering algorithm and then processed based on the clustering result. Images can be labeled or cleaned by group.
+
+ URIPOST /v2/{project_id}/datasets/{dataset_id}/tasks
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+dataset_id
+ |
+Yes
+ |
+String
+ |
+Dataset ID.
+ |
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+ |
+
+
+
+
+
+ Request Parameters
+ Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+collect_key_sample
+ |
+No
+ |
+Boolean
+ |
+Whether to collect key samples. The options are as follows:
+- true: Collect key samples.
- false: Do not collect key samples. (Default value)
+ |
+
+config
+ |
+No
+ |
+SmartTaskConfig object
+ |
+Task configuration.
+ |
+
+model_id
+ |
+No
+ |
+String
+ |
+Model ID.
+ |
+
+task_type
+ |
+No
+ |
+String
+ |
+Task type. The options are as follows:
+- auto-label: active learning
- pre-label: pre-labeling
- auto-grouping: auto grouping
- auto-deploy: one-click model deployment
+ |
+
+
+
+
+
+ Table 3 SmartTaskConfigParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+algorithm_type
+ |
+No
+ |
+String
+ |
+Algorithm type for auto labeling. Options:
+- fast: Only labeled samples are used for training. This type of algorithm achieves faster labeling.
- accurate: In addition to labeled samples, unlabeled samples are used for semi-supervised training. This type of algorithm achieves more accurate labeling.
+ |
+
+ambiguity
+ |
+No
+ |
+Boolean
+ |
+Whether to perform clustering based on the image blurring degree.
+ |
+
+annotation_output
+ |
+No
+ |
+String
+ |
+Output path of the active learning labeling result.
+ |
+
+collect_rule
+ |
+No
+ |
+String
+ |
+Sample collection rule. The default value is all, indicating full collection. Currently, only value all is available.
+ |
+
+collect_sample
+ |
+No
+ |
+Boolean
+ |
+Whether to enable sample collection. The options are as follows:
+- true: Enable sample collection. (Default value)
- false: Do not enable sample collection.
+ |
+
+confidence_scope
+ |
+No
+ |
+String
+ |
+Confidence range of key samples. The minimum and maximum values are separated by hyphens (-). Example: 0.10-0.90.
+ |
+
+description
+ |
+No
+ |
+String
+ |
+Task description.
+ |
+
+engine_name
+ |
+No
+ |
+String
+ |
+Engine name.
+ |
+
+export_format
+ |
+No
+ |
+Integer
+ |
+Format of the exported directory. The options are as follows:
+- 1: tree structure. For example: cat/1.jpg,rabbit/2.jpg.
- 2: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt.
+ |
+
+export_params
+ |
+No
+ |
+ExportParams object
+ |
+Parameters of a dataset export task.
+ |
+
+flavor
+ |
+No
+ |
+Flavor object
+ |
+Training resource flavor.
+ |
+
+image_brightness
+ |
+No
+ |
+Boolean
+ |
+Whether to perform clustering based on the image brightness.
+ |
+
+image_colorfulness
+ |
+No
+ |
+Boolean
+ |
+Whether to perform clustering based on the image color.
+ |
+
+inf_cluster_id
+ |
+No
+ |
+String
+ |
+ID of a dedicated cluster. This parameter is left blank by default, indicating that a dedicated cluster is not used. When using the dedicated cluster to deploy services, ensure that the cluster status is normal. After this parameter is set, the network configuration of the cluster is used, and the vpc_id parameter does not take effect.
+ |
+
+inf_config_list
+ |
+No
+ |
+Array of InfConfig objects
+ |
+Configuration list required for running an inference task, which is optional and left blank by default.
+ |
+
+inf_output
+ |
+No
+ |
+String
+ |
+Output path of inference in active learning.
+ |
+
+infer_result_output_dir
+ |
+No
+ |
+String
+ |
+OBS directory for storing sample prediction results. This parameter is optional. The {service_id}-infer-result subdirectory in the output_dir directory is used by default.
+ |
+
+key_sample_output
+ |
+No
+ |
+String
+ |
+Output path of hard examples in active learning.
+ |
+
+log_url
+ |
+No
+ |
+String
+ |
+OBS URL of the logs of a training job. By default, this parameter is left blank.
+ |
+
+manifest_path
+ |
+No
+ |
+String
+ |
+Path of the manifest file, which is used as the input for training and inference.
+ |
+
+model_id
+ |
+No
+ |
+String
+ |
+Model ID.
+ |
+
+model_name
+ |
+No
+ |
+String
+ |
+Model name.
+ |
+
+model_parameter
+ |
+No
+ |
+String
+ |
+Model parameter.
+ |
+
+model_version
+ |
+No
+ |
+String
+ |
+Model version.
+ |
+
+n_clusters
+ |
+No
+ |
+Integer
+ |
+Number of clusters.
+ |
+
+name
+ |
+No
+ |
+String
+ |
+Task name.
+ |
+
+output_dir
+ |
+No
+ |
+String
+ |
+Sample output path. The format is as follows: Dataset output path/Dataset name-Dataset ID/annotation/auto-deploy/. Example: /test/work_1608083108676/dataset123-g6IO9qSu6hoxwCAirfm/annotation/auto-deploy/.
+ |
+
+parameters
+ |
+No
+ |
+Array of TrainingParameter objects
+ |
+Runtime parameters of a training job
+ |
+
+pool_id
+ |
+No
+ |
+String
+ |
+ID of a resource pool.
+ |
+
+property
+ |
+No
+ |
+String
+ |
+Attribute name.
+ |
+
+req_uri
+ |
+No
+ |
+String
+ |
+Inference path of a batch job.
+ |
+
+result_type
+ |
+No
+ |
+Integer
+ |
+Processing mode of auto grouping results. The options are as follows:
+- 0: Save to OBS.
- 1: Save to samples.
+ |
+
+samples
+ |
+No
+ |
+Array of SampleLabels objects
+ |
+List of labeling information for samples to be auto labeled.
+ |
+
+stop_time
+ |
+No
+ |
+Integer
+ |
+Timeout interval, in minutes. The default value is 15 minutes. This parameter is used only in the scenario of auto labeling for videos.
+ |
+
+time
+ |
+No
+ |
+String
+ |
+Timestamp in active learning.
+ |
+
+train_data_path
+ |
+No
+ |
+String
+ |
+Path for storing existing training datasets.
+ |
+
+train_url
+ |
+No
+ |
+String
+ |
+URL of the OBS path where the file of a training job is outputted. By default, this parameter is left blank.
+ |
+
+version_format
+ |
+No
+ |
+String
+ |
+Format of a dataset version. The options are as follows:
+- Default: default format
- CarbonData: CarbonData (supported only by table datasets)
- CSV: CSV
+ |
+
+worker_server_num
+ |
+No
+ |
+Integer
+ |
+Number of workers in a training job.
+ |
+
+
+
+
+
+ Table 4 ExportParamsParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+clear_hard_property
+ |
+No
+ |
+Boolean
+ |
+Whether to clear hard example attributes. The options are as follows:
+- true: Clear hard example attributes. (Default value)
- false: Do not clear hard example attributes.
+ |
+
+export_dataset_version_format
+ |
+No
+ |
+String
+ |
+Format of the dataset version to which data is exported.
+ |
+
+export_dataset_version_name
+ |
+No
+ |
+String
+ |
+Name of the dataset version to which data is exported.
+ |
+
+export_dest
+ |
+No
+ |
+String
+ |
+Export destination. The options are as follows:
+- DIR: Export data to OBS. (Default value)
- NEW_DATASET: Export data to a new dataset.
+ |
+
+export_new_dataset_name
+ |
+No
+ |
+String
+ |
+Name of the new dataset to which data is exported.
+ |
+
+export_new_dataset_work_path
+ |
+No
+ |
+String
+ |
+Working directory of the new dataset to which data is exported.
+ |
+
+ratio_sample_usage
+ |
+No
+ |
+Boolean
+ |
+Whether to randomly allocate the training set and validation set based on the specified ratio. The options are as follows:
+- true: Allocate the training set and validation set.
- false: Do not allocate the training set and validation set. (Default value)
+ |
+
+sample_state
+ |
+No
+ |
+String
+ |
+Sample status. The options are as follows:
+- ALL: labeled
- NONE: unlabeled
- UNCHECK: pending acceptance
- ACCEPTED: accepted
- REJECTED: rejected
- UNREVIEWED: pending review
- REVIEWED: reviewed
- WORKFORCE_SAMPLED: sampled
- WORKFORCE_SAMPLED_UNCHECK: sampling unchecked
- WORKFORCE_SAMPLED_CHECKED: sampling checked
- WORKFORCE_SAMPLED_ACCEPTED: sampling accepted
- WORKFORCE_SAMPLED_REJECTED: sampling rejected
- AUTO_ANNOTATION: to be confirmed
+ |
+
+samples
+ |
+No
+ |
+Array of strings
+ |
+ID list of exported samples.
+ |
+
+search_conditions
+ |
+No
+ |
+Array of SearchCondition objects
+ |
+Exported search conditions. The relationship between multiple search conditions is OR.
+ |
+
+train_sample_ratio
+ |
+No
+ |
+String
+ |
+Split ratio of training set and verification set during specified version release. The default value is 1.00, indicating that all released versions are training sets.
+ |
+
+
+
+
+
+ Table 5 SearchConditionParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+coefficient
+ |
+No
+ |
+String
+ |
+Filter by coefficient of difficulty.
+ |
+
+frame_in_video
+ |
+No
+ |
+Integer
+ |
+A frame in the video.
+ |
+
+hard
+ |
+No
+ |
+String
+ |
+Whether a sample is a hard sample. The options are as follows:
+- 0: non-hard sample
- 1: hard sample
+ |
+
+import_origin
+ |
+No
+ |
+String
+ |
+Filter by data source.
+ |
+
+kvp
+ |
+No
+ |
+String
+ |
+CT dosage, filtered by dosage.
+ |
+
+label_list
+ |
+No
+ |
+SearchLabels object
+ |
+Label search criteria.
+ |
+
+labeler
+ |
+No
+ |
+String
+ |
+Labeler.
+ |
+
+metadata
+ |
+No
+ |
+SearchProp object
+ |
+Search by sample attribute.
+ |
+
+parent_sample_id
+ |
+No
+ |
+String
+ |
+Parent sample ID.
+ |
+
+sample_dir
+ |
+No
+ |
+String
+ |
+Directory where data samples are stored (the directory must end with a slash (/)). Only samples in the specified directory are searched for. Recursive search of directories is not supported.
+ |
+
+sample_name
+ |
+No
+ |
+String
+ |
+Search by sample name, including the file name extension.
+ |
+
+sample_time
+ |
+No
+ |
+String
+ |
+When a sample is added to the dataset, an index is created based on the last modification time (accurate to day) of the sample on OBS. You can search for the sample based on the time. The options are as follows:- month: Search for samples added from 30 days ago to the current day.- day: Search for samples added from yesterday (one day ago) to the current day.- yyyyMMdd-yyyyMMdd: Search for samples added in a specified period (at most 30 days), in the format of Start date-End date. For example, 20190901-2019091501 indicates that samples generated from September 1 to September 15, 2019 are searched.
+ |
+
+score
+ |
+No
+ |
+String
+ |
+Search by confidence.
+ |
+
+slice_thickness
+ |
+No
+ |
+String
+ |
+DICOM layer thickness. Samples are filtered by layer thickness.
+ |
+
+study_date
+ |
+No
+ |
+String
+ |
+DICOM scanning time.
+ |
+
+time_in_video
+ |
+No
+ |
+String
+ |
+A time point in the video.
+ |
+
+
+
+
+
+ Table 6 SearchLabelsParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+labels
+ |
+No
+ |
+Array of SearchLabel objects
+ |
+List of label search criteria.
+ |
+
+op
+ |
+No
+ |
+String
+ |
+If you want to search for multiple labels, op must be specified. If you search for only one label, op can be left blank. The options are as follows:
+- OR: OR operation
- AND: AND operation
+ |
+
+
+
+
+
+ Table 7 SearchLabelParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+No
+ |
+String
+ |
+Label name.
+ |
+
+op
+ |
+No
+ |
+String
+ |
+Operation type between multiple attributes. The options are as follows:
+- OR: OR operation
- AND: AND operation
+ |
+
+property
+ |
+No
+ |
+Map<String,Array<String>>
+ |
+Label attribute, which is in the Object format and stores any key-value pairs. key indicates the attribute name, and value indicates the value list. If value is null, the search is not performed by value. Otherwise, the search value can be any value in the list.
+ |
+
+type
+ |
+No
+ |
+Integer
+ |
+Label type. The options are as follows:
+- 0: image classification
- 1: object detection
- 100: text classification
- 101: named entity recognition
- 102: text triplet relationship
- 103: text triplet entity
- 200: speech classification
- 201: speech content
- 202: speech paragraph labeling
- 600: video classification
+ |
+
+
+
+
+
+ Table 8 SearchPropParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+op
+ |
+No
+ |
+String
+ |
+Relationship between attribute values. The options are as follows:
+- AND: AND relationship
- OR: OR relationship
+ |
+
+props
+ |
+No
+ |
+Map<String,Array<String>>
+ |
+Search criteria of an attribute. Multiple search criteria can be set.
+ |
+
+
+
+
+
+ Table 9 FlavorParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+code
+ |
+No
+ |
+String
+ |
+Attribute code of a resource specification, which is used for task creating.
+ |
+
+
+
+
+
+ Table 10 InfConfigParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+envs
+ |
+No
+ |
+Map<String,String>
+ |
+(Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank. To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables.
+ |
+
+instance_count
+ |
+No
+ |
+Integer
+ |
+Instance number of model deployment, that is, the number of compute nodes.
+ |
+
+model_id
+ |
+No
+ |
+String
+ |
+Model ID.
+ |
+
+specification
+ |
+No
+ |
+String
+ |
+Resource specifications of real-time services. For details, see Deploying Services.
+ |
+
+weight
+ |
+No
+ |
+Integer
+ |
+Traffic weight allocated to a model. This parameter is mandatory only when infer_type is set to real-time. The sum of the weights must be 100.
+ |
+
+
+
+
+
+ Table 11 TrainingParameterParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+label
+ |
+No
+ |
+String
+ |
+Parameter name.
+ |
+
+value
+ |
+No
+ |
+String
+ |
+Parameter value.
+ |
+
+
+
+
+
+ Table 12 SampleLabelsParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+labels
+ |
+No
+ |
+Array of SampleLabel objects
+ |
+Sample label list. If this parameter is left blank, all sample labels are deleted.
+ |
+
+metadata
+ |
+No
+ |
+SampleMetadata object
+ |
+Key-value pair of the sample metadata attribute.
+ |
+
+sample_id
+ |
+No
+ |
+String
+ |
+Sample ID.
+ |
+
+sample_type
+ |
+No
+ |
+Integer
+ |
+Sample type. The options are as follows:
+- 0: image
- 1: text
- 2: speech
- 4: table
- 6: video
- 9: custom format
+ |
+
+sample_usage
+ |
+No
+ |
+String
+ |
+Sample usage. The options are as follows:
+- TRAIN: training
- EVAL: evaluation
- TEST: test
- INFERENCE: inference
+ |
+
+source
+ |
+No
+ |
+String
+ |
+Source address of sample data.
+ |
+
+worker_id
+ |
+No
+ |
+String
+ |
+ID of a labeling team member.
+ |
+
+
+
+
+
+ Table 13 SampleLabelParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+annotated_by
+ |
+No
+ |
+String
+ |
+Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. The options are as follows:
+- human: manual labeling
- auto: automatic labeling
+ |
+
+id
+ |
+No
+ |
+String
+ |
+Label ID.
+ |
+
+name
+ |
+No
+ |
+String
+ |
+Label name.
+ |
+
+property
+ |
+No
+ |
+SampleLabelProperty object
+ |
+Attribute key-value pair of the sample label, such as the object shape and shape feature.
+ |
+
+score
+ |
+No
+ |
+Float
+ |
+Confidence.
+ |
+
+type
+ |
+No
+ |
+Integer
+ |
+Label type. The options are as follows:
+- 0: image classification
- 1: object detection
- 100: text classification
- 101: named entity recognition
- 102: text triplet relationship
- 103: text triplet entity
- 200: speech classification
- 201: speech content
- 202: speech paragraph labeling
- 600: video classification
+ |
+
+
+
+
+
+ Table 14 SampleLabelPropertyParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+@modelarts:content
+ |
+No
+ |
+String
+ |
+Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points).
+ |
+
+@modelarts:end_index
+ |
+No
+ |
+Integer
+ |
+End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of end_index. Examples are as follows.- If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the start_index and end_index values of "Barack Hussein Obama II" are 0 and 23, respectively.- If the text content is "By the end of 2018, the company has more than 100 employees.", the start_index and end_index values of "By the end of 2018" are 0 and 18, respectively.
+ |
+
+@modelarts:end_time
+ |
+No
+ |
+String
+ |
+Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of hh:mm:ss.SSS. (hh indicates hour; mm indicates minute; ss indicates second; and SSS indicates millisecond.)
+ |
+
+@modelarts:feature
+ |
+No
+ |
+Object
+ |
+Shape feature, which is a default attribute dedicated to the object detection label, with type of List. The upper left corner of an image is used as the coordinate origin [0,0]. Each coordinate point is represented by [x, y]. x indicates the horizontal coordinate, and y indicates the vertical coordinate (both x and y are greater than or equal to 0). The format of each shape is as follows:- bndbox: consists of two points, for example, [[0,10],[50,95]]. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point.- polygon: consists of multiple points that are connected in sequence to form a polygon, for example, [[0,100],[50,95],[10,60],[500,400]].- circle: consists of the center point and radius, for example, [[100,100],[50]].- line: consists of two points, for example, [[0,100],[50,95]]. The first point is the start point, and the second point is the end point.- dashed: consists of two points, for example, [[0,100],[50,95]]. The first point is the start point, and the second point is the end point.- point: consists of one point, for example, [[0,100]].- polyline: consists of multiple points, for example, [[0,100],[50,95],[10,60],[500,400]].
+ |
+
+@modelarts:from
+ |
+No
+ |
+String
+ |
+ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label.
+ |
+
+@modelarts:hard
+ |
+No
+ |
+String
+ |
+Sample labeled as a hard sample or not, which is a default attribute. Options:
+- 0/false: not a hard example
- 1/true: hard example
+ |
+
+@modelarts:hard_coefficient
+ |
+No
+ |
+String
+ |
+Coefficient of difficulty of each label level, which is a default attribute. The value range is [0,1].
+ |
+
+@modelarts:hard_reasons
+ |
+No
+ |
+String
+ |
+Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, 3-20-21-19. The options are as follows:
+- 0: No target objects are identified.
- 1: The confidence is low.
- 2: The clustering result based on the training dataset is inconsistent with the prediction result.
- 3: The prediction result is greatly different from the data of the same type in the training dataset.
- 4: The prediction results of multiple consecutive similar images are inconsistent.
- 5: There is a large offset between the image resolution and the feature distribution of the training dataset.
- 6: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset.
- 7: There is a large offset between the brightness of the image and the feature distribution of the training dataset.
- 8: There is a large offset between the saturation of the image and the feature distribution of the training dataset.
- 9: There is a large offset between the color richness of the image and the feature distribution of the training dataset.
- 10: There is a large offset between the definition of the image and the feature distribution of the training dataset.
- 11: There is a large offset between the number of frames of the image and the feature distribution of the training dataset.
- 12: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset.
- 13: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset.
- 14: There is a large offset between the area portion of image frames and the feature distribution of the training dataset.
- 15: There is a large offset between the edge of image frames and the feature distribution of the training dataset.
- 16: There is a large offset between the brightness of image frames and the feature distribution of the training dataset.
- 17: There is a large offset between the definition of image frames and the feature distribution of the training dataset.
- 18: There is a large offset between the stack of image frames and the feature distribution of the training dataset.
- 19: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image.
- 20: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image.
- 21: The data enhancement result based on Crop is inconsistent with the prediction result of the original image.
- 22: The data enhancement result based on flipud is inconsistent with the prediction result of the original image.
- 23: The data enhancement result based on scale is inconsistent with the prediction result of the original image.
- 24: The data enhancement result based on translate is inconsistent with the prediction result of the original image.
- 25: The data enhancement result based on shear is inconsistent with the prediction result of the original image.
- 26: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image.
- 27: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image.
- 28: The data enhancement result based on add is inconsistent with the prediction result of the original image.
- 29: The data enhancement result based on invert is inconsistent with the prediction result of the original image.
- 30: The data is predicted to be abnormal.
+ |
+
+@modelarts:shape
+ |
+No
+ |
+String
+ |
+Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows:
+- bndbox: rectangle
- polygon: polygon
- circle: circle
- line: straight line
- dashed: dotted line
- point: point
- polyline: polyline
+ |
+
+@modelarts:source
+ |
+No
+ |
+String
+ |
+Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator.
+ |
+
+@modelarts:start_index
+ |
+No
+ |
+Integer
+ |
+Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of start_index.
+ |
+
+@modelarts:start_time
+ |
+No
+ |
+String
+ |
+Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of hh:mm:ss.SSS. (hh indicates hour; mm indicates minute; ss indicates second; and SSS indicates millisecond.)
+ |
+
+@modelarts:to
+ |
+No
+ |
+String
+ |
+ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label.
+ |
+
+
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 16 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+task_id
+ |
+String
+ |
+Task ID.
+ |
+
+
+
+
+
+ Example Requests- Starting an Auto Labeling (Active Learning) Task
{
+ "task_type" : "auto-label",
+ "collect_key_sample" : true,
+ "config" : {
+ "algorithm_type" : "fast"
+ }
+}
+ - Starting an Auto Labeling (Pre-labeling) Task
{
+ "task_type" : "pre-label",
+ "model_id" : "c4989033-7584-44ee-a180-1c476b810e46",
+ "collect_key_sample" : true,
+ "config" : {
+ "inf_config_list" : [ {
+ "specification" : "modelarts.vm.cpu.2u",
+ "instance_count" : 1
+ } ]
+ }
+}
+ - Starting an Auto Grouping Task
{
+ "type" : 2,
+ "export_type" : 1,
+ "config" : {
+ "n_clusters" : "2",
+ "ambiguity" : false,
+ "image_brightness" : false,
+ "image_colorfulness" : false,
+ "property" : "size"
+ }
+}
+
+
+ Example ResponsesStatus code: 200
+ OK
+ {
+ "task_id" : "r0jT2zwxBDKf8KEnSuZ"
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+OK
+ |
+
+401
+ |
+Unauthorized
+ |
+
+403
+ |
+Forbidden
+ |
+
+404
+ |
+Not Found
+ |
+
+
+
+
+
+
+ Creating a Training Job
+FunctionThis API is used to create a training job.
+
+ URIPOST /v2/{project_id}/training-jobs
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID.
+ |
+
+
+
+
+
+ Request Parameters
+ Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+kind
+ |
+Yes
+ |
+String
+ |
+Training job type, which is job by default. Options:
+- job: Training job
- hetero_job: Heterogeneous job
- autosearch_job: Auto search job
- mrs_job: MRS job [- edge_job: Edge job] (tag:hk,hc,fcs,fcs-super)
+ |
+
+metadata
+ |
+Yes
+ |
+JobMetadata object
+ |
+Metadata of a training job.
+ |
+
+algorithm
+ |
+No
+ |
+JobAlgorithm object
+ |
+Algorithm for training jobs. The following formats are supported:
+- id: Only the algorithm ID is used.
- subscription_id+item_version_id: The subscription ID and version ID of the algorithm are used.
- code_dir+boot_file: The code directory and boot file of a training job are used.
+ |
+
+tasks
+ |
+No
+ |
+Array of Task objects
+ |
+List of tasks in heterogeneous training jobs. If this parameter is specified, leave the spec parameter blank.
+ |
+
+spec
+ |
+No
+ |
+spec object
+ |
+Specifications of a training job. If this parameter is specified, leave the tasks parameter blank.
+ |
+
+
+
+
+
+
+
+ Table 4 JobAlgorithmParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+No
+ |
+String
+ |
+Algorithm ID.
+ |
+
+name
+ |
+No
+ |
+String
+ |
+Algorithm name. Leave it blank.
+ |
+
+subscription_id
+ |
+No
+ |
+String
+ |
+Subscription ID of the subscription algorithm. This parameter must be used together with item_version_id.
+ |
+
+item_version_id
+ |
+No
+ |
+String
+ |
+Version ID of the subscription algorithm. This parameter must be used together with subscription_id.
+ |
+
+code_dir
+ |
+No
+ |
+String
+ |
+Code directory of a training job, for example, /usr/app/. This parameter must be used together with boot_file. If id or subscription_id+item_version_id is set, leave it blank.
+ |
+
+boot_file
+ |
+No
+ |
+String
+ |
+Boot file of a training job, which needs to be stored in the code directory, for example, /usr/app/boot.py. This parameter must be used together with code_dir. If id or subscription_id+item_version_id is set, leave it blank.
+ |
+
+autosearch_config_path
+ |
+No
+ |
+String
+ |
+YAML configuration path of auto search jobs. An OBS URL is required.
+ |
+
+autosearch_framework_path
+ |
+No
+ |
+String
+ |
+Framework code directory of auto search jobs. An OBS URL is required.
+ |
+
+command
+ |
+No
+ |
+String
+ |
+Command for starting the container of the custom image of a training job in the custom image scenario.
+ |
+
+parameters
+ |
+No
+ |
+Array of parameters objects
+ |
+Running parameters of a training job.
+ |
+
+policies
+ |
+No
+ |
+policies object
+ |
+Policies supported by jobs, which are used for hyperparameter search.
+ |
+
+inputs
+ |
+No
+ |
+Array of Input objects
+ |
+Input of a training job.
+ |
+
+outputs
+ |
+No
+ |
+Array of Output objects
+ |
+Output of a training job.
+ |
+
+engine
+ |
+No
+ |
+engine object
+ |
+Engine of a training job. Leave this parameter blank if the job is created using id of the algorithm management API or subscription_id+item_version_id of the subscription algorithm API.
+ |
+
+environments
+ |
+No
+ |
+Array of Map<String,String> objects
+ |
+Environment variables of a training job. The format is key: value. Leave this parameter blank.
+ |
+
+
+
+
+
+ Table 5 parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+No
+ |
+String
+ |
+Parameter name.
+ |
+
+value
+ |
+No
+ |
+String
+ |
+Parameter value.
+ |
+
+description
+ |
+No
+ |
+String
+ |
+Parameter description.
+ |
+
+constraint
+ |
+No
+ |
+constraint object
+ |
+Parameter constraint.
+ |
+
+i18n_description
+ |
+No
+ |
+i18n_description object
+ |
+Internationalization description.
+ |
+
+
+
+
+
+ Table 6 constraintParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+type
+ |
+No
+ |
+String
+ |
+Parameter type.
+ |
+
+editable
+ |
+No
+ |
+Boolean
+ |
+Whether the parameter is editable.
+ |
+
+required
+ |
+No
+ |
+Boolean
+ |
+Whether the parameter is mandatory.
+ |
+
+sensitive
+ |
+No
+ |
+Boolean
+ |
+Whether the parameter is sensitive.
+ |
+
+valid_type
+ |
+No
+ |
+String
+ |
+Valid type.
+ |
+
+valid_range
+ |
+No
+ |
+Array of strings
+ |
+Valid range.
+ |
+
+
+
+
+
+ Table 7 i18n_descriptionParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+language
+ |
+No
+ |
+String
+ |
+Internationalization language.
+ |
+
+description
+ |
+No
+ |
+String
+ |
+Description.
+ |
+
+
+
+
+
+ Table 8 policiesParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+auto_search
+ |
+No
+ |
+auto_search object
+ |
+Hyperparameter search configuration.
+ |
+
+
+
+
+
+ Table 9 auto_searchParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+skip_search_params
+ |
+No
+ |
+String
+ |
+Hyperparameter parameters that need to be skipped.
+ |
+
+reward_attrs
+ |
+No
+ |
+Array of reward_attrs objects
+ |
+List of search metrics.
+ |
+
+search_params
+ |
+No
+ |
+Array of search_params objects
+ |
+Search parameters.
+ |
+
+algo_configs
+ |
+No
+ |
+Array of algo_configs objects
+ |
+Search algorithm configurations.
+ |
+
+
+
+
+
+ Table 10 reward_attrsParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+No
+ |
+String
+ |
+Metric name.
+ |
+
+mode
+ |
+No
+ |
+String
+ |
+Search direction.
+- max: A larger metric value indicates better performance.
- min: A smaller metric value indicates better performance.
+ |
+
+regex
+ |
+No
+ |
+String
+ |
+Regular expression of a metric.
+ |
+
+
+
+
+
+ Table 11 search_paramsParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+No
+ |
+String
+ |
+Hyperparameter name.
+ |
+
+param_type
+ |
+No
+ |
+String
+ |
+Parameter type.
+- continuous: The parameter is a continuous value.
- discreate: The parameter is a discrete value.
+ |
+
+lower_bound
+ |
+No
+ |
+String
+ |
+Lower bound of the hyperparameter.
+ |
+
+upper_bound
+ |
+No
+ |
+String
+ |
+Upper bound of the hyperparameter.
+ |
+
+discrete_points_num
+ |
+No
+ |
+String
+ |
+Number of discrete points of a continuous hyperparameter.
+ |
+
+discrete_values
+ |
+No
+ |
+Array of strings
+ |
+List of discrete hyperparameter values.
+ |
+
+
+
+
+
+ Table 12 algo_configsParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+No
+ |
+String
+ |
+Name of the search algorithm.
+ |
+
+params
+ |
+No
+ |
+Array of AutoSearchAlgoConfigParameter objects
+ |
+Search algorithm parameters.
+ |
+
+
+
+
+
+ Table 13 AutoSearchAlgoConfigParameterParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+key
+ |
+No
+ |
+String
+ |
+Parameter key.
+ |
+
+value
+ |
+No
+ |
+String
+ |
+Parameter value.
+ |
+
+type
+ |
+No
+ |
+String
+ |
+Parameter type.
+ |
+
+
+
+
+
+ Table 14 engineParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+engine_id
+ |
+No
+ |
+String
+ |
+Engine ID selected for a training job. You can set this parameter to engine_id, engine_name + engine_version, or image_url.
+ |
+
+engine_name
+ |
+No
+ |
+String
+ |
+Name of the engine selected for a training job. If engine_id is set, leave this parameter blank.
+ |
+
+engine_version
+ |
+No
+ |
+String
+ |
+Name of the engine version selected for a training job. If engine_id is set, leave this parameter blank.
+ |
+
+image_url
+ |
+No
+ |
+String
+ |
+Custom image URL selected for a training job.
+ |
+
+
+
+
+
+ Table 15 TaskParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+role
+ |
+No
+ |
+String
+ |
+Role of a heterogeneous training job. Options:
+- learner: supports GPUs or CPUs.
- worker: supports CPUs.
+ |
+
+algorithm
+ |
+No
+ |
+algorithm object
+ |
+Algorithm management and configuration.
+ |
+
+task_resource
+ |
+No
+ |
+task_resource object
+ |
+Resource flavors of a training job.
+ |
+
+
+
+
+
+ Table 16 algorithmParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+job_config
+ |
+No
+ |
+job_config object
+ |
+Algorithm configuration, such as the boot file.
+ |
+
+code_dir
+ |
+No
+ |
+String
+ |
+Algorithm code directory, for example, /usr/app/. This parameter must be used together with boot_file.
+ |
+
+boot_file
+ |
+No
+ |
+String
+ |
+Code boot file of the algorithm, which needs to be stored in the code directory, for example, /usr/app/boot.py. This parameter must be used together with code_dir.
+ |
+
+engine
+ |
+No
+ |
+engine object
+ |
+Engine of a heterogeneous job algorithm.
+ |
+
+inputs
+ |
+No
+ |
+Array of inputs objects
+ |
+Data input of an algorithm.
+ |
+
+outputs
+ |
+No
+ |
+Array of outputs objects
+ |
+Data output of an algorithm.
+ |
+
+
+
+
+
+ Table 17 job_configParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+parameters
+ |
+No
+ |
+Array of Parameter objects
+ |
+Running parameter of an algorithm.
+ |
+
+inputs
+ |
+No
+ |
+Array of Input objects
+ |
+Data input of an algorithm.
+ |
+
+outputs
+ |
+No
+ |
+Array of Output objects
+ |
+Data output of an algorithm.
+ |
+
+engine
+ |
+No
+ |
+engine object
+ |
+Algorithm engine.
+ |
+
+
+
+
+
+ Table 18 ParameterParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+No
+ |
+String
+ |
+Parameter name.
+ |
+
+value
+ |
+No
+ |
+String
+ |
+Parameter value.
+ |
+
+description
+ |
+No
+ |
+String
+ |
+Parameter description.
+ |
+
+constraint
+ |
+No
+ |
+constraint object
+ |
+Parameter constraint.
+ |
+
+i18n_description
+ |
+No
+ |
+i18n_description object
+ |
+Internationalization description.
+ |
+
+
+
+
+
+ Table 19 constraintParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+type
+ |
+No
+ |
+String
+ |
+Parameter type.
+ |
+
+editable
+ |
+No
+ |
+Boolean
+ |
+Whether the parameter is editable.
+ |
+
+required
+ |
+No
+ |
+Boolean
+ |
+Whether the parameter is mandatory.
+ |
+
+sensitive
+ |
+No
+ |
+Boolean
+ |
+Whether the parameter is sensitive.
+ |
+
+valid_type
+ |
+No
+ |
+String
+ |
+Valid type.
+ |
+
+valid_range
+ |
+No
+ |
+Array of strings
+ |
+Valid range.
+ |
+
+
+
+
+
+ Table 20 i18n_descriptionParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+language
+ |
+No
+ |
+String
+ |
+Internationalization language.
+ |
+
+description
+ |
+No
+ |
+String
+ |
+Description.
+ |
+
+
+
+
+
+
+
+
+
+ Table 23 datasetParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+Yes
+ |
+String
+ |
+Dataset ID of a training job.
+ |
+
+version_id
+ |
+Yes
+ |
+String
+ |
+Dataset version ID of a training job.
+ |
+
+obs_url
+ |
+No
+ |
+String
+ |
+OBS URL of the dataset required by a training job. ModelArts automatically parses and generates the URL based on the dataset and dataset version IDs. For example, /usr/data/.
+ |
+
+
+
+
+
+ Table 24 obsParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs_url
+ |
+Yes
+ |
+String
+ |
+OBS URL of the dataset required by a training job. For example, /usr/data/.
+ |
+
+
+
+
+
+ Table 25 remote_constraintParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+data_type
+ |
+No
+ |
+String
+ |
+Data input type, including the data storage location and dataset.
+ |
+
+attributes
+ |
+No
+ |
+String
+ |
+Attributes if a dataset is used as the data input. Options:
+- data_format: Data format
- data_segmentation: Data segmentation
- dataset_type: Labeling type
+ |
+
+
+
+
+
+ Table 26 OutputParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+Yes
+ |
+String
+ |
+Name of the data output channel.
+ |
+
+description
+ |
+No
+ |
+String
+ |
+Description of the data output channel.
+ |
+
+local_dir
+ |
+No
+ |
+String
+ |
+Local directory of the container to which the data output channel is mapped.
+ |
+
+remote
+ |
+Yes
+ |
+remote object
+ |
+Description of the actual data output.
+ |
+
+
+
+
+
+ Table 27 remoteParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs
+ |
+Yes
+ |
+obs object
+ |
+OBS to which data is actually exported.
+ |
+
+
+
+
+
+ Table 28 obsParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs_url
+ |
+Yes
+ |
+String
+ |
+OBS URL to which data is actually exported.
+ |
+
+
+
+
+
+ Table 29 engineParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+engine_id
+ |
+No
+ |
+String
+ |
+Engine ID selected for an algorithm.
+ |
+
+engine_name
+ |
+No
+ |
+String
+ |
+Engine version name selected for an algorithm. If engine_id is specified, leave this parameter blank.
+ |
+
+engine_version
+ |
+No
+ |
+String
+ |
+Engine version name selected for an algorithm. If engine_id is specified, leave this parameter blank.
+ |
+
+image_url
+ |
+No
+ |
+String
+ |
+Custom image URL selected by an algorithm.
+ |
+
+
+
+
+
+ Table 30 engineParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+engine_id
+ |
+No
+ |
+String
+ |
+Engine ID of a heterogeneous job, for example, caffe-1.0.0-python2.7.
+ |
+
+engine_name
+ |
+No
+ |
+String
+ |
+Engine name of a heterogeneous job, for example, Caffe.
+ |
+
+engine_version
+ |
+No
+ |
+String
+ |
+Engine version of a heterogeneous job.
+ |
+
+image_url
+ |
+No
+ |
+String
+ |
+Custom image URL selected by an algorithm.
+ |
+
+
+
+
+
+
+
+ Table 32 remoteParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs
+ |
+No
+ |
+obs object
+ |
+OBS in which data input and output stored.
+ |
+
+
+
+
+
+ Table 33 obsParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs_url
+ |
+Yes
+ |
+String
+ |
+OBS URL of the dataset required by a training job. For example, /usr/data/.
+ |
+
+
+
+
+
+ Table 34 outputsParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+Yes
+ |
+String
+ |
+Name of the data output channel.
+ |
+
+description
+ |
+No
+ |
+String
+ |
+Description of the data output channel.
+ |
+
+local_dir
+ |
+No
+ |
+String
+ |
+Local directory of the container to which the data output channel is mapped.
+ |
+
+remote
+ |
+Yes
+ |
+remote object
+ |
+Description of the actual data output.
+ |
+
+
+
+
+
+ Table 35 remoteParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs
+ |
+Yes
+ |
+obs object
+ |
+OBS to which data is actually exported.
+ |
+
+
+
+
+
+ Table 36 obsParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs_url
+ |
+Yes
+ |
+String
+ |
+OBS URL to which data is actually exported.
+ |
+
+
+
+
+
+ Table 37 task_resourceParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+flavor_id
+ |
+No
+ |
+String
+ |
+Resource flavor ID of a training job.
+ |
+
+node_count
+ |
+Yes
+ |
+Integer
+ |
+Number of resource replicas selected for a training job.
+Minimum: 1
+ |
+
+
+
+
+
+ Table 38 specParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+resource
+ |
+No
+ |
+resource object
+ |
+Resource flavors of a training job. Select either flavor_id or pool_id+[flavor_id].
+ |
+
+volumes
+ |
+No
+ |
+Array of volumes objects
+ |
+Volumes attached to a training job.
+ |
+
+log_export_path
+ |
+No
+ |
+log_export_path object
+ |
+Export path of training job logs.
+ |
+
+
+
+
+
+ Table 39 resourceParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+flavor_id
+ |
+Yes
+ |
+String
+ |
+ID of the resource flavors selected for a training job.
+ |
+
+node_count
+ |
+No
+ |
+Integer
+ |
+Number of nodes used for creating a training job in a pool. By default, a single node is used.
+ |
+
+
+
+
+
+ Table 40 volumesParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+nfs
+ |
+No
+ |
+nfs object
+ |
+Volumes attached in NFS mode.
+ |
+
+
+
+
+
+ Table 41 nfsParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+nfs_server_path
+ |
+No
+ |
+String
+ |
+NFS server path.
+ |
+
+local_path
+ |
+No
+ |
+String
+ |
+Path for attaching volumes to the training container.
+ |
+
+read_only
+ |
+No
+ |
+Boolean
+ |
+Whether the volumes attached to the container in NFS mode are read-only.
+ |
+
+
+
+
+
+ Table 42 log_export_pathParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs_url
+ |
+No
+ |
+String
+ |
+OBS URL for storing training job logs.
+ |
+
+host_path
+ |
+No
+ |
+String
+ |
+Path of the host where training job logs are stored.
+ |
+
+
+
+
+
+ Response ParametersStatus code: 201
+
+ Table 43 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+kind
+ |
+String
+ |
+Training job type, which is job by default. Options:
+- job: Training job
- hetero_job: Heterogeneous job
- autosearch_job: Auto search job
- mrs_job: MRS job [- edge_job: Edge job] (tag:hk,hc,fcs,fcs-super)
+ |
+
+metadata
+ |
+JobMetadata object
+ |
+Metadata of a training job.
+ |
+
+status
+ |
+Status object
+ |
+Status of a training job. You do not need to set this parameter when creating a job.
+ |
+
+algorithm
+ |
+JobAlgorithmResponse object
+ |
+Algorithm for training jobs. The following formats are supported:
+- id: Only the algorithm ID is used.
- subscription_id+item_version_id: The subscription ID and version ID of the algorithm are used.
- code_dir+boot_file: The code directory and boot file of a training job are used.
+ |
+
+tasks
+ |
+Array of TaskResponse objects
+ |
+List of tasks in heterogeneous training jobs.
+ |
+
+spec
+ |
+spec object
+ |
+Specifications of a training job.
+ |
+
+
+
+
+
+
+
+ Table 45 StatusParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+phase
+ |
+String
+ |
+Level-1 status of a training job. The value is stable. The options are as follows: Creating Pending Running Failed Completed, Terminating Terminated Abnormal
+ |
+
+secondary_phase
+ |
+String
+ |
+Level-2 status of a training job. The value is unstable. The options are as follows: Creating Queuing Running Failed Completed Terminating Terminated CreateFailed TerminatedFailed Unknown Lost
+ |
+
+duration
+ |
+Long
+ |
+Running duration of a training job, in milliseconds
+ |
+
+node_count_metrics
+ |
+Array<Array<Integer>>
+ |
+Node count changes during the training job running period.
+ |
+
+tasks
+ |
+Array of strings
+ |
+Tasks of a training job.
+ |
+
+start_time
+ |
+String
+ |
+Start time of a training job. The value is in timestamp format.
+ |
+
+task_statuses
+ |
+Array of task_statuses objects
+ |
+Status of a training job task.
+ |
+
+
+
+
+
+ Table 46 task_statusesParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+task
+ |
+String
+ |
+Name of a training job task.
+ |
+
+exit_code
+ |
+Integer
+ |
+Exit code of a training job task.
+ |
+
+message
+ |
+String
+ |
+Error message of a training job task.
+ |
+
+
+
+
+
+ Table 47 JobAlgorithmResponseParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Algorithm for training jobs. Options:
+- id: Only the algorithm ID is used.
- subscription_id+item_version_id: The subscription ID and version ID of the algorithm are used.
- code_dir+boot_file: The code directory and boot file of a training job are used.
+ |
+
+name
+ |
+String
+ |
+Algorithm name.
+ |
+
+subscription_id
+ |
+String
+ |
+Subscription ID of the subscription algorithm. This parameter must be used together with item_version_id.
+ |
+
+item_version_id
+ |
+String
+ |
+Version ID of the subscription algorithm. This parameter must be used together with subscription_id.
+ |
+
+code_dir
+ |
+String
+ |
+Code directory of a training job, for example, /usr/app/. This parameter must be used together with boot_file. If id or subscription_id+item_version_id is set, leave it blank.
+ |
+
+boot_file
+ |
+String
+ |
+Boot file of a training job, which needs to be stored in the code directory, for example, /usr/app/boot.py. This parameter must be used together with code_dir. If id or subscription_id+item_version_id is set, leave it blank.
+ |
+
+autosearch_config_path
+ |
+String
+ |
+YAML configuration path of auto search jobs. An OBS URL is required.
+ |
+
+autosearch_framework_path
+ |
+String
+ |
+Framework code directory of auto search jobs. An OBS URL is required.
+ |
+
+command
+ |
+String
+ |
+Boot command used to start the container of the custom image used by a training job. You can set this parameter to code_dir.
+ |
+
+parameters
+ |
+Array of Parameter objects
+ |
+Running parameters of a training job.
+ |
+
+policies
+ |
+policies object
+ |
+Policies supported by jobs.
+ |
+
+inputs
+ |
+Array of Input objects
+ |
+Input of a training job.
+ |
+
+outputs
+ |
+Array of Output objects
+ |
+Output of a training job.
+ |
+
+engine
+ |
+engine object
+ |
+Engine of a training job. Leave this parameter blank if the job is created using id of the algorithm management API or subscription_id+item_version_id of the subscription algorithm API.
+ |
+
+environments
+ |
+Array of Map<String,String> objects
+ |
+Environment variables of a training job. The format is key: value. Leave this parameter blank.
+ |
+
+
+
+
+
+ Table 48 ParameterParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+String
+ |
+Parameter name.
+ |
+
+value
+ |
+String
+ |
+Parameter value.
+ |
+
+description
+ |
+String
+ |
+Parameter description.
+ |
+
+constraint
+ |
+constraint object
+ |
+Parameter constraint.
+ |
+
+i18n_description
+ |
+i18n_description object
+ |
+Internationalization description.
+ |
+
+
+
+
+
+ Table 49 constraintParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+type
+ |
+String
+ |
+Parameter type.
+ |
+
+editable
+ |
+Boolean
+ |
+Whether the parameter is editable.
+ |
+
+required
+ |
+Boolean
+ |
+Whether the parameter is mandatory.
+ |
+
+sensitive
+ |
+Boolean
+ |
+Whether the parameter is sensitive.
+ |
+
+valid_type
+ |
+String
+ |
+Valid type.
+ |
+
+valid_range
+ |
+Array of strings
+ |
+Valid range.
+ |
+
+
+
+
+
+ Table 50 i18n_descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+language
+ |
+String
+ |
+Internationalization language.
+ |
+
+description
+ |
+String
+ |
+Description.
+ |
+
+
+
+
+
+ Table 51 policiesParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+auto_search
+ |
+auto_search object
+ |
+Hyperparameter search configuration.
+ |
+
+
+
+
+
+ Table 52 auto_searchParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+skip_search_params
+ |
+String
+ |
+Hyperparameter parameters that need to be skipped.
+ |
+
+reward_attrs
+ |
+Array of reward_attrs objects
+ |
+List of search metrics.
+ |
+
+search_params
+ |
+Array of search_params objects
+ |
+Search parameters.
+ |
+
+algo_configs
+ |
+Array of algo_configs objects
+ |
+Search algorithm configurations.
+ |
+
+
+
+
+
+ Table 53 reward_attrsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+String
+ |
+Metric name.
+ |
+
+mode
+ |
+String
+ |
+Search direction.
+- max: A larger metric value indicates better performance.
- min: A smaller metric value indicates better performance.
+ |
+
+regex
+ |
+String
+ |
+Regular expression of a metric.
+ |
+
+
+
+
+
+ Table 54 search_paramsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+String
+ |
+Hyperparameter name.
+ |
+
+param_type
+ |
+String
+ |
+Parameter type.
+- continuous: The parameter is a continuous value.
- discreate: The parameter is a discrete value.
+ |
+
+lower_bound
+ |
+String
+ |
+Lower bound of the hyperparameter.
+ |
+
+upper_bound
+ |
+String
+ |
+Upper bound of the hyperparameter.
+ |
+
+discrete_points_num
+ |
+String
+ |
+Number of discrete points of a continuous hyperparameter.
+ |
+
+discrete_values
+ |
+Array of strings
+ |
+List of discrete hyperparameter values.
+ |
+
+
+
+
+
+ Table 55 algo_configsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+String
+ |
+Name of the search algorithm.
+ |
+
+params
+ |
+Array of AutoSearchAlgoConfigParameter objects
+ |
+Search algorithm parameters.
+ |
+
+
+
+
+
+ Table 56 AutoSearchAlgoConfigParameterParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+key
+ |
+String
+ |
+Parameter key.
+ |
+
+value
+ |
+String
+ |
+Parameter value.
+ |
+
+type
+ |
+String
+ |
+Parameter type.
+ |
+
+
+
+
+
+
+
+
+
+ Table 59 datasetParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Dataset ID of a training job.
+ |
+
+version_id
+ |
+String
+ |
+Dataset version ID of a training job.
+ |
+
+obs_url
+ |
+String
+ |
+OBS URL of the dataset required by a training job. ModelArts automatically parses and generates the URL based on the dataset and dataset version IDs. For example, /usr/data/.
+ |
+
+
+
+
+
+ Table 60 obsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs_url
+ |
+String
+ |
+OBS URL of the dataset required by a training job. For example, /usr/data/.
+ |
+
+
+
+
+
+ Table 61 remote_constraintParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+data_type
+ |
+String
+ |
+Data input type, including the data storage location and dataset.
+ |
+
+attributes
+ |
+String
+ |
+Attributes if a dataset is used as the data input. Options:
+- data_format: Data format
- data_segmentation: Data segmentation
- dataset_type: Labeling type
+ |
+
+
+
+
+
+ Table 62 OutputParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+String
+ |
+Name of the data output channel.
+ |
+
+description
+ |
+String
+ |
+Description of the data output channel.
+ |
+
+local_dir
+ |
+String
+ |
+Local directory of the container to which the data output channel is mapped.
+ |
+
+remote
+ |
+remote object
+ |
+Description of the actual data output.
+ |
+
+
+
+
+
+ Table 63 remoteParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs
+ |
+obs object
+ |
+OBS to which data is actually exported.
+ |
+
+
+
+
+
+ Table 64 obsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs_url
+ |
+String
+ |
+OBS URL to which data is actually exported.
+ |
+
+
+
+
+
+ Table 65 engineParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+engine_id
+ |
+String
+ |
+Engine ID selected for a training job. You can set this parameter to engine_id, engine_name + engine_version, or image_url.
+ |
+
+engine_name
+ |
+String
+ |
+Name of the engine selected for a training job. If engine_id is set, leave this parameter blank.
+ |
+
+engine_version
+ |
+String
+ |
+Name of the engine version selected for a training job. If engine_id is set, leave this parameter blank.
+ |
+
+image_url
+ |
+String
+ |
+Custom image URL selected for a training job.
+ |
+
+
+
+
+
+ Table 66 TaskResponseParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+role
+ |
+String
+ |
+Role of a heterogeneous training job. Options:
+- learner: supports GPUs or CPUs.
- worker: supports CPUs.
+ |
+
+algorithm
+ |
+algorithm object
+ |
+Algorithm management and configuration.
+ |
+
+task_resource
+ |
+FlavorResponse object
+ |
+Flavors of a training job or an algorithm.
+ |
+
+
+
+
+
+ Table 67 algorithmParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+code_dir
+ |
+String
+ |
+Absolute path of the directory where the algorithm boot file is stored.
+ |
+
+boot_file
+ |
+String
+ |
+Absolute path of the algorithm boot file.
+ |
+
+inputs
+ |
+inputs object
+ |
+Algorithm input channel.
+ |
+
+outputs
+ |
+outputs object
+ |
+Algorithm output channel.
+ |
+
+engine
+ |
+engine object
+ |
+Engine on which a heterogeneous job depends.
+ |
+
+
+
+
+
+
+
+ Table 69 remoteParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs
+ |
+obs object
+ |
+OBS in which data input and output stored.
+ |
+
+
+
+
+
+ Table 70 obsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs_url
+ |
+String
+ |
+OBS URL of the dataset required by a training job. For example, /usr/data/.
+ |
+
+
+
+
+
+ Table 71 outputsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+String
+ |
+Name of the data output channel.
+ |
+
+local_dir
+ |
+String
+ |
+Local directory of the container to which the data output channel is mapped.
+ |
+
+remote
+ |
+remote object
+ |
+Description of the actual data output.
+ |
+
+mode
+ |
+String
+ |
+Data transmission mode. The default value is upload_periodically.
+ |
+
+period
+ |
+String
+ |
+Data transmission period. The default value is 30s.
+ |
+
+
+
+
+
+ Table 72 remoteParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs
+ |
+obs object
+ |
+OBS to which data is actually exported.
+ |
+
+
+
+
+
+ Table 73 obsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs_url
+ |
+String
+ |
+OBS URL to which data is actually exported.
+ |
+
+
+
+
+
+ Table 74 engineParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+engine_id
+ |
+String
+ |
+Engine ID of a heterogeneous job, for example, caffe-1.0.0-python2.7.
+ |
+
+engine_name
+ |
+String
+ |
+Engine name of a heterogeneous job, for example, Caffe.
+ |
+
+engine_version
+ |
+String
+ |
+Engine version of a heterogeneous job.
+ |
+
+v1_compatible
+ |
+Boolean
+ |
+Whether the v1 compatibility mode is used.
+ |
+
+run_user
+ |
+String
+ |
+User UID started by default by the engine.
+ |
+
+image_url
+ |
+String
+ |
+Custom image URL selected by an algorithm.
+ |
+
+
+
+
+
+ Table 75 FlavorResponseParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+flavor_id
+ |
+String
+ |
+ID of the resource flavor.
+ |
+
+flavor_name
+ |
+String
+ |
+Name of the resource flavor.
+ |
+
+max_num
+ |
+Integer
+ |
+Maximum number of nodes in a resource flavor.
+ |
+
+flavor_type
+ |
+String
+ |
+Resource flavor type. Options:
+
+ |
+
+billing
+ |
+billing object
+ |
+Billing information of a resource flavor.
+ |
+
+flavor_info
+ |
+flavor_info object
+ |
+Resource flavor details.
+ |
+
+attributes
+ |
+Map<String,String>
+ |
+Other specification attributes.
+ |
+
+
+
+
+
+ Table 76 billingParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+code
+ |
+String
+ |
+Billing code.
+ |
+
+unit_num
+ |
+Integer
+ |
+Number of billing units.
+ |
+
+
+
+
+
+ Table 77 flavor_infoParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+max_num
+ |
+Integer
+ |
+Maximum number of nodes that can be selected. The value 1 indicates that the distributed mode is not supported.
+ |
+
+cpu
+ |
+cpu object
+ |
+CPU specifications.
+ |
+
+gpu
+ |
+gpu object
+ |
+GPU specifications.
+ |
+
+npu
+ |
+npu object
+ |
+Ascend flavors.
+ |
+
+memory
+ |
+memory object
+ |
+Memory information.
+ |
+
+
+
+
+
+ Table 78 cpuParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+arch
+ |
+String
+ |
+CPU architecture.
+ |
+
+core_num
+ |
+Integer
+ |
+Number of cores.
+ |
+
+
+
+
+
+ Table 79 gpuParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+unit_num
+ |
+Integer
+ |
+Number of GPUs.
+ |
+
+product_nume
+ |
+String
+ |
+Product name.
+ |
+
+memory
+ |
+String
+ |
+Memory.
+ |
+
+
+
+
+
+ Table 80 npuParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+unit_num
+ |
+String
+ |
+Number of NPUs.
+ |
+
+product_name
+ |
+String
+ |
+Product name.
+ |
+
+memory
+ |
+String
+ |
+Memory.
+ |
+
+
+
+
+
+ Table 81 memoryParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+size
+ |
+Integer
+ |
+Memory size.
+ |
+
+unit
+ |
+String
+ |
+Number of memory units.
+ |
+
+
+
+
+
+ Table 82 specParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+resource
+ |
+Resource object
+ |
+Resource flavors of a training job. Select either flavor_id or pool_id+[flavor_id].
+ |
+
+volumes
+ |
+Array of volumes objects
+ |
+Volumes attached to a training job.
+ |
+
+log_export_path
+ |
+log_export_path object
+ |
+Export path of training job logs.
+ |
+
+
+
+
+
+ Table 83 ResourceParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+policy
+ |
+String
+ |
+Resource flavor of a training job. Options: regular
+ |
+
+flavor_id
+ |
+String
+ |
+Resource flavor ID of a training job.
+ |
+
+flavor_name
+ |
+String
+ |
+Read-only flavor name returned by ModelArts when flavor_id is used.
+ |
+
+node_count
+ |
+Integer
+ |
+Number of resource replicas selected for a training job.
+Minimum: 1
+ |
+
+pool_id
+ |
+String
+ |
+Resource pool ID selected for a training job.
+ |
+
+flavor_detail
+ |
+flavor_detail object
+ |
+Flavors of a training job or an algorithm.
+ |
+
+
+
+
+
+ Table 84 flavor_detailParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+flavor_type
+ |
+String
+ |
+Resource flavor type. Options:
+
+ |
+
+billing
+ |
+billing object
+ |
+Billing information of a resource flavor.
+ |
+
+flavor_info
+ |
+flavor_info object
+ |
+Resource flavor details.
+ |
+
+
+
+
+
+ Table 85 billingParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+code
+ |
+String
+ |
+Billing code.
+ |
+
+unit_num
+ |
+Integer
+ |
+Number of billing units.
+ |
+
+
+
+
+
+ Table 86 flavor_infoParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+max_num
+ |
+Integer
+ |
+Maximum number of nodes that can be selected. The value 1 indicates that the distributed mode is not supported.
+ |
+
+cpu
+ |
+cpu object
+ |
+CPU specifications.
+ |
+
+gpu
+ |
+gpu object
+ |
+GPU specifications.
+ |
+
+npu
+ |
+npu object
+ |
+Ascend flavors.
+ |
+
+memory
+ |
+memory object
+ |
+Memory information.
+ |
+
+disk
+ |
+disk object
+ |
+Disk information.
+ |
+
+
+
+
+
+ Table 87 cpuParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+arch
+ |
+String
+ |
+CPU architecture.
+ |
+
+core_num
+ |
+Integer
+ |
+Number of cores.
+ |
+
+
+
+
+
+ Table 88 gpuParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+unit_num
+ |
+Integer
+ |
+Number of GPUs.
+ |
+
+product_nume
+ |
+String
+ |
+Product name.
+ |
+
+memory
+ |
+String
+ |
+Memory.
+ |
+
+
+
+
+
+ Table 89 npuParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+unit_num
+ |
+String
+ |
+Number of NPUs.
+ |
+
+product_name
+ |
+String
+ |
+Product name.
+ |
+
+memory
+ |
+String
+ |
+Memory.
+ |
+
+
+
+
+
+ Table 90 memoryParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+size
+ |
+Integer
+ |
+Memory size.
+ |
+
+unit
+ |
+String
+ |
+Number of memory units.
+ |
+
+
+
+
+
+ Table 91 diskParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+size
+ |
+String
+ |
+Disk size.
+ |
+
+unit
+ |
+String
+ |
+Unit of the disk size. Generally, the value is GB.
+ |
+
+
+
+
+
+ Table 92 volumesParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+nfs
+ |
+nfs object
+ |
+Volumes attached in NFS mode.
+ |
+
+
+
+
+
+ Table 93 nfsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+nfs_server_path
+ |
+String
+ |
+NFS server path.
+ |
+
+local_path
+ |
+String
+ |
+Path for attaching volumes to the training container.
+ |
+
+read_only
+ |
+Boolean
+ |
+Whether the volumes attached to the container in NFS mode are read-only.
+ |
+
+
+
+
+
+ Table 94 log_export_pathParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+obs_url
+ |
+String
+ |
+OBS URL for storing training job logs.
+ |
+
+host_path
+ |
+String
+ |
+Path of the host where training job logs are stored.
+ |
+
+
+
+
+
+ Example Requests- The following shows how to create a training job named TestModelArtsJob. The training job is described as This is a ModelArts job, the ID of the dependency algorithm is 3f5d6706-7b67-408d-8ba0-ec08048c45ed, no input or output is specified, and a free GPU flavor is used.
POST https://endpoint/v2/{project_id}/training-jobs
+
+{
+ "kind" : "job",
+ "metadata" : {
+ "name" : "TestModelArtsJob",
+ "description" : "This is a ModelArts job"
+ },
+ "algorithm" : {
+ "id" : "3f5d6706-7b67-408d-8ba0-ec08048c45ed",
+ "parameters" : [ {
+ "name" : "input_dir",
+ "value" : "obs://xxx/test/moxingtest-dir/"
+ }, {
+ "name" : "input_file",
+ "value" : "obs://xxx/test/moxingtest/"
+ }, {
+ "name" : "large_file_method",
+ "value" : "1"
+ } ],
+ "inputs" : [ ],
+ "outputs" : [ ],
+ "policies" : {
+ "auto_search" : null
+ },
+ "environments" : { }
+ },
+ "spec" : {
+ "resource" : {
+ "policy" : "regular",
+ "flavor_id" : "modelarts.p3.large.public.free",
+ "node_count" : 1
+ },
+ "log_export_path" : {
+ "obs_url" : ""
+ }
+ }
+}
+ - The following shows how to use a custom image to create a training job named TestModelArtsJob2 described as This is a ModelArts job2. The target instance is deployed in a dedicated resource pool and is attached with an NFS.
POST https://endpoint/v2/{project_id}/training-jobs
+
+{
+ "kind" : "job",
+ "metadata" : {
+ "name" : "TestModelArtsJob2",
+ "description" : "This is a ModelArts job2"
+ },
+ "algorithm" : {
+ "engine" : {
+ "image_url" : "hwstaff_z00424192/fastseq:1.2"
+ },
+ "command" : "cd /home/ma-user/ddp_demo && sh run_ddp.sh",
+ "parameters" : [ ],
+ "inputs" : [ ],
+ "outputs" : [ ],
+ "policies" : {
+ "auto_search" : null
+ },
+ "environments" : {
+ "NCCL_DEBUG" : "INFO",
+ "NCCL_IB_DISABLE" : "0"
+ }
+ },
+ "spec" : {
+ "resource" : {
+ "policy" : "regular",
+ "flavor_id" : "modelarts.pool.visual.xlarge",
+ "node_count" : 1,
+ "pool_id" : "poolfaf38d76"
+ },
+ "log_export_path" : {
+ "obs_url" : "/xxx/limou/ddp-demo-log/"
+ },
+ "volumes" : [ {
+ "nfs" : {
+ "nfs_server_path" : "192.168.0.82:/",
+ "local_path" : "/home/ma-user/nfs/",
+ "read_only" : false
+ }
+ } ]
+ }
+}
+
+
+ Example ResponsesStatus code: 201
+ ok
+ {
+ "kind" : "job",
+ "metadata" : {
+ "id" : "425b7087-83de-49ed-9e40-5bb642be956f",
+ "name" : "TestModelArtsJob",
+ "description" : "This is a ModelArts job",
+ "create_time" : 1637045545982,
+ "workspace_id" : "0",
+ "ai_project" : "default-ai-project",
+ "user_name" : ""
+ },
+ "status" : {
+ "phase" : "Creating",
+ "secondary_phase" : "Creating",
+ "duration" : 0,
+ "start_time" : 0,
+ "node_count_metrics" : null,
+ "tasks" : [ "worker-0", "server-0" ]
+ },
+ "algorithm" : {
+ "id" : "3f5d6706-7b67-408d-8ba0-ec08048c45ed",
+ "name" : "ttt-obs-gpu",
+ "code_dir" : "/xxx/test/moxingtest-code/",
+ "boot_file" : "/xxx/test/moxingtest-code/test_obs_gpu.py",
+ "parameters" : [ {
+ "name" : "input_dir",
+ "description" : "",
+ "i18n_description" : null,
+ "value" : "s://xxx/test/moxingtest-dir/",
+ "constraint" : {
+ "type" : "String",
+ "editable" : true,
+ "required" : true,
+ "sensitive" : false,
+ "valid_type" : "None",
+ "valid_range" : [ ]
+ }
+ }, {
+ "name" : "input_file",
+ "description" : "",
+ "i18n_description" : null,
+ "value" : "obs://cxxx/test/moxingtest/",
+ "constraint" : {
+ "type" : "String",
+ "editable" : true,
+ "required" : true,
+ "sensitive" : false,
+ "valid_type" : "None",
+ "valid_range" : [ ]
+ }
+ }, {
+ "name" : "large_file_method",
+ "description" : "",
+ "i18n_description" : null,
+ "value" : "1",
+ "constraint" : {
+ "type" : "Integer",
+ "editable" : true,
+ "required" : true,
+ "sensitive" : false,
+ "valid_type" : "None",
+ "valid_range" : [ ]
+ }
+ } ],
+ "parameters_customization" : false,
+ "engine" : {
+ "engine_id" : "horovod-cp36-tf-1.16.2",
+ "engine_name" : "Horovod",
+ "engine_version" : "0.16.2-TF-1.13.1-python3.6",
+ "usage" : "training",
+ "support_groups" : "public,roma",
+ "v1_compatible" : true,
+ "run_user" : ""
+ },
+ "policies" : { }
+ },
+ "spec" : {
+ "resource" : {
+ "policy" : "regular",
+ "turbo_range" : [ 1, 2 ],
+ "flavor_id" : "modelarts.p3.large.public.free",
+ "flavor_name" : "Computing GPU(V100) instance",
+ "node_count" : 1,
+ "flavor_detail" : {
+ "flavor_type" : "GPU",
+ "billing" : {
+ "code" : "modelarts.vm.gpu.free",
+ "unit_num" : 1
+ },
+ "attributes" : {
+ "is_free" : "true",
+ "max_free_job_count" : "10"
+ },
+ "flavor_info" : {
+ "cpu" : {
+ "arch" : "x86",
+ "core_num" : 8
+ },
+ "gpu" : {
+ "unit_num" : 1,
+ "product_name" : "NVIDIA-V100",
+ "memory" : "32GB"
+ },
+ "memory" : {
+ "size" : 64,
+ "unit" : "GB"
+ }
+ }
+ }
+ },
+ "log_export_path" : { },
+ "is_hosted_log" : true
+ }
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+201
+ |
+ok
+ |
+
+
+
+
+
+
+ Creating a Labeling Team Member
+FunctionThis API is used to create a labeling team member.
+
+ URIPOST /v2/{project_id}/workforces/{workforce_id}/workers
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+ |
+
+workforce_id
+ |
+Yes
+ |
+String
+ |
+ID of a labeling team.
+ |
+
+
+
+
+
+ Request Parameters
+ Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+description
+ |
+No
+ |
+String
+ |
+Member description. The description contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'
+ |
+
+emails
+ |
+Yes
+ |
+String
+ |
+Email address of a labeling team member.
+ |
+
+role
+ |
+Yes
+ |
+Integer
+ |
+Member role. The options are as follows:
+0: labeling personnel
+1: reviewer
+2: team administrator
+
+ |
+
+
+
+
+
+ Response ParametersNone
+
+ Example RequestsCreating a Labeling Team Member
+ {
+ "emails" : "xxx@xxx.com",
+ "description" : "",
+ "role" : "2"
+}
+
+ Example ResponsesStatus code: 201
+ Created
+ { }
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+201
+ |
+Created
+ |
+
+401
+ |
+Unauthorized
+ |
+
+403
+ |
+Forbidden
+ |
+
+404
+ |
+Not Found
+ |
+
+
+
+
+
+
+ Creating a Labeling Team
+FunctionThis API is used to create a labeling team.
+
+ URIPOST /v2/{project_id}/workforces
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+ |
+
+
+
+
+
+ Request Parameters
+ Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+description
+ |
+No
+ |
+String
+ |
+Labeling team description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'
+ |
+
+workforce_name
+ |
+Yes
+ |
+String
+ |
+Labeling team name. The value contains 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).
+ |
+
+
+
+
+
+ Response ParametersStatus code: 201
+
+ Table 3 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+workforce_id
+ |
+String
+ |
+ID of a labeling team.
+ |
+
+
+
+
+
+ Example RequestsCreating a Labeling Team
+ {
+ "workforce_name" : "team-123",
+ "description" : "my team"
+}
+
+ Example ResponsesStatus code: 201
+ Created
+ {
+ "workforce_id" : "ZUH8gqkjuaib8pxkDdz"
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+201
+ |
+Created
+ |
+
+401
+ |
+Unauthorized
+ |
+
+403
+ |
+Forbidden
+ |
+
+404
+ |
+Not Found
+ |
+
+
+
+
+
+
+ Creating a Team Labeling Task
+FunctionThis API is used to create a team labeling task.
+
+ URIPOST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+dataset_id
+ |
+Yes
+ |
+String
+ |
+Dataset ID.
+ |
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+ |
+
+
+
+
+
+ Request Parameters
+ Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+auto_sync_dataset
+ |
+No
+ |
+Boolean
+ |
+Whether to automatically synchronize the result of a team labeling task to the dataset. The options are as follows:
+- true: Automatically synchronize the result of a team labeling task to the dataset. (Default value)
- false: Do not automatically synchronize the result of a team labeling task to the dataset.
+ |
+
+data_sync_type
+ |
+No
+ |
+Integer
+ |
+Synchronization type. The options are as follows:
+- 0: not to be synchronized
- 1: data to be synchronized
- 2: label to be synchronized
- 3: data and label to be synchronized
+ |
+
+repetition
+ |
+No
+ |
+Integer
+ |
+Number of persons who label each sample in a team labeling task. The minimum value is 1.
+ |
+
+sample_conditions
+ |
+No
+ |
+String
+ |
+Search conditions of dataset samples. Samples that meet the conditions are filtered for team labeling.
+ |
+
+synchronize_auto_labeling_data
+ |
+No
+ |
+Boolean
+ |
+Whether to synchronize the auto labeling result of a team labeling task. The options are as follows:
+- true: Synchronize the results to be confirmed to team members after auto labeling is complete.
- false: Do not synchronize the auto labeling results. (Default value)
+ |
+
+workforces_config
+ |
+No
+ |
+WorkforcesConfig object
+ |
+Team labeling task information: Tasks can be assigned by the team administrator or a specified team.
+ |
+
+
+
+
+
+ Table 3 WorkforcesConfigParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+agency
+ |
+No
+ |
+String
+ |
+Team administrator.
+ |
+
+workforces
+ |
+No
+ |
+Array of WorkforceConfig objects
+ |
+List of teams that execute labeling tasks.
+ |
+
+
+
+
+
+ Table 4 WorkforceConfigParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+workers
+ |
+No
+ |
+Array of Worker objects
+ |
+List of labeling team members.
+ |
+
+workforce_id
+ |
+No
+ |
+String
+ |
+ID of a labeling team.
+ |
+
+workforce_name
+ |
+No
+ |
+String
+ |
+Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"'
+ |
+
+
+
+
+
+ Table 5 WorkerParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+create_time
+ |
+No
+ |
+Long
+ |
+Creation time.
+ |
+
+description
+ |
+No
+ |
+String
+ |
+Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'
+ |
+
+email
+ |
+No
+ |
+String
+ |
+Email address of a labeling team member.
+ |
+
+role
+ |
+No
+ |
+Integer
+ |
+Role. The options are as follows:
+- 0: labeling personnel
- 1: reviewer
- 2: team administrator
- 3: dataset owner
+ |
+
+status
+ |
+No
+ |
+Integer
+ |
+Current login status of a labeling team member. The options are as follows:
+- 0: The invitation email has not been sent.
- 1: The invitation email has been sent but the user has not logged in.
- 2: The user has logged in.
- 3: The labeling team member has been deleted.
+ |
+
+update_time
+ |
+No
+ |
+Long
+ |
+Update time.
+ |
+
+worker_id
+ |
+No
+ |
+String
+ |
+ID of a labeling team member.
+ |
+
+workforce_id
+ |
+No
+ |
+String
+ |
+ID of a labeling team.
+ |
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 6 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+task_id
+ |
+String
+ |
+ID of a team labeling task.
+ |
+
+
+
+
+
+ Example RequestsCreating a Team Labeling Task
+ {
+ "workspace_id" : "0",
+ "task_name" : "task-eb17",
+ "task_type" : 0,
+ "description" : "",
+ "version_id" : "",
+ "labels" : [ {
+ "name" : "Cat",
+ "type" : 0,
+ "property" : {
+ "@modelarts:color" : "#3399ff"
+ }
+ }, {
+ "name" : "Rabbit",
+ "type" : 0,
+ "property" : {
+ "@modelarts:color" : "#3399ff"
+ }
+ } ],
+ "synchronize_data" : false,
+ "synchronize_auto_labeling_data" : false,
+ "workforces_config" : {
+ "workforces" : [ {
+ "workforce_id" : "feSUo5NUIUnQAQNNTiS",
+ "workers" : [ {
+ "email" : "xxx@xxx.com"
+ }, {
+ "email" : "xxx@xxx.com"
+ }, {
+ "email" : "xxx@xxx.com"
+ } ]
+ } ]
+ },
+ "auto_sync_dataset" : false
+}
+
+ Example ResponsesStatus code: 200
+ OK
+ {
+ "task_id" : "6phXEto29utpaMwbQkg"
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+OK
+ |
+
+401
+ |
+Unauthorized
+ |
+
+403
+ |
+Forbidden
+ |
+
+404
+ |
+Not Found
+ |
+
+
+
+
+
+
+ Deleting an Algorithm
+FunctionThis API is used to delete an algorithm.
+
+ URIDELETE /v2/{project_id}/algorithms/{algorithm_id}
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID.
+ |
+
+algorithm_id
+ |
+Yes
+ |
+String
+ |
+Algorithm ID.
+ |
+
+
+
+
+
+
+ Response ParametersNone
+
+ Example RequestsThe following shows how to modify the algorithm whose UUID is 2e5451fe-913f-4492-821a-2981031382f7.
+ DELETE https://endpoint/v2/{project_id}/algorithms/2e5451fe-913f-4492-821a-2981031382f7
+
+ Example ResponsesStatus code: 202
+ No Content
+ null
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+202
+ |
+No Content
+ |
+
+
+
+
+
+
+ Deleting Authorization
-FunctionThis API is used to delete the authorization of a specified user or all users.
+ FunctionThis API is used to delete the authorization of a specified user or all users.
URIDELETE /v2/{project_id}/authorizations
@@ -65,7 +65,7 @@
}
Status Codes
- Status Code
+Status Code
|
Description
|
@@ -105,7 +105,7 @@
diff --git a/docs/modelarts/api-ref/DeleteDataset.html b/docs/modelarts/api-ref/DeleteDataset.html
index c14174aa..92489809 100644
--- a/docs/modelarts/api-ref/DeleteDataset.html
+++ b/docs/modelarts/api-ref/DeleteDataset.html
@@ -1,7 +1,7 @@
Deleting a Dataset
-FunctionThis API is used to delete a dataset without deleting the source data of the dataset.
+ FunctionThis API is used to delete a dataset without deleting the source data of the dataset.
URIDELETE /v2/{project_id}/datasets/{dataset_id}
diff --git a/docs/modelarts/api-ref/DeleteDatasetVersion.html b/docs/modelarts/api-ref/DeleteDatasetVersion.html
index 5ba51c16..1a9b0d20 100644
--- a/docs/modelarts/api-ref/DeleteDatasetVersion.html
+++ b/docs/modelarts/api-ref/DeleteDatasetVersion.html
@@ -1,7 +1,7 @@
Deleting a Dataset Labeling Version
- FunctionThis API is used to delete a dataset labeling version.
+ FunctionThis API is used to delete a dataset labeling version.
URIDELETE /v2/{project_id}/datasets/{dataset_id}/versions/{version_id}
diff --git a/docs/modelarts/api-ref/DeleteLabelAndSamples.html b/docs/modelarts/api-ref/DeleteLabelAndSamples.html
index ae98fbcc..9755eb6c 100644
--- a/docs/modelarts/api-ref/DeleteLabelAndSamples.html
+++ b/docs/modelarts/api-ref/DeleteLabelAndSamples.html
@@ -1,7 +1,7 @@
Deleting a Label and the Files that Only Contain the Label
- FunctionThis API is used to delete a label and the files that only contain this label.
+ FunctionThis API is used to delete a label and the files that only contain this label.
URIDELETE /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/{label_name}
@@ -172,7 +172,7 @@
diff --git a/docs/modelarts/api-ref/DeleteLabels.html b/docs/modelarts/api-ref/DeleteLabels.html
index 0994ac77..64a31344 100644
--- a/docs/modelarts/api-ref/DeleteLabels.html
+++ b/docs/modelarts/api-ref/DeleteLabels.html
@@ -1,7 +1,7 @@
Deleting Labels in Batches
- FunctionThis API is used to delete labels in batches.
+ FunctionThis API is used to delete labels in batches.
URIPOST /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/delete
@@ -449,7 +449,7 @@
diff --git a/docs/modelarts/api-ref/DeleteNotebook.html b/docs/modelarts/api-ref/DeleteNotebook.html
new file mode 100644
index 00000000..989c5db6
--- /dev/null
+++ b/docs/modelarts/api-ref/DeleteNotebook.html
@@ -0,0 +1,466 @@
+
+
+ Deleting a Notebook Instance
+ FunctionThis API is used to delete the container and all storage resources of a notebook instance.
+
+
+ URIDELETE /v1/{project_id}/notebooks/{id}
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+Yes
+ |
+String
+ |
+Notebook instance ID.
+ |
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID.
+ |
+
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 2 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+action_progress
+ |
+Array of JobProgress objects
+ |
+Instance initialization progress.
+ |
+
+description
+ |
+String
+ |
+Instance description
+ |
+
+endpoints
+ |
+Array of EndpointsRes objects
+ |
+Local IDE (such as PyCharm and vsCode) or SSH client for remotely accessing a notebook instance through SSH.
+ |
+
+fail_reason
+ |
+String
+ |
+Instance failure cause
+ |
+
+feature
+ |
+String
+ |
+Instance type. Options: - DEFAULT: free CodeLab instance. You can create only one. - NOTEBOOK: billed instance.
+ |
+
+flavor
+ |
+String
+ |
+Instance flavor
+ |
+
+id
+ |
+String
+ |
+Instance ID.
+ |
+
+image
+ |
+Image object
+ |
+Instance image
+ |
+
+lease
+ |
+Lease object
+ |
+Countdown to automatic instance stop.
+ |
+
+name
+ |
+String
+ |
+Instance name
+ |
+
+pool
+ |
+Pool object
+ |
+Basic information about the dedicated pool, which is returned by the instance created in the dedicated pool.
+ |
+
+status
+ |
+String
+ |
+Instance status Options: \r\n-INIT: The instance is being initialized. \r\n-CREATING: The instance is being created. \r\n-STARTING: The instance is starting. \r\n-STOPPING: The instance is stopping. \r\n-DELETING: The instance is being deleted.\r\n-RUNNING: The instance is running.\r\n-STOPPED: The instance is stopped.\r\n-SNAPSHOTTING: A snapshot is being taken for the instance (status when the image is being saved).\r\n-CREATE_FAILED: The instance fails to be created. \r\n-START_FAILED: The instance fails to be started. \r\n-DELETE_FAILED: The instance fails to be deleted.\r\n-ERROR: An error occurs. \r\n-DELETED: The instance is deleted. \r\n-FROZEN: The instance is frozen.
+ |
+
+token
+ |
+String
+ |
+Token used for notebook authentication
+ |
+
+url
+ |
+String
+ |
+URL for accessing the notebook instance
+ |
+
+volume
+ |
+VolumeRes object
+ |
+Storage volume
+ |
+
+workspace_id
+ |
+String
+ |
+Workspace ID. If no workspaces are available, the default value is 0.
+ |
+
+
+
+
+
+ Table 3 JobProgressParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+notebook_id
+ |
+String
+ |
+Instance ID.
+ |
+
+status
+ |
+String
+ |
+Job status in a specified step. Options: - WAITING: The job is waiting to begin. - PROCESSING: The job is being processed. - FAILED: The job failed. - COMPLETED: The task is complete.
+ |
+
+step
+ |
+Integer
+ |
+Job step. Options: - 1: Storage preparation. - 2: Computing resource preparation. - 3: Network configurations. - 4: Instance initialization.
+ |
+
+step_description
+ |
+String
+ |
+Description of a step in a job.
+ |
+
+
+
+
+
+ Table 4 EndpointsResParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+allowed_access_ips
+ |
+Array of strings
+ |
+Whitelist of public IP addresses that are allowed to access the notebook instance through SSH. By default, all public IP addresses can access the notebook instance. If this parameter is specified, only the clients with the specified IP addresses can access the notebook instance.
+ |
+
+dev_service
+ |
+String
+ |
+Supported services. Options: - NOTEBOOK: You can access the notebook instance using HTTPS.- SSH: You can remotely access the notebook instance through SSH.
+ |
+
+ssh_keys
+ |
+Array of strings
+ |
+List of SSH key pairs. You can set multiple key pairs to access an SSH instance at the same time.
+ |
+
+
+
+
+
+ Table 5 ImageParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Image ID
+ |
+
+name
+ |
+String
+ |
+Image name.
+ |
+
+swr_path
+ |
+String
+ |
+SWR image address
+ |
+
+type
+ |
+String
+ |
+Image type. Options: - BUILD_IN: built-in system image- DEDICATED: image saved by the user
+ |
+
+
+
+
+
+ Table 6 LeaseParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+create_time
+ |
+Long
+ |
+Time (UTC) when the instance is created, accurate to millisecond.
+ |
+
+duration
+ |
+Long
+ |
+Instance running duration, which is calculated based on the instance creation time. If the instance creation time plus the duration is greater than the current time, the system automatically stops the instance.
+ |
+
+enable
+ |
+Boolean
+ |
+Whether to enable auto stop of the instance.
+ |
+
+update_time
+ |
+Long
+ |
+Time (UTC) when the instance is last updated (excluding the keepalive heartbeat time), accurate to millisecond.
+ |
+
+
+
+
+
+ Table 7 PoolParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+ID of a dedicated resource pool
+ |
+
+name
+ |
+String
+ |
+Name of a dedicated resource pool
+ |
+
+
+
+
+
+ Table 8 VolumeResParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+capacity
+ |
+Integer
+ |
+Storage capacity. The default value is 5 GB for EVS and 50 GB for EFS. The maximum value is 4,096 GB.
+ |
+
+category
+ |
+String
+ |
+Storage category. Options: \r\n-EFS: Scalable File Service (SFS), which is the default storage. \r\n-EVS: Elastic Volume Service (EVS). \r\n\r\n For details about the differences between the two types of storage, see Selecting a Storage Type in DevEnviron.\r\n.\r\n\r\n\r\n\r\n
+ |
+
+mount_path
+ |
+String
+ |
+Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is /home/ma-user/work/.
+ |
+
+ownership
+ |
+String
+ |
+Owner to which the resource belongs. Options: - MANAGED: Resources are managed by services.- DEDICATED: Resources are managed by the user account. This mode is supported only when the instance category is EFS.
+ |
+
+status
+ |
+String
+ |
+EVS disk capacity expansion status, which is RESIZING during capacity expansion and does not affect the instance.
+ |
+
+
+
+
+
+
+ Example ResponsesStatus code: 200
+ OK
+ {
+ "create_at" : 1638841805440,
+ "description" : "update",
+ "feature" : "DEFAULT",
+ "flavor" : "modelarts.vm.cpu.free",
+ "id" : "f9937afa-ca78-45b6-bc12-7ecf42553c48",
+ "image" : {
+ "description" : "description",
+ "id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
+ "name" : "notebook2.0-mul-kernel-cpu-cp36",
+ "swr_path" : ".xxxx.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.2-release_v1",
+ "tag" : "3.3.2-release_v1",
+ "type" : "BUILD_IN"
+ },
+ "lease" : {
+ "create_at" : 1638841805439,
+ "duration" : 3600000,
+ "enable" : true,
+ "update_at" : 1638841805439
+ },
+ "name" : "notebook_5ee4bf0e",
+ "status" : "DELETING",
+ "token" : "58ba50c6-e8ff-245c-4840-49e51aa70737",
+ "update_at" : 1638842504178,
+ "workspace_id" : "0"
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+OK
+ |
+
+204
+ |
+No Content
+ |
+
+401
+ |
+Unauthorized
+ |
+
+403
+ |
+Forbidden
+ |
+
+
+
+
+
+
+
+
+
diff --git a/docs/modelarts/api-ref/DeleteProcessorTask.html b/docs/modelarts/api-ref/DeleteProcessorTask.html
new file mode 100644
index 00000000..8fed960a
--- /dev/null
+++ b/docs/modelarts/api-ref/DeleteProcessorTask.html
@@ -0,0 +1,85 @@
+
+
+ Deleting a Processing Task
+ FunctionThis API is used to delete a processing task. You can delete feature analysis tasks and data processing tasks. A specific task can be deleted by specifying the task_id path parameter.
+
+ URIDELETE /v2/{project_id}/processor-tasks/{task_id}
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+ |
+
+task_id
+ |
+Yes
+ |
+String
+ |
+ID of a data processing task.
+ |
+
+
+
+
+
+
+ Response ParametersNone
+
+ Example RequestsDeleting a Data Processing Task
+ DELETE https://{endpoint}/v2/{project_id}/processor-tasks/{task_id}
+
+ Example ResponsesStatus code: 200
+ OK
+ { }
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+OK
+ |
+
+401
+ |
+Unauthorized
+ |
+
+403
+ |
+Forbidden
+ |
+
+
+
+
+
+
+
+
+
diff --git a/docs/modelarts/api-ref/DeleteProcessorTaskVersion.html b/docs/modelarts/api-ref/DeleteProcessorTaskVersion.html
new file mode 100644
index 00000000..c3fbabb7
--- /dev/null
+++ b/docs/modelarts/api-ref/DeleteProcessorTaskVersion.html
@@ -0,0 +1,94 @@
+
+
+ Deleting a Data Processing Task Version
+ FunctionThis API is used to delete a data processing task version.
+
+ URIDELETE /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id}
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+ |
+
+task_id
+ |
+Yes
+ |
+String
+ |
+ID of a data processing task.
+ |
+
+version_id
+ |
+Yes
+ |
+String
+ |
+Version ID of a data processing task.
+ |
+
+
+
+
+
+
+ Response ParametersNone
+
+ Example RequestsDeleting a Data Processing Task Version
+ DELETE https://{endpoint}/v2/{project_id}/processor-tasks/{task_id}/versions/{version_id}
+
+ Example ResponsesStatus code: 204
+ No Content
+ { }
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+204
+ |
+No Content
+ |
+
+401
+ |
+Unauthorized
+ |
+
+403
+ |
+Forbidden
+ |
+
+
+
+
+
+
+
+
+
diff --git a/docs/modelarts/api-ref/DeleteSamples.html b/docs/modelarts/api-ref/DeleteSamples.html
index 3ebb38d8..e1dfbca6 100644
--- a/docs/modelarts/api-ref/DeleteSamples.html
+++ b/docs/modelarts/api-ref/DeleteSamples.html
@@ -1,7 +1,7 @@
Deleting Samples in Batches
- FunctionThis API is used to delete samples in batches.
+ FunctionThis API is used to delete samples in batches.
URIPOST /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/delete
diff --git a/docs/modelarts/api-ref/DeleteTrainingJob.html b/docs/modelarts/api-ref/DeleteTrainingJob.html
new file mode 100644
index 00000000..a478ca7b
--- /dev/null
+++ b/docs/modelarts/api-ref/DeleteTrainingJob.html
@@ -0,0 +1,75 @@
+
+
+ Deleting a Training Job
+ FunctionThis API is used to delete a training job.
+
+ URIDELETE /v2/{project_id}/training-jobs/{training_job_id}
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID.
+ |
+
+training_job_id
+ |
+Yes
+ |
+String
+ |
+ID of a training job.
+ |
+
+
+
+
+
+
+ Response ParametersNone
+
+ Example RequestsThe following shows how to delete a training job whose UUID is 3faf5c03-aaa1-4cbe-879d-24b05d997347.
+ DELETE https://endpoint/v2/{project_id}/training-jobs/3faf5c03-aaa1-4cbe-879d-24b05d997347
+
+ Example ResponsesStatus code: 202
+ No Content
+ ""
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+202
+ |
+No Content
+ |
+
+
+
+
+
+
+
+
+
diff --git a/docs/modelarts/api-ref/DeleteWorker.html b/docs/modelarts/api-ref/DeleteWorker.html
new file mode 100644
index 00000000..15b739fb
--- /dev/null
+++ b/docs/modelarts/api-ref/DeleteWorker.html
@@ -0,0 +1,94 @@
+
+
+ Deleting a Labeling Team Member
+ FunctionThis API is used to delete a labeling team member.
+
+ URIDELETE /v2/{project_id}/workforces/{workforce_id}/workers/{worker_id}
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+ |
+
+worker_id
+ |
+Yes
+ |
+String
+ |
+ID of a labeling team member.
+ |
+
+workforce_id
+ |
+Yes
+ |
+String
+ |
+ID of a labeling team.
+ |
+
+
+
+
+
+
+ Response ParametersNone
+
+ Example RequestsDeleting a Labeling Team Member
+ DELETE https://{endpoint}/v2/{project_id}/workforces/{workforce_id}/workers/{worker_id}
+
+ Example ResponsesStatus code: 204
+ No Content
+ { }
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+204
+ |
+No Content
+ |
+
+401
+ |
+Unauthorized
+ |
+
+403
+ |
+Forbidden
+ |
+
+
+
+
+
+
+
+
+
diff --git a/docs/modelarts/api-ref/DeleteWorkers.html b/docs/modelarts/api-ref/DeleteWorkers.html
new file mode 100644
index 00000000..bdb3cb3b
--- /dev/null
+++ b/docs/modelarts/api-ref/DeleteWorkers.html
@@ -0,0 +1,200 @@
+
+
+ Deleting Labeling Team Members in Batches
+ FunctionThis API is used to delete labeling team members in batches.
+
+ URIPOST /v2/{project_id}/workforces/{workforce_id}/workers/batch-delete
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+ |
+
+workforce_id
+ |
+Yes
+ |
+String
+ |
+ID of a labeling team.
+ |
+
+
+
+
+
+ Request Parameters
+ Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+workers
+ |
+No
+ |
+Array of strings
+ |
+Team member ID list.
+ |
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 3 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+results
+ |
+Array of BatchResponse objects
+ |
+Result of deleting team members in batches.
+ |
+
+success
+ |
+Boolean
+ |
+Check whether the operation is successful. The options are as follows:
+
+ |
+
+
+
+
+
+ Table 4 BatchResponseParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+success
+ |
+Boolean
+ |
+Check whether the operation is successful. The options are as follows:
+
+ |
+
+
+
+
+
+ Example RequestsDeleting Labeling Team Members in Batches
+ {
+ "workers" : [ "89d4ae38431b8905449821605abdc3a9", "a2abd3f27b4e92c593c15282f8b6bd29" ]
+}
+
+ Example ResponsesStatus code: 200
+ OK
+ {
+ "success" : true,
+ "results" : [ {
+ "success" : true
+ }, {
+ "success" : true
+ } ]
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+OK
+ |
+
+401
+ |
+Unauthorized
+ |
+
+403
+ |
+Forbidden
+ |
+
+404
+ |
+Not Found
+ |
+
+
+
+
+
+
+
+
+
diff --git a/docs/modelarts/api-ref/DeleteWorkforce.html b/docs/modelarts/api-ref/DeleteWorkforce.html
new file mode 100644
index 00000000..66a885f8
--- /dev/null
+++ b/docs/modelarts/api-ref/DeleteWorkforce.html
@@ -0,0 +1,164 @@
+
+
+ Deleting a Labeling Team
+ FunctionThis API is used to delete a labeling team.
+
+ URIDELETE /v2/{project_id}/workforces/{workforce_id}
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+ |
+
+workforce_id
+ |
+Yes
+ |
+String
+ |
+ID of a labeling team.
+ |
+
+
+
+
+
+
+ Response ParametersStatus code: 204
+
+ Table 2 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+results
+ |
+Array of BatchResponse objects
+ |
+Result of deleting team members in batches.
+ |
+
+success
+ |
+Boolean
+ |
+Check whether the operation is successful. The options are as follows:
+
+ |
+
+
+
+
+
+ Table 3 BatchResponseParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+success
+ |
+Boolean
+ |
+Check whether the operation is successful. The options are as follows:
+
+ |
+
+
+
+
+
+ Example RequestsDeleting a Labeling Team
+ DELETE https://{endpoint}/v2/{project_id}/workforces/{workforce_id}
+
+ Example ResponsesStatus code: 204
+ No Content
+ { }
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+204
+ |
+No Content
+ |
+
+401
+ |
+Unauthorized
+ |
+
+403
+ |
+Forbidden
+ |
+
+
+
+
+
+
+
+
+
diff --git a/docs/modelarts/api-ref/DeleteWorkforceTask.html b/docs/modelarts/api-ref/DeleteWorkforceTask.html
new file mode 100644
index 00000000..a8bd8785
--- /dev/null
+++ b/docs/modelarts/api-ref/DeleteWorkforceTask.html
@@ -0,0 +1,94 @@
+
+
+ Deleting a Team Labeling Task
+ FunctionThis API is used to delete a team labeling task.
+
+ URIDELETE /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+dataset_id
+ |
+Yes
+ |
+String
+ |
+Dataset ID.
+ |
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+ |
+
+workforce_task_id
+ |
+Yes
+ |
+String
+ |
+ID of a team labeling task.
+ |
+
+
+
+
+
+
+ Response ParametersNone
+
+ Example RequestsDeleting a Team Labeling Task
+ DELETE https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}
+
+ Example ResponsesStatus code: 204
+ No Content
+ { }
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+204
+ |
+No Content
+ |
+
+401
+ |
+Unauthorized
+ |
+
+403
+ |
+Forbidden
+ |
+
+
+
+
+
+
+
+
+
diff --git a/docs/modelarts/api-ref/DescDataset.html b/docs/modelarts/api-ref/DescDataset.html
index 48064ac8..d5507ffc 100644
--- a/docs/modelarts/api-ref/DescDataset.html
+++ b/docs/modelarts/api-ref/DescDataset.html
@@ -1,1389 +1,1389 @@
Querying Details About a Dataset
- FunctionThis API is used to query details about a dataset.
+ FunctionThis API is used to query details about a dataset.
- URIGET /v2/{project_id}/datasets/{dataset_id}
+ URIGET /v2/{project_id}/datasets/{dataset_id}
- Table 1 Path ParametersParameter
+Table 1 Path ParametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-dataset_id
+ | dataset_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Dataset ID.
+ | Dataset ID.
|
-project_id
+ | project_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+ | Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
|
Table 2 Query ParametersParameter
+Table 2 Query ParametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-check_running_task
+ | check_running_task
|
-No
+ | No
|
-Boolean
+ | Boolean
|
-Whether to detect tasks (including initialization tasks) that are running in a dataset. The options are as follows:
-- true: Detect tasks (including initialization tasks) that are running in the dataset.
- false: Do not detect tasks that are running in the dataset. (Default value)
+ | Whether to detect tasks (including initialization tasks) that are running in a dataset. The options are as follows:
+- true: Detect tasks (including initialization tasks) that are running in the dataset.
- false: Do not detect tasks that are running in the dataset. (Default value)
|
-running_task_type
+ | running_task_type
|
-No
+ | No
|
-Integer
+ | Integer
|
-Type of the running tasks (including initialization tasks) to be detected. The options are as follows:
-- 0: auto labeling
- 1: pre-labeling
- 2: export
- 3: version switch
- 4: manifest file export
- 5: manifest file import
- 6: version publishing
- 7: auto grouping
- 10: one-click model deployment (default value)
+ | Type of the running tasks (including initialization tasks) to be detected. The options are as follows:
+- 0: auto labeling
- 1: pre-labeling
- 2: export
- 3: version switch
- 4: manifest file export
- 5: manifest file import
- 6: version publishing
- 7: auto grouping
- 10: one-click model deployment (default value)
|
Request ParametersNone
+
- Response ParametersStatus code: 200
+ Response ParametersStatus code: 200
- Table 3 Response body parametersParameter
+Table 3 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-annotated_sample_count
+ | annotated_sample_count
|
-Integer
+ | Integer
|
-Number of labeled samples in a dataset.
+ | Number of labeled samples in a dataset.
|
-annotated_sub_sample_count
+ | annotated_sub_sample_count
|
-Integer
+ | Integer
|
-Number of labeled subsamples.
+ | Number of labeled subsamples.
|
-content_labeling
+ | content_labeling
|
-Boolean
+ | Boolean
|
-Whether to enable content labeling for the speech paragraph labeling dataset. This function is enabled by default.
+ | Whether to enable content labeling for the speech paragraph labeling dataset. This function is enabled by default.
|
-create_time
+ | create_time
|
-Long
+ | Long
|
-Time when a dataset is created.
+ | Time when a dataset is created.
|
-current_version_id
+ | current_version_id
|
-String
+ | String
|
-Current version ID of a dataset.
+ | Current version ID of a dataset.
|
-current_version_name
+ | current_version_name
|
-String
+ | String
|
-Current version name of a dataset.
+ | Current version name of a dataset.
|
-data_format
+ | data_format
|
-String
+ | String
|
-Data format.
+ | Data format.
|
-data_sources
+ | data_sources
|
-Array of DataSource objects
+ | Array of DataSource objects
|
-Data source list.
+ | Data source list.
|
-data_statistics
+ | data_statistics
|
-Map<String,Object>
+ | Map<String,Object>
|
-Sample statistics on a dataset, including the statistics on sample metadata.
+ | Sample statistics on a dataset, including the statistics on sample metadata.
|
-data_update_time
+ | data_update_time
|
-Long
+ | Long
|
-Time when a sample and a label are updated.
+ | Time when a sample and a label are updated.
|
-dataset_format
+ | dataset_format
|
-Integer
+ | Integer
|
-Dataset format. The options are as follows:
-
+ | Dataset format. The options are as follows:
+
|
-dataset_id
+ | dataset_id
|
-String
+ | String
|
-Dataset ID.
+ | Dataset ID.
|
-dataset_name
+ | dataset_name
|
-String
+ | String
|
-Dataset name.
+ | Dataset name.
|
-dataset_tags
+ | dataset_tags
|
-Array of strings
+ | Array of strings
|
-Key identifier list of a dataset, for example, ["Image","Object detection"].
+ | Key identifier list of a dataset, for example, ["Image","Object detection"].
|
-dataset_type
+ | dataset_type
|
-Integer
+ | Integer
|
-Dataset type. The options are as follows:
-- 0: image classification
- 1: object detection
- 100: text classification
- 101: named entity recognition
- 102: text triplet
- 200: sound classification
- 201: speech content
- 202: speech paragraph labeling
- 400: table dataset
- 600: video labeling
- 900: custom format
+ | Dataset type. The options are as follows:
+- 0: image classification
- 1: object detection
- 100: text classification
- 101: named entity recognition
- 102: text triplet
- 200: sound classification
- 201: speech content
- 202: speech paragraph labeling
- 400: table dataset
- 600: video labeling
- 900: custom format
|
-dataset_version_count
+ | dataset_version_count
|
-Integer
+ | Integer
|
-Number of dataset versions.
+ | Number of dataset versions.
|
-deleted_sample_count
+ | deleted_sample_count
|
-Integer
+ | Integer
|
-Number of deleted samples.
+ | Number of deleted samples.
|
-deletion_stats
+ | deletion_stats
|
-Map<String,Integer>
+ | Map<String,Integer>
|
-Deletion reason statistics.
+ | Deletion reason statistics.
|
-description
+ | description
|
-String
+ | String
|
-Dataset description.
+ | Dataset description.
|
-enterprise_project_id
+ | enterprise_project_id
|
-String
+ | String
|
-Enterprise project ID.
+ | Enterprise project ID.
|
-exist_running_task
+ | exist_running_task
|
-Boolean
+ | Boolean
|
-Whether the dataset contains running (including initialization) tasks. The options are as follows:
-- true: The dataset contains running tasks.
- false: The dataset does not contain running tasks.
+ | Whether the dataset contains running (including initialization) tasks. The options are as follows:
+- true: The dataset contains running tasks.
- false: The dataset does not contain running tasks.
|
-exist_workforce_task
+ | exist_workforce_task
|
-Boolean
+ | Boolean
|
-Whether the dataset contains team labeling tasks. The options are as follows:
-- true: The dataset contains team labeling tasks.
- false: The dataset does not contain team labeling tasks.
+ | Whether the dataset contains team labeling tasks. The options are as follows:
+- true: The dataset contains team labeling tasks.
- false: The dataset does not contain team labeling tasks.
|
-feature_supports
+ | feature_supports
|
-Array of strings
+ | Array of strings
|
-List of features supported by the dataset. Currently, only the value 0 is supported, indicating that the OBS file size is limited.
+ | List of features supported by the dataset. Currently, only the value 0 is supported, indicating that the OBS file size is limited.
|
-import_data
+ | import_data
|
-Boolean
+ | Boolean
|
-Whether to import data. The options are as follows:
-- true: Import data.
- false: Do not import data.
+ | Whether to import data. The options are as follows:
+- true: Import data.
- false: Do not import data.
|
-import_task_id
+ | import_task_id
|
-String
+ | String
|
-ID of an import task.
+ | ID of an import task.
|
-inner_annotation_path
+ | inner_annotation_path
|
-String
+ | String
|
-Path for storing the labeling result of a dataset.
+ | Path for storing the labeling result of a dataset.
|
-inner_data_path
+ | inner_data_path
|
-String
+ | String
|
-Path for storing the internal data of a dataset.
+ | Path for storing the internal data of a dataset.
|
-inner_log_path
+ | inner_log_path
|
-String
+ | String
|
-Path for storing internal logs of a dataset.
+ | Path for storing internal logs of a dataset.
|
-inner_task_path
+ | inner_task_path
|
-String
+ | String
|
-Path for internal task of a dataset.
+ | Path for internal task of a dataset.
|
-inner_temp_path
+ | inner_temp_path
|
-String
+ | String
|
-Path for storing internal temporary files of a dataset.
+ | Path for storing internal temporary files of a dataset.
|
-inner_work_path
+ | inner_work_path
|
-String
+ | String
|
-Output directory of a dataset.
+ | Output directory of a dataset.
|
-label_task_count
+ | label_task_count
|
-Integer
+ | Integer
|
-Number of labeling tasks.
+ | Number of labeling tasks.
|
-labels
+ | labels
|
-Array of Label objects
+ | Array of Label objects
|
-Dataset label list.
+ | Dataset label list.
|
-loading_sample_count
+ | loading_sample_count
|
-Integer
+ | Integer
|
-Number of loading samples.
+ | Number of loading samples.
|
-managed
+ | managed
|
-Boolean
+ | Boolean
|
-Whether a dataset is hosted. The options are as follows:
-- true: The dataset is hosted.
- false: The dataset is not hosted.
+ | Whether a dataset is hosted. The options are as follows:
+- true: The dataset is hosted.
- false: The dataset is not hosted.
|
-next_version_num
+ | next_version_num
|
-Integer
+ | Integer
|
-Number of next versions of a dataset.
+ | Number of next versions of a dataset.
|
-running_tasks_id
+ | running_tasks_id
|
-Array of strings
+ | Array of strings
|
-ID list of running (including initialization) tasks.
+ | ID list of running (including initialization) tasks.
|
-schema
+ | schema
|
-Array of Field objects
+ | Array of Field objects
|
-Schema list.
+ | Schema list.
|
-status
+ | status
|
-Integer
+ | Integer
|
-Dataset status. The options are as follows:
-- 0: creating dataset
- 1: normal dataset
- 2: deleting dataset
- 3: deleted dataset
- 4: abnormal dataset
- 5: synchronizing dataset
- 6: releasing dataset
- 7: dataset in version switching
- 8: importing dataset
+ | Dataset status. The options are as follows:
+- 0: creating dataset
- 1: normal dataset
- 2: deleting dataset
- 3: deleted dataset
- 4: abnormal dataset
- 5: synchronizing dataset
- 6: releasing dataset
- 7: dataset in version switching
- 8: importing dataset
|
-third_path
+ | third_path
|
-String
+ | String
|
-Third-party path.
+ | Third-party path.
|
-total_sample_count
+ | total_sample_count
|
-Integer
+ | Integer
|
-Total number of dataset samples.
+ | Total number of dataset samples.
|
-total_sub_sample_count
+ | total_sub_sample_count
|
-Integer
+ | Integer
|
-Total number of subsamples generated from the parent samples. For example, the total number of key frame images extracted from the video labeling dataset is that of subsamples.
+ | Total number of subsamples generated from the parent samples. For example, the total number of key frame images extracted from the video labeling dataset is that of subsamples.
|
-unconfirmed_sample_count
+ | unconfirmed_sample_count
|
-Integer
+ | Integer
|
-Number of auto labeling samples to be confirmed.
+ | Number of auto labeling samples to be confirmed.
|
-update_time
+ | update_time
|
-Long
+ | Long
|
-Time when a dataset is updated.
+ | Time when a dataset is updated.
|
-versions
+ | versions
|
-Array of DatasetVersion objects
+ | Array of DatasetVersion objects
|
-Dataset version information. Currently, only the current version information of a dataset is recorded.
+ | Dataset version information. Currently, only the current version information of a dataset is recorded.
|
-work_path
+ | work_path
|
-String
+ | String
|
-Output dataset path, which is used to store output files such as label files. The path is an OBS path in the format of /Bucket name/File path. For example: /obs-bucket.
+ | Output dataset path, which is used to store output files such as label files. The path is an OBS path in the format of /Bucket name/File path. For example: /obs-bucket.
|
-work_path_type
+ | work_path_type
|
-Integer
+ | Integer
|
-Type of the dataset output path. The options are as follows:
-- 0: OBS bucket (default value)
+ | Type of the dataset output path. The options are as follows:
+- 0: OBS bucket (default value)
|
-workforce_descriptor
+ | workforce_descriptor
|
-WorkforceDescriptor object
+ | WorkforceDescriptor object
|
-Team labeling information.
+ | Team labeling information.
|
-workforce_task_count
+ | workforce_task_count
|
-Integer
+ | Integer
|
-Number of team labeling tasks of a dataset.
+ | Number of team labeling tasks of a dataset.
|
-workspace_id
+ | workspace_id
|
-String
+ | String
|
-Workspace ID. If no workspace is created, the default value is 0. If a workspace is created and used, use the actual value.
+ | Workspace ID. If no workspace is created, the default value is 0. If a workspace is created and used, use the actual value.
|
Table 4 DataSourceParameter
+Table 4 DataSourceParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-data_path
+ | data_path
|
-String
+ | String
|
-Data source path.
+ | Data source path.
|
-data_type
+ | data_type
|
-Integer
+ | Integer
|
-Data type. The options are as follows:
-- 0: OBS bucket (default value)
- 1: GaussDB(DWS)
- 2: DLI
- 3: RDS
- 4: MRS
- 5: AI Gallery
- 6: Inference service
+ | Data type. The options are as follows:
+- 0: OBS bucket (default value)
- 1: GaussDB(DWS)
- 2: DLI
- 3: RDS
- 4: MRS
- 5: AI Gallery
- 6: Inference service
|
-schema_maps
+ | schema_maps
|
-Array of SchemaMap objects
+ | Array of SchemaMap objects
|
-Schema mapping information corresponding to the table data.
+ | Schema mapping information corresponding to the table data.
|
-source_info
+ | source_info
|
-SourceInfo object
+ | SourceInfo object
|
-Information required for importing a table data source.
+ | Information required for importing a table data source.
|
-with_column_header
+ | with_column_header
|
-Boolean
+ | Boolean
|
-Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows:
-- true: The first row in the file is the column name.
- false: The first row in the file is not the column name.
+ | Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows:
+- true: The first row in the file is the column name.
- false: The first row in the file is not the column name.
|
Table 5 SchemaMapParameter
+Table 5 SchemaMapParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-dest_name
+ | dest_name
|
-String
+ | String
|
-Name of the destination column.
+ | Name of the destination column.
|
-src_name
+ | src_name
|
-String
+ | String
|
-Name of the source column.
+ | Name of the source column.
|
Table 6 SourceInfoParameter
+Table 6 SourceInfoParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-cluster_id
+ | cluster_id
|
-String
+ | String
|
-ID of an MRS cluster.
+ | ID of an MRS cluster.
|
-cluster_mode
+ | cluster_mode
|
-String
+ | String
|
-Running mode of an MRS cluster. The options are as follows:
-- 0: normal cluster
- 1: security cluster
+ | Running mode of an MRS cluster. The options are as follows:
+- 0: normal cluster
- 1: security cluster
|
-cluster_name
+ | cluster_name
|
-String
+ | String
|
-Name of an MRS cluster.
+ | Name of an MRS cluster.
|
-database_name
+ | database_name
|
-String
+ | String
|
-Name of the database to which the table dataset is imported.
+ | Name of the database to which the table dataset is imported.
|
-input
+ | input
|
-String
+ | String
|
-HDFS path of a table dataset.
+ | HDFS path of a table dataset.
|
-ip
+ | ip
|
-String
+ | String
|
-IP address of your GaussDB(DWS) cluster.
+ | IP address of your GaussDB(DWS) cluster.
|
-port
+ | port
|
-String
+ | String
|
-Port number of your GaussDB(DWS) cluster.
+ | Port number of your GaussDB(DWS) cluster.
|
-queue_name
+ | queue_name
|
-String
+ | String
|
-DLI queue name of a table dataset.
+ | DLI queue name of a table dataset.
|
-subnet_id
+ | subnet_id
|
-String
+ | String
|
-Subnet ID of an MRS cluster.
+ | Subnet ID of an MRS cluster.
|
-table_name
+ | table_name
|
-String
+ | String
|
-Name of the table to which a table dataset is imported.
+ | Name of the table to which a table dataset is imported.
|
-user_name
+ | user_name
|
-String
+ | String
|
-Username, which is mandatory for GaussDB(DWS) data.
+ | Username, which is mandatory for GaussDB(DWS) data.
|
-user_password
+ | user_password
|
-String
+ | String
|
-User password, which is mandatory for GaussDB(DWS) data.
+ | User password, which is mandatory for GaussDB(DWS) data.
|
-vpc_id
+ | vpc_id
|
-String
+ | String
|
-ID of the VPC where an MRS cluster resides.
+ | ID of the VPC where an MRS cluster resides.
|
Table 7 LabelParameter
+Table 7 LabelParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-attributes
+ | attributes
|
-Array of LabelAttribute objects
+ | Array of LabelAttribute objects
|
-Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.
+ | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.
|
-name
+ | name
|
-String
+ | String
|
-Label name.
+ | Label name.
|
-property
+ | property
|
-LabelProperty object
+ | LabelProperty object
|
-Basic attribute key-value pair of a label, such as color and shortcut keys.
+ | Basic attribute key-value pair of a label, such as color and shortcut keys.
|
-type
+ | type
|
-Integer
+ | Integer
|
-Label type. The options are as follows:
-- 0: image classification
- 1: object detection
- 100: text classification
- 101: named entity recognition
- 102: text triplet relationship
- 103: text triplet entity
- 200: speech classification
- 201: speech content
- 202: speech paragraph labeling
- 600: video classification
+ | Label type. The options are as follows:
+- 0: image classification
- 1: object detection
- 100: text classification
- 101: named entity recognition
- 102: text triplet relationship
- 103: text triplet entity
- 200: speech classification
- 201: speech content
- 202: speech paragraph labeling
- 600: video classification
|
Table 8 LabelPropertyParameter
+Table 8 LabelPropertyParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-@modelarts:color
+ | @modelarts:color
|
-String
+ | String
|
-Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: #FFFFF0.
+ | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: #FFFFF0.
|
-@modelarts:default_shape
+ | @modelarts:default_shape
|
-String
+ | String
|
-Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:
-- bndbox: rectangle
- polygon: polygon
- circle: circle
- line: straight line
- dashed: dotted line
- point: point
- polyline: polyline
+ | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:
+- bndbox: rectangle
- polygon: polygon
- circle: circle
- line: straight line
- dashed: dotted line
- point: point
- polyline: polyline
|
-@modelarts:from_type
+ | @modelarts:from_type
|
-String
+ | String
|
-Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.
+ | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.
|
-@modelarts:rename_to
+ | @modelarts:rename_to
|
-String
+ | String
|
-Default attribute: The new name of the label.
+ | Default attribute: The new name of the label.
|
-@modelarts:shortcut
+ | @modelarts:shortcut
|
-String
+ | String
|
-Default attribute: Label shortcut key. By default, this parameter is left blank. For example: D.
+ | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: D.
|
-@modelarts:to_type
+ | @modelarts:to_type
|
-String
+ | String
|
-Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.
+ | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.
|
Table 9 FieldParameter
+Table 9 FieldParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-description
+ | description
|
-String
+ | String
|
-Schema description.
+ | Schema description.
|
-name
+ | name
|
-String
+ | String
|
-Schema name.
+ | Schema name.
|
-schema_id
+ | schema_id
|
-Integer
+ | Integer
|
-Schema ID.
+ | Schema ID.
|
-type
+ | type
|
-String
+ | String
|
-Schema value type.
+ | Schema value type.
|
Table 10 DatasetVersionParameter
+Table 10 DatasetVersionParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-add_sample_count
+ | add_sample_count
|
-Integer
+ | Integer
|
-Number of added samples.
+ | Number of added samples.
|
-annotated_sample_count
+ | annotated_sample_count
|
-Integer
+ | Integer
|
-Number of samples with labeled versions.
+ | Number of samples with labeled versions.
|
-annotated_sub_sample_count
+ | annotated_sub_sample_count
|
-Integer
+ | Integer
|
-Number of labeled subsamples.
+ | Number of labeled subsamples.
|
-clear_hard_property
+ | clear_hard_property
|
-Boolean
+ | Boolean
|
-Whether to clear hard example properties during release. The options are as follows:
-- true: Clear hard example properties. (Default value)
- false: Do not clear hard example properties.
+ | Whether to clear hard example properties during release. The options are as follows:
+- true: Clear hard example properties. (Default value)
- false: Do not clear hard example properties.
|
-code
+ | code
|
-String
+ | String
|
-Status code of a preprocessing task such as rotation and cropping.
+ | Status code of a preprocessing task such as rotation and cropping.
|
-create_time
+ | create_time
|
-Long
+ | Long
|
-Time when a version is created.
+ | Time when a version is created.
|
-crop
+ | crop
|
-Boolean
+ | Boolean
|
-Whether to crop the image. This field is valid only for the object detection dataset whose labeling box is in the rectangle shape. The options are as follows:
-- true: Crop the image.
- false: Do not crop the image. (Default value)
+ | Whether to crop the image. This field is valid only for the object detection dataset whose labeling box is in the rectangle shape. The options are as follows:
+- true: Crop the image.
- false: Do not crop the image. (Default value)
|
-crop_path
+ | crop_path
|
-String
+ | String
|
-Path for storing cropped files.
+ | Path for storing cropped files.
|
-crop_rotate_cache_path
+ | crop_rotate_cache_path
|
-String
+ | String
|
-Temporary directory for executing the rotation and cropping task.
+ | Temporary directory for executing the rotation and cropping task.
|
-data_path
+ | data_path
|
-String
+ | String
|
-Path for storing data.
+ | Path for storing data.
|
-data_statistics
+ | data_statistics
|
-Map<String,Object>
+ | Map<String,Object>
|
-Sample statistics on a dataset, including the statistics on sample metadata in JSON format.
+ | Sample statistics on a dataset, including the statistics on sample metadata in JSON format.
|
-data_validate
+ | data_validate
|
-Boolean
+ | Boolean
|
-Whether data is validated by the validation algorithm before release. The options are as follows:
-- true: The data has been validated.
- false: The data has not been validated.
+ | Whether data is validated by the validation algorithm before release. The options are as follows:
+- true: The data has been validated.
- false: The data has not been validated.
|
-deleted_sample_count
+ | deleted_sample_count
|
-Integer
+ | Integer
|
-Number of deleted samples.
+ | Number of deleted samples.
|
-deletion_stats
+ | deletion_stats
|
-Map<String,Integer>
+ | Map<String,Integer>
|
-Deletion reason statistics.
+ | Deletion reason statistics.
|
-description
+ | description
|
-String
+ | String
|
-Description of a version.
+ | Description of a version.
|
-export_images
+ | export_images
|
-Boolean
+ | Boolean
|
-Whether to export images to the version output directory during release. The options are as follows:
-- true: Export images to the version output directory.
- false: Do not export images to the version output directory. (Default value)
+ | Whether to export images to the version output directory during release. The options are as follows:
+- true: Export images to the version output directory.
- false: Do not export images to the version output directory. (Default value)
|
-extract_serial_number
+ | extract_serial_number
|
-Boolean
+ | Boolean
|
-Whether to parse the subsample number during release. The field is valid for the healthcare dataset. The options are as follows:
-- true: Parse the subsample number.
- false: Do not parse the subsample number. (Default value)
+ | Whether to parse the subsample number during release. The field is valid for the healthcare dataset. The options are as follows:
+- true: Parse the subsample number.
- false: Do not parse the subsample number. (Default value)
|
-include_dataset_data
+ | include_dataset_data
|
-Boolean
+ | Boolean
|
-Whether to include the source data of a dataset during release. The options are as follows:
-- true: The source data of a dataset is included.
- false: The source data of a dataset is not included.
+ | Whether to include the source data of a dataset during release. The options are as follows:
+- true: The source data of a dataset is included.
- false: The source data of a dataset is not included.
|
-is_current
+ | is_current
|
-Boolean
+ | Boolean
|
-Whether the current dataset version is used. The options are as follows:
-- true: The current dataset version is used.
- false: The current dataset version is not used.
+ | Whether the current dataset version is used. The options are as follows:
+- true: The current dataset version is used.
- false: The current dataset version is not used.
|
-label_stats
+ | label_stats
|
-Array of LabelStats objects
+ | Array of LabelStats objects
|
-Label statistics list of a released version.
+ | Label statistics list of a released version.
|
-label_type
+ | label_type
|
-String
+ | String
|
-Label type of a released version. The options are as follows:
-- multi: Multi-label samples are included.
- single: All samples are single-labeled.
+ | Label type of a released version. The options are as follows:
+- multi: Multi-label samples are included.
- single: All samples are single-labeled.
|
-manifest_cache_input_path
+ | manifest_cache_input_path
|
-String
+ | String
|
-Input path for the manifest file cache during version release.
+ | Input path for the manifest file cache during version release.
|
-manifest_path
+ | manifest_path
|
-String
+ | String
|
-Path for storing the manifest file with the released version.
+ | Path for storing the manifest file with the released version.
|
-message
+ | message
|
-String
+ | String
|
-Task information recorded during release (for example, error information).
+ | Task information recorded during release (for example, error information).
|
-modified_sample_count
+ | modified_sample_count
|
-Integer
+ | Integer
|
-Number of modified samples.
+ | Number of modified samples.
|
-previous_annotated_sample_count
+ | previous_annotated_sample_count
|
-Integer
+ | Integer
|
-Number of labeled samples of parent versions.
+ | Number of labeled samples of parent versions.
|
-previous_total_sample_count
+ | previous_total_sample_count
|
-Integer
+ | Integer
|
-Total samples of parent versions.
+ | Total samples of parent versions.
|
-previous_version_id
+ | previous_version_id
|
-String
+ | String
|
-Parent version ID
+ | Parent version ID
|
-processor_task_id
+ | processor_task_id
|
-String
+ | String
|
-ID of a preprocessing task such as rotation and cropping.
+ | ID of a preprocessing task such as rotation and cropping.
|
-processor_task_status
+ | processor_task_status
|
-Integer
+ | Integer
|
-Status of a preprocessing task such as rotation and cropping. The options are as follows:
-- 0: initialized
- 1: running
- 2: completed
- 3: failed
- 4: stopped
- 5: timeout
- 6: deletion failed
- 7: stop failed
+ | Status of a preprocessing task such as rotation and cropping. The options are as follows:
+- 0: initialized
- 1: running
- 2: completed
- 3: failed
- 4: stopped
- 5: timeout
- 6: deletion failed
- 7: stop failed
|
-remove_sample_usage
+ | remove_sample_usage
|
-Boolean
+ | Boolean
|
-Whether to clear the existing usage information of a dataset during release. The options are as follows:
-- true: Clear the existing usage information of a dataset. (Default value)
- false: Do not clear the existing usage information of a dataset.
+ | Whether to clear the existing usage information of a dataset during release. The options are as follows:
+- true: Clear the existing usage information of a dataset. (Default value)
- false: Do not clear the existing usage information of a dataset.
|
-rotate
+ | rotate
|
-Boolean
+ | Boolean
|
-Whether to rotate the image. The options are as follows:
-- true: Rotate the image.
- false: Do not rotate the image. (Default value)
+ | Whether to rotate the image. The options are as follows:
+- true: Rotate the image.
- false: Do not rotate the image. (Default value)
|
-rotate_path
+ | rotate_path
|
-String
+ | String
|
-Path for storing the rotated file.
+ | Path for storing the rotated file.
|
-sample_state
+ | sample_state
|
-String
+ | String
|
-Sample status. The options are as follows:
-- ALL: labeled
- NONE: unlabeled
- UNCHECK: pending acceptance
- ACCEPTED: accepted
- REJECTED: rejected
- UNREVIEWED: pending review
- REVIEWED: reviewed
- WORKFORCE_SAMPLED: sampled
- WORKFORCE_SAMPLED_UNCHECK: sampling unchecked
- WORKFORCE_SAMPLED_CHECKED: sampling checked
- WORKFORCE_SAMPLED_ACCEPTED: sampling accepted
- WORKFORCE_SAMPLED_REJECTED: sampling rejected
- AUTO_ANNOTATION: to be confirmed
+ | Sample status. The options are as follows:
+- ALL: labeled
- NONE: unlabeled
- UNCHECK: pending acceptance
- ACCEPTED: accepted
- REJECTED: rejected
- UNREVIEWED: pending review
- REVIEWED: reviewed
- WORKFORCE_SAMPLED: sampled
- WORKFORCE_SAMPLED_UNCHECK: sampling unchecked
- WORKFORCE_SAMPLED_CHECKED: sampling checked
- WORKFORCE_SAMPLED_ACCEPTED: sampling accepted
- WORKFORCE_SAMPLED_REJECTED: sampling rejected
- AUTO_ANNOTATION: to be confirmed
|
-status
+ | status
|
-Integer
+ | Integer
|
-Status of a dataset version. The options are as follows:
-- 0: creating
- 1: running
- 2: deleting
- 3: deleted
- 4: error
+ | Status of a dataset version. The options are as follows:
+- 0: creating
- 1: running
- 2: deleting
- 3: deleted
- 4: error
|
-tags
+ | tags
|
-Array of strings
+ | Array of strings
|
-Key identifier list of the dataset. The labeling type is used as the default label when the labeling task releases a version. For example, ["Image","Object detection"].
+ | Key identifier list of the dataset. The labeling type is used as the default label when the labeling task releases a version. For example, ["Image","Object detection"].
|
-task_type
+ | task_type
|
-Integer
+ | Integer
|
-Labeling task type of the released version, which is the same as the dataset type.
+ | Labeling task type of the released version, which is the same as the dataset type.
|
-total_sample_count
+ | total_sample_count
|
-Integer
+ | Integer
|
-Total number of version samples.
+ | Total number of version samples.
|
-total_sub_sample_count
+ | total_sub_sample_count
|
-Integer
+ | Integer
|
-Total number of subsamples generated from the parent samples.
+ | Total number of subsamples generated from the parent samples.
|
-train_evaluate_sample_ratio
+ | train_evaluate_sample_ratio
|
-String
+ | String
|
-Split training and verification ratio during version release. The default value is 1.00, indicating that all labeled samples are split into the training set.
+ | Split training and verification ratio during version release. The default value is 1.00, indicating that all labeled samples are split into the training set.
|
-update_time
+ | update_time
|
-Long
+ | Long
|
-Time when a version is updated.
+ | Time when a version is updated.
|
-version_format
+ | version_format
|
-String
+ | String
|
-Format of a dataset version. The options are as follows:
-- Default: default format
- CarbonData: CarbonData (supported only by table datasets)
- CSV: CSV
+ | Format of a dataset version. The options are as follows:
+- Default: default format
- CarbonData: CarbonData (supported only by table datasets)
- CSV: CSV
|
-version_id
+ | version_id
|
-String
+ | String
|
-Dataset version ID.
+ | Dataset version ID.
|
-version_name
+ | version_name
|
-String
+ | String
|
-Dataset version name.
+ | Dataset version name.
|
-with_column_header
+ | with_column_header
|
-Boolean
+ | Boolean
|
-Whether the first row in the released CSV file is a column name. This field is valid for the table dataset. The options are as follows:
-- true: The first row in the released CSV file is a column name.
- false: The first row in the released CSV file is not a column name.
+ | Whether the first row in the released CSV file is a column name. This field is valid for the table dataset. The options are as follows:
+- true: The first row in the released CSV file is a column name.
- false: The first row in the released CSV file is not a column name.
|
Table 11 LabelStatsParameter
+Table 11 LabelStatsParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-attributes
+ | attributes
|
-Array of LabelAttribute objects
+ | Array of LabelAttribute objects
|
-Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.
+ | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.
|
-count
+ | count
|
-Integer
+ | Integer
|
-Number of labels.
+ | Number of labels.
|
-name
+ | name
|
-String
+ | String
|
-Label name.
+ | Label name.
|
-property
+ | property
|
-LabelProperty object
+ | LabelProperty object
|
-Basic attribute key-value pair of a label, such as color and shortcut keys.
+ | Basic attribute key-value pair of a label, such as color and shortcut keys.
|
-sample_count
+ | sample_count
|
-Integer
+ | Integer
|
-Number of samples containing the label.
+ | Number of samples containing the label.
|
-type
+ | type
|
-Integer
+ | Integer
|
-Label type. The options are as follows:
-- 0: image classification
- 1: object detection
- 100: text classification
- 101: named entity recognition
- 102: text triplet relationship
- 103: text triplet entity
- 200: speech classification
- 201: speech content
- 202: speech paragraph labeling
- 600: video classification
+ | Label type. The options are as follows:
+- 0: image classification
- 1: object detection
- 100: text classification
- 101: named entity recognition
- 102: text triplet relationship
- 103: text triplet entity
- 200: speech classification
- 201: speech content
- 202: speech paragraph labeling
- 600: video classification
|
Table 12 LabelAttributeParameter
+Table 12 LabelAttributeParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-default_value
+ | default_value
|
-String
+ | String
|
-Default value of a label attribute.
+ | Default value of a label attribute.
|
-id
+ | id
|
-String
+ | String
|
-Label attribute ID.
+ | Label attribute ID.
|
-name
+ | name
|
-String
+ | String
|
-Label attribute name.
+ | Label attribute name.
|
-type
+ | type
|
-String
+ | String
|
-Label attribute type. The options are as follows:
-- text: text
- select: single-choice drop-down list
+ | Label attribute type. The options are as follows:
+- text: text
- select: single-choice drop-down list
|
-values
+ | values
|
-Array of LabelAttributeValue objects
+ | Array of LabelAttributeValue objects
|
-List of label attribute values.
+ | List of label attribute values.
|
Table 13 LabelAttributeValueParameter
+Table 13 LabelAttributeValueParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-id
+ | id
|
-String
+ | String
|
-Label attribute value ID.
+ | Label attribute value ID.
|
-value
+ | value
|
-String
+ | String
|
-Label attribute value.
+ | Label attribute value.
|
Table 14 WorkforceDescriptorParameter
+Table 14 WorkforceDescriptorParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-current_task_id
+ | current_task_id
|
-String
+ | String
|
-ID of a team labeling task.
+ | ID of a team labeling task.
|
-current_task_name
+ | current_task_name
|
-String
+ | String
|
-Name of a team labeling task.
+ | Name of a team labeling task.
|
-reject_num
+ | reject_num
|
-Integer
+ | Integer
|
-Number of rejected samples.
+ | Number of rejected samples.
|
-repetition
+ | repetition
|
-Integer
+ | Integer
|
-Number of persons who label each sample. The minimum value is 1.
+ | Number of persons who label each sample. The minimum value is 1.
|
-is_synchronize_auto_labeling_data
+ | is_synchronize_auto_labeling_data
|
-Boolean
+ | Boolean
|
-Whether to synchronously update auto labeling data. The options are as follows:
-- true: Update auto labeling data synchronously.
- false: Do not update auto labeling data synchronously.
+ | Whether to synchronously update auto labeling data. The options are as follows:
+- true: Update auto labeling data synchronously.
- false: Do not update auto labeling data synchronously.
|
-is_synchronize_data
+ | is_synchronize_data
|
-Boolean
+ | Boolean
|
-Whether to synchronize updated data, such as uploading files, synchronizing data sources, and assigning imported unlabeled files to team members. The options are as follows:
-- true: Synchronize updated data to team members.
- false: Do not synchronize updated data to team members.
+ | Whether to synchronize updated data, such as uploading files, synchronizing data sources, and assigning imported unlabeled files to team members. The options are as follows:
+- true: Synchronize updated data to team members.
- false: Do not synchronize updated data to team members.
|
-workers
+ | workers
|
-Array of Worker objects
+ | Array of Worker objects
|
-List of labeling team members.
+ | List of labeling team members.
|
-workforce_id
+ | workforce_id
|
-String
+ | String
|
-ID of a labeling team.
+ | ID of a labeling team.
|
-workforce_name
+ | workforce_name
|
-String
+ | String
|
-Name of a labeling team.
+ | Name of a labeling team.
|
Table 15 WorkerParameter
+Table 15 WorkerParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-create_time
+ | create_time
|
-Long
+ | Long
|
-Creation time.
+ | Creation time.
|
-description
+ | description
|
-String
+ | String
|
-Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'
+ | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'
|
-email
+ | email
|
-String
+ | String
|
-Email address of a labeling team member.
+ | Email address of a labeling team member.
|
-role
+ | role
|
-Integer
+ | Integer
|
-Role. The options are as follows:
-- 0: labeling personnel
- 1: reviewer
- 2: team administrator
- 3: dataset owner
+ | Role. The options are as follows:
+- 0: labeling personnel
- 1: reviewer
- 2: team administrator
- 3: dataset owner
|
-status
+ | status
|
-Integer
+ | Integer
|
-Current login status of a labeling team member. The options are as follows:
-- 0: The invitation email has not been sent.
- 1: The invitation email has been sent but the user has not logged in.
- 2: The user has logged in.
- 3: The labeling team member has been deleted.
+ | Current login status of a labeling team member. The options are as follows:
+- 0: The invitation email has not been sent.
- 1: The invitation email has been sent but the user has not logged in.
- 2: The user has logged in.
- 3: The labeling team member has been deleted.
|
-update_time
+ | update_time
|
-Long
+ | Long
|
-Update time.
+ | Update time.
|
-worker_id
+ | worker_id
|
-String
+ | String
|
-ID of a labeling team member.
+ | ID of a labeling team member.
|
-workforce_id
+ | workforce_id
|
-String
+ | String
|
-ID of a labeling team.
+ | ID of a labeling team.
|
Example RequestsQuerying Details About a Dataset
- GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}
+ Example RequestsQuerying Details About a Dataset
+ GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}
- Example ResponsesStatus code: 200
- OK
- {
+Example ResponsesStatus code: 200
+ OK
+ {
"dataset_id" : "gfghHSokody6AJigS5A",
"dataset_name" : "dataset-f9e8",
"dataset_type" : 0,
@@ -1437,38 +1437,38 @@
} ]
}
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|---|
|
|---|
|---|
|
|---|
|---|
|
|---|
|
|---|