matreche/modelarts-umn
1
0
Fork 0
forked from docs/modelarts
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Changes to ma_api from docs/doc-exports#27

Browse Source 
Reviewed-by: Jiang, Beibei <beibei.jiang@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
This commit is contained in:
proposalbot 2022-08-22 15:13:12 +00:00 committed by zuul
parent 4cd256f960
commit 0184ffbc66
89 changed files with 5701 additions and 8657 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
api-ref/source/api_overview.rst
View File

@ -149,14 +149,14 @@ Authorization Management APIs
.. table:: **Table 5** Workspace management APIs
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| API | Description |
+============================================================+=========================================================================================================================================================================================================================+
| :ref:`Viewing an Authorization List <getauthorizations>` | View an authorization list. |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Configuring Authorization <createauthorization>` | Configure ModelArts authorization. ModelArts functions such as training management, development environment, data management, and real-time services can be properly used only after required permissions are assigned. |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Deleting Authorization <deleteauthorizations>` | Delete the authorization of a specified user or all users. |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Creating a ModelArts Agency <createmodelartsagency>` | Create a ModelArts agency for dependent services such as OBS, SWR, and IEF. |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| API | Description |
+============================================================+======================================================================================================================================================+
| :ref:`Viewing an Authorization List <getauthorizations>` | View an authorization list. |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Configuring Authorization <createauthorization>` | Configure ModelArts authorization. ModelArts functions such as real-time services can be properly used only after required permissions are assigned. |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Deleting Authorization <deleteauthorizations>` | Delete the authorization of a specified user or all users. |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Creating a ModelArts Agency <createmodelartsagency>` | Create a ModelArts agency for dependent services such as OBS, SWR, and IEF. |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+

7
api-ref/source/application_cases/creating_a_training_job_using_the_tensorflow_framework.rst
View File

@ -163,13 +163,6 @@ Procedure
{
"engines": [
{
"engine_type": 13,
"engine_name": "Ascend-Powered-Engine",
"engine_id": 130,
"engine_version": "TF-1.15-python3.7-aarch64"
},
......
{
"engine_type": 1,
"engine_name": "TensorFlow",

56
api-ref/source/authorization_management/configuring_authorization.rst
View File

@ -8,14 +8,14 @@ Configuring Authorization
Function
--------
This API is used to configure ModelArts authorization. ModelArts functions such as training management, development environment, data management, and real-time services can be properly used only after required permissions are assigned. The administrator can use this API to set an agency for IAM users and set the access key of the current user.
This API is used to configure ModelArts authorization. ModelArts functions such as training management, development environment, data management, and real-time services can be properly used only after required authorization is configured. This API allows the administrator to configure an agency for IAM users and set an access key of the current user.
URI
---
POST /v2/{project_id}/authorizations
.. table:: **Table 1** Path parameters
.. table:: **Table 1** Path Parameters
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
@ -28,33 +28,31 @@ Request Parameters
.. table:: **Table 2** Request body parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+====================================================================================================================================================+
| user_id | No | String | User ID. For details about how to obtain a user ID, see :ref:`Obtaining a User ID <modelarts_03_0006>`. |
| | | | |
| | | | If **user_id** is set to **all**, all IAM users are authorized. If some IAM users have been authorized, the authorization setting will be updated. |
| | | | |
| | | | This parameter is mandatory only if the authorization type is set to **agency**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| type | No | String | Authorization type. **Agency** is recommended. |
| | | | |
| | | | Options: |
| | | | |
| | | | - **agency**: authorization through an agency |
| | | | |
| | | | - **credential**: authorization through an access Key (AK/SK) |
| | | | |
| | | | Default: **agency** |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| content | Yes | String | Authorization content. |
| | | | |
| | | | - If **Authorization Type** is set to **Agency**, this field indicates the agency name. |
| | | | |
| | | | - If **Authorization Type** is set to **AK/SK**, this field indicates the access key ID (AK). |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| secret_key | No | String | Secret Access Key (SK). This field is required only when **Authorization Method** is set to **AK/SK**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+=================================================================================================================================================================+
| user_id | No | String | User ID. For details about how to obtain a user ID, see :ref:`Obtaining a User ID <modelarts_03_0006>`. |
| | | | |
| | | | If **user_id** is set to **all-users**, authorization is configured for all IAM users. If some users have been authorized, their authorization will be updated. |
| | | | |
| | | | This parameter is mandatory only if the authorization method is set to **Agency**. |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| type | No | String | Authorization type. **Agency** is recommended. |
| | | | |
| | | | Options: |
| | | | |
| | | | - **agency**: authorization through an agency |
| | | | - **credential**: authorization through an access Key (AK/SK) |
| | | | |
| | | | Default: **agency** |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| content | Yes | String | Authorization content. |
| | | | |
| | | | - If **Authorization Type** is set to **Agency**, this field indicates the agency name. |
| | | | - If **Authorization Type** is set to **AK/SK**, this field indicates the access key ID (AK). |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| secret_key | No | String | Secret Access Key (SK). This field is required only when **Authorization Method** is set to **AK/SK**. |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters
-------------------

4
api-ref/source/authorization_management/creating_a_modelarts_agency.rst
View File

@ -8,14 +8,14 @@ Creating a ModelArts Agency
Function
--------
This API is used to create an agency so that ModelArts can access dependent services such as OBS, SWR, and IEF.
This API is used to create a ModelArts agency for dependent services such as OBS, SWR, and IEF.
URI
---
POST /v2/{project_id}/agency
.. table:: **Table 1** Path parameters
.. table:: **Table 1** Path Parameters
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |

14
api-ref/source/authorization_management/deleting_authorization.rst
View File

@ -15,7 +15,7 @@ URI
DELETE /v2/{project_id}/authorizations
.. table:: **Table 1** Path parameters
.. table:: **Table 1** Path Parameters
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
@ -23,13 +23,13 @@ DELETE /v2/{project_id}/authorizations
| project_id | Yes | String | Project ID. For details about how to obtain a project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 2** Query parameters
.. table:: **Table 2** Query Parameters
+-----------+-----------+--------+---------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===========+===========+========+===================================================================================================+
| user_id | No | String | User ID. If this parameter is set to **all**, the authorization of all IAM users will be deleted. |
+-----------+-----------+--------+---------------------------------------------------------------------------------------------------+
+-----------+-----------+--------+------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===========+===========+========+======================================================================================================+
| user_id | No | String | User ID. If **user_id** is set to **all-users**, the authorization of all IAM users will be deleted. |
+-----------+-----------+--------+------------------------------------------------------------------------------------------------------+
Request Parameters
------------------

62
api-ref/source/authorization_management/viewing_an_authorization_list.rst
View File

@ -15,7 +15,7 @@ URI
GET /v2/{project_id}/authorizations
.. table:: **Table 1** Path parameters
.. table:: **Table 1** Path Parameters
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
@ -23,7 +23,7 @@ GET /v2/{project_id}/authorizations
| project_id | Yes | String | Project ID. For details about how to obtain a project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 2** Query parameters
.. table:: **Table 2** Query Parameters
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
@ -33,7 +33,6 @@ GET /v2/{project_id}/authorizations
| | | | Options: |
| | | | |
| | | | - **user_name**: IAM user |
| | | | |
| | | | - **create_time**: creation time |
| | | | |
| | | | Default: **user_name** |
@ -43,7 +42,6 @@ GET /v2/{project_id}/authorizations
| | | | Options: |
| | | | |
| | | | - **asc**: ascending order |
| | | | |
| | | | - **desc**: descending order |
| | | | |
| | | | Default: **asc** |
@ -79,35 +77,33 @@ Response Parameters
.. table:: **Table 4** AuthorizationResponse
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+====================================================================================================================================================+
| user_id | String | User ID. For details about how to obtain a user ID, see :ref:`Obtaining a User ID <modelarts_03_0006>`. |
| | | |
| | | If **user_id** is set to **all**, all IAM users are authorized. If some IAM users have been authorized, the authorization setting will be updated. |
| | | |
| | | This parameter is mandatory only if the authorization type is set to **agency**. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| type | String | Authorization type. **Agency** is recommended. |
| | | |
| | | Options: |
| | | |
| | | - **agency**: authorization through an agency |
| | | |
| | | - **credential**: authorization through an access Key (AK/SK) |
| | | |
| | | Default: **agency** |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| content | String | Authorization content. |
| | | |
| | | - If **Authorization Type** is set to **Agency**, this field indicates the agency name. |
| | | |
| | | - If **Authorization Type** is set to **AK/SK**, this field indicates the access key ID (AK). |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| secret_key | String | Secret Access Key (SK). This field is required only when **Authorization Method** is set to **AK/SK**. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| create_time | Long | Timestamp when the quality job was created. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+=================================================================================================================================================================+
| user_id | String | User ID. For details about how to obtain a user ID, see :ref:`Obtaining a User ID <modelarts_03_0006>`. |
| | | |
| | | If **user_id** is set to **all-users**, authorization is configured for all IAM users. If some users have been authorized, their authorization will be updated. |
| | | |
| | | This parameter is mandatory only if the authorization method is set to **Agency**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| type | String | Authorization type. **Agency** is recommended. |
| | | |
| | | Options: |
| | | |
| | | - **agency**: authorization through an agency |
| | | - **credential**: authorization through an access Key (AK/SK) |
| | | |
| | | Default: **agency** |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| content | String | Authorization content. |
| | | |
| | | - If **Authorization Type** is set to **Agency**, this field indicates the agency name. |
| | | - If **Authorization Type** is set to **AK/SK**, this field indicates the access key ID (AK). |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| secret_key | String | Secret Access Key (SK). This field is required only when **Authorization Method** is set to **AK/SK**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| create_time | Long | Timestamp when the quality job was created. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Requests
----------------

2
api-ref/source/before_you_start/overview.rst
View File

@ -5,4 +5,6 @@
Overview
========
ModelArts is a one-stop AI development platform geared toward developers and data scientists of all skill levels. It enables you to rapidly build, train, and deploy models anywhere (from the cloud to the edge), and manage full-lifecycle AI workflows. ModelArts accelerates AI development and fosters AI innovation with key capabilities, including data preprocessing and auto labeling, distributed training, automated model building, and one-click workflow execution. You can use ModelArts through open APIs.
Before calling a ModelArts API, ensure that you have fully understood the concepts related to ModelArts. For details, see the `Service Overview <https://docs.otc.t-systems.com/en-us/usermanual/modelarts/modelarts_01_0001.html>`__.

2
api-ref/source/calling_apis/making_an_api_request.rst
View File

@ -136,7 +136,7 @@ If an API is used to obtain a user token, the request parameters and parameter d
The **scope** parameter specifies where a token takes effect. In the example, the token takes effect only for the resources in a specified project. ModelArts uses a region-specific endpoint to call this API. Set **scope** to **project**. You can set **scope** to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see "Obtaining a User Token".
.. code-block::
.. code-block:: text
POST https://{iam-endpoint}/v3/auth/tokens
Content-Type:application/json

2
api-ref/source/common_parameters/error_codes.rst
View File

@ -678,7 +678,7 @@ Error Codes
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 500 | ModelArts.3050 | Get user temporary credential failed. | Failed to obtain the temporary user certificate. | Check whether the token is valid. |
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 500 | ModelArts.3052 | Chip Type ({0}) not support. | Chip type {0} is not supported. | Check whether the chip is of Ascend, GPU, Arm, or general type. |
| 500 | ModelArts.3052 | Chip Type ({0}) not support. | Chip type {0} is not supported. | Check whether the chip is of GPU, Arm, or general type. |
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 500 | ModelArts.3053 | Model Type ({0}) not support. | Model type {0} is not supported. | This type of model is not supported. |
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

641
api-ref/source/data_management/data_export_task/creating_a_dataset_export_task.rst
View File

File diff suppressed because it is too large Load Diff

413
api-ref/source/data_management/data_export_task/querying_the_dataset_export_task_list.rst
View File

File diff suppressed because it is too large Load Diff

304
api-ref/source/data_management/data_export_task/querying_the_status_of_a_dataset_export_task.rst
View File

File diff suppressed because it is too large Load Diff

312
api-ref/source/data_management/data_import_task/creating_an_import_task.rst
View File

File diff suppressed because it is too large Load Diff

228
api-ref/source/data_management/data_import_task/querying_details_about_a_dataset_import_task.rst
View File

File diff suppressed because it is too large Load Diff

228
api-ref/source/data_management/data_import_task/querying_the_dataset_import_task_list.rst
View File

File diff suppressed because it is too large Load Diff

58
api-ref/source/data_management/data_synchronization_task/querying_the_status_of_a_dataset_synchronization_task.rst
View File

@ -37,29 +37,41 @@ Response Parameters
.. table:: **Table 2** Response body parameters
+----------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+======================+========+==========================================================================================================================================================================================================+
| add_sample_count | Long | Number of added samples. |
+----------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| create_time | Long | Task creation time. |
+----------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dataset_id | String | Dataset ID. |
+----------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| deleted_sample_count | Long | Number of deleted samples. |
+----------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| duration_time | Long | Task running time. |
+----------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| error_code | String | Error code. |
+----------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| error_msg | String | Error message. |
+----------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status | String | Status of a task. The options are as follows: - **QUEUING**: queuing - **STARTING**: execution started - **RUNNING**: running - **COMPLETED**: completed - **FAILED**: failed - **NOT_EXIST**: not found |
+----------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| task_id | String | Synchronization task ID. |
+----------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| total_sample_count | Long | Total number of samples. |
+----------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+===============================================+
| add_sample_count | Long | Number of added samples. |
+-----------------------+-----------------------+-----------------------------------------------+
| create_time | Long | Task creation time. |
+-----------------------+-----------------------+-----------------------------------------------+
| dataset_id | String | Dataset ID. |
+-----------------------+-----------------------+-----------------------------------------------+
| deleted_sample_count | Long | Number of deleted samples. |
+-----------------------+-----------------------+-----------------------------------------------+
| duration_time | Long | Task running time. |
+-----------------------+-----------------------+-----------------------------------------------+
| error_code | String | Error code. |
+-----------------------+-----------------------+-----------------------------------------------+
| error_msg | String | Error message. |
+-----------------------+-----------------------+-----------------------------------------------+
| status | String | Status of a task. The options are as follows: |
| | | |
| | | - **QUEUING**: queuing |
| | | |
| | | - **STARTING**: execution started |
| | | |
| | | - **RUNNING**: running |
| | | |
| | | - **COMPLETED**: completed |
| | | |
| | | - **FAILED**: failed |
| | | |
| | | - **NOT_EXIST**: not found |
+-----------------------+-----------------------+-----------------------------------------------+
| task_id | String | Synchronization task ID. |
+-----------------------+-----------------------+-----------------------------------------------+
| total_sample_count | Long | Total number of samples. |
+-----------------------+-----------------------+-----------------------------------------------+
Example Requests
----------------

409
api-ref/source/data_management/dataset_management/creating_a_dataset.rst
View File

File diff suppressed because it is too large Load Diff

4
api-ref/source/data_management/dataset_management/index.rst
View File

@ -12,8 +12,6 @@ Dataset Management
- :ref:`Deleting a Dataset <deletedataset>`
- :ref:`Querying Dataset Statistics <liststats>`
- :ref:`Querying the Monitoring Data of a Dataset <getdatasetmetrics>`
- :ref:`Querying Details About Team Labeling Task Statistics <listworkforcetaskstats>`
- :ref:`Querying Details About the Progress of a Team Labeling Task Member <getworkforcetaskmetrics>`
.. toctree::
:maxdepth: 1
@ -26,5 +24,3 @@ Dataset Management
deleting_a_dataset
querying_dataset_statistics
querying_the_monitoring_data_of_a_dataset
querying_details_about_team_labeling_task_statistics
querying_details_about_the_progress_of_a_team_labeling_task_member

116
api-ref/source/data_management/dataset_management/modifying_a_dataset.rst
View File

File diff suppressed because it is too large Load Diff

214
api-ref/source/data_management/dataset_management/querying_dataset_statistics.rst
View File

File diff suppressed because it is too large Load Diff

968
api-ref/source/data_management/dataset_management/querying_details_about_a_dataset.rst
View File

File diff suppressed because it is too large Load Diff

234
api-ref/source/data_management/dataset_management/querying_details_about_team_labeling_task_statistics.rst
View File

File diff suppressed because it is too large Load Diff

94
api-ref/source/data_management/dataset_management/querying_details_about_the_progress_of_a_team_labeling_task_member.rst
View File

@ -1,94 +0,0 @@
:original_name: GetWorkforceTaskMetrics.html
.. _GetWorkforceTaskMetrics:
Querying Details About the Progress of a Team Labeling Task Member
==================================================================
Function
--------
This API is used to query details about the progress of a team labeling task member.
URI
---
GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/metrics
.. table:: **Table 1** Path Parameters
+-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| Parameter | 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 :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| workforce_task_id | Yes | String | ID of a team labeling task. |
+-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
None
Response Parameters
-------------------
**Status code: 200**
.. table:: **Table 2** Response body parameters
+--------------+---------------------------------+-------------------------------------------+
| Parameter | Type | Description |
+==============+=================================+===========================================+
| sample_stats | Map<String,Map<String,Integer>> | Statistics on team labeling task members. |
+--------------+---------------------------------+-------------------------------------------+
Example Requests
----------------
Querying Details About the Progress of a Team Labeling Task Member
.. code-block:: text
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/metrics
Example Responses
-----------------
**Status code: 200**
OK
.. code-block::
{
"sample_stats" : {
"xxx@xxx.com" : {
"un_annotation" : 51,
"rejected" : 0,
"unreviewed" : 0,
"accepted" : 0,
"auto_annotation" : 0,
"uncheck" : 0
}
}
}
Status Codes
------------
=========== ============
Status Code Description
=========== ============
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
=========== ============
Error Codes
-----------
See :ref:`Error Codes <modelarts_03_0095>`.

966
api-ref/source/data_management/dataset_management/response_body_for_querying_the_dataset_list..rst
View File

File diff suppressed because it is too large Load Diff

60
api-ref/source/data_management/dataset_version_management/creating_a_dataset_labeling_version.rst
View File

@ -30,25 +30,47 @@ Request Parameters
.. table:: **Table 2** Request body parameters
+-----------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=============================+===========+=========+=============================================================================================================================================================================================================================================================================================================================+
| clear_hard_property | No | Boolean | Whether to clear hard example properties. The options are as follows: - **true**: Clear hard example properties. (Default value) - **false**: Do not clear hard example properties. |
+-----------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | Version description. The value is empty by default. The description contains 0 to 256 characters and does not support the following special characters: !<>=&"' |
+-----------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| export_images | No | 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) |
+-----------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remove_sample_usage | No | 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. |
+-----------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| train_evaluate_sample_ratio | No | 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. |
+-----------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 |
+-----------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| version_name | No | String | Version name. The value contains 1 to 32 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. |
+-----------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| with_column_header | No | Boolean | Whether to write the column name in the first line of the CSV file during release. This field is valid for the table dataset. The options are as follows: - **true**: Write the column name in the first line of the CSV file. (Default value) - **false**: Do not write the column name in the first line of the CSV file. |
+-----------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=============================+=================+=================+===================================================================================================================================================================+
| clear_hard_property | No | Boolean | Whether to clear hard example properties. The options are as follows: |
| | | | |
| | | | - **true**: Clear hard example properties. (Default value) |
| | | | |
| | | | - **false**: Do not clear hard example properties. |
+-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | Version description. The value is empty by default. The description contains 0 to 256 characters and does not support the following special characters: !<>=&"' |
+-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| export_images | No | 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) |
+-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remove_sample_usage | No | 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. |
+-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| train_evaluate_sample_ratio | No | 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. |
+-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 |
+-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| version_name | No | String | Version name. The value contains 1 to 32 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. |
+-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| with_column_header | No | Boolean | Whether to write the column name in the first line of the CSV file during release. This field is valid for the table dataset. The options are as follows: |
| | | | |
| | | | - **true**: Write the column name in the first line of the CSV file. (Default value) |
| | | | |
| | | | - **false**: Do not write the column name in the first line of the CSV file. |
+-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters
-------------------

412
api-ref/source/data_management/dataset_version_management/querying_details_about_a_dataset_version.rst
View File

File diff suppressed because it is too large Load Diff

446
api-ref/source/data_management/dataset_version_management/querying_the_dataset_version_list.rst
View File

File diff suppressed because it is too large Load Diff

10
api-ref/source/data_management/index.rst
View File

@ -9,12 +9,8 @@ Data Management
- :ref:`Dataset Management <dataset_management>`
- :ref:`Dataset Version Management <dataset_version_management>`
- :ref:`Sample Management <sample_management>`
- :ref:`Label Management <label_management>`
- :ref:`Label Management <topic_300000012>`
- :ref:`Manual Labeling <manual_annotation_management>`
- :ref:`Labeling Task Management <label_task_management>`
- :ref:`Team Labeling Process Management <workforce_process_management>`
- :ref:`Labeling Team Management <workforce_management>`
- :ref:`Labeling Team Member Management <workforce_worker_management>`
- :ref:`Data Import Task <data_import>`
- :ref:`Data Export Task <data_export>`
- :ref:`Data Synchronization Task <data_sync>`
@ -29,10 +25,6 @@ Data Management
sample_management/index
label_management/index
manual_labeling/index
labeling_task_management/index
team_labeling_process_management/index
labeling_team_management/index
labeling_team_member_management/index
data_import_task/index
data_export_task/index
data_synchronization_task/index

164
api-ref/source/data_management/label_management/creating_a_dataset_label.rst
View File

File diff suppressed because it is too large Load Diff

60
api-ref/source/data_management/label_management/deleting_a_label_and_the_files_that_only_contain_the_label.rst
View File

@ -29,13 +29,37 @@ DELETE /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/{label_nam
.. table:: **Table 2** Query Parameters
+---------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===============+===========+=========+========================================================================================================================================================================================================================================================================================================================================================================+
| delete_source | No | Boolean | Whether to delete the sample source files. The options are as follows: - **true**: Delete the sample source files. - **false**: Do not delete the sample source files. (Default value) |
+---------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| label_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 |
+---------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+========================================================================+
| delete_source | No | Boolean | Whether to delete the sample source files. The options are as follows: |
| | | | |
| | | | - **true**: Delete the sample source files. |
| | | | |
| | | | - **false**: Do not delete the sample source files. (Default value) |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------+
| label_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 |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------+
Request Parameters
------------------
@ -49,15 +73,19 @@ Response Parameters
.. table:: **Table 3** Response body parameters
+------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | 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: - **true**: The operation is successful. - **false**: The operation is failed. |
+------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+------------------------------------------------------------------------+
| Parameter | 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: |
| | | |
| | | - **true**: The operation is successful. |
| | | |
| | | - **false**: The operation is failed. |
+-----------------------+-----------------------+------------------------------------------------------------------------+
Example Requests
----------------

180
api-ref/source/data_management/label_management/deleting_labels_in_batches.rst
View File

File diff suppressed because it is too large Load Diff

4
api-ref/source/data_management/label_management/index.rst
View File

@ -1,6 +1,6 @@
:original_name: label_management.html
:original_name: topic_300000012.html
.. _label_management:
.. _topic_300000012:
Label Management
================

164
api-ref/source/data_management/label_management/modifying_labels_in_batches.rst
View File

File diff suppressed because it is too large Load Diff

116
api-ref/source/data_management/label_management/querying_the_dataset_label_list.rst
View File

File diff suppressed because it is too large Load Diff

96
api-ref/source/data_management/label_management/updating_a_label_by_label_names.rst
View File

File diff suppressed because it is too large Load Diff

95
api-ref/source/data_management/labeling_task_management/creating_a_team_labeling_acceptance_task.rst
View File

@ -1,95 +0,0 @@
:original_name: StartWorkforceSamplingTask.html
.. _StartWorkforceSamplingTask:
Creating a Team Labeling Acceptance Task
========================================
Function
--------
This API is used to create a team labeling acceptance task.
URI
---
POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance
.. table:: **Table 1** Path Parameters
+-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| Parameter | 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 :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| workforce_task_id | Yes | String | ID of a team labeling task. |
+-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
.. table:: **Table 2** Request body parameters
+---------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===============+===========+=========+===============================================================================================================================+
| sampling_num | No | Integer | Number of samples for the acceptance task. Either this parameter or the sampling ratio is delivered. |
+---------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------+
| sampling_rate | No | Double | Sampling ratio of the acceptance task. The value range is (0,1]. Either this parameter or the number of samples is delivered. |
+---------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------+
Response Parameters
-------------------
**Status code: 200**
.. table:: **Table 3** Response body parameters
========= ====== ======================================
Parameter Type Description
========= ====== ======================================
task_id String ID of an asynchronous acceptance task.
========= ====== ======================================
Example Requests
----------------
Creating a Team Labeling Acceptance Task and Setting the Sampling Percentage to 20%
.. code-block::
{
"sampling_rate" : 0.2
}
Example Responses
-----------------
**Status code: 200**
OK
.. code-block::
{
"task_id" : "nv6BbozxCJmZcHAE9hV"
}
Status Codes
------------
=========== ============
Status Code Description
=========== ============
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
=========== ============
Error Codes
-----------
See :ref:`Error Codes <modelarts_03_0095>`.

183
api-ref/source/data_management/labeling_task_management/creating_a_team_labeling_task.rst
View File

File diff suppressed because it is too large Load Diff

74
api-ref/source/data_management/labeling_task_management/deleting_a_team_labeling_task.rst
View File

@ -1,74 +0,0 @@
:original_name: DeleteWorkforceTask.html
.. _DeleteWorkforceTask:
Deleting a Team Labeling Task
=============================
Function
--------
This API is used to delete a team labeling task.
URI
---
DELETE /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}
.. table:: **Table 1** Path Parameters
+-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| Parameter | 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 :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| workforce_task_id | Yes | String | ID of a team labeling task. |
+-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
None
Response Parameters
-------------------
None
Example Requests
----------------
Deleting a Team Labeling Task
.. code-block:: text
DELETE https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}
Example Responses
-----------------
**Status code: 204**
No Content
.. code-block::
{ }
Status Codes
------------
=========== ============
Status Code Description
=========== ============
204 No Content
401 Unauthorized
403 Forbidden
=========== ============
Error Codes
-----------
See :ref:`Error Codes <modelarts_03_0095>`.

32
api-ref/source/data_management/labeling_task_management/index.rst
View File

@ -1,32 +0,0 @@
:original_name: label_task_management.html
.. _label_task_management:
Labeling Task Management
========================
- :ref:`Querying the Team Labeling Task List of a Dataset <listworkforcetasks>`
- :ref:`Creating a Team Labeling Task <createworkforcetask>`
- :ref:`Querying Details About a Team Labeling Task <descworkforcetask>`
- :ref:`Starting a Team Labeling Task <startworkforcetask>`
- :ref:`Updating a Team Labeling Task <updateworkforcetask>`
- :ref:`Deleting a Team Labeling Task <deleteworkforcetask>`
- :ref:`Creating a Team Labeling Acceptance Task <startworkforcesamplingtask>`
- :ref:`Querying the Report of a Team Labeling Acceptance Task <getworkforcesamplingtask>`
- :ref:`Updating the Status of a Team Labeling Acceptance Task <updateworkforcesamplingtask>`
- :ref:`Querying the Team Labeling Task List by a Team Member <listworkertasks>`
.. toctree::
:maxdepth: 1
:hidden:
querying_the_team_labeling_task_list_of_a_dataset
creating_a_team_labeling_task
querying_details_about_a_team_labeling_task
starting_a_team_labeling_task
updating_a_team_labeling_task
deleting_a_team_labeling_task
creating_a_team_labeling_acceptance_task
querying_the_report_of_a_team_labeling_acceptance_task
updating_the_status_of_a_team_labeling_acceptance_task
querying_the_team_labeling_task_list_by_a_team_member

528
api-ref/source/data_management/labeling_task_management/querying_details_about_a_team_labeling_task.rst
View File

File diff suppressed because it is too large Load Diff

128
api-ref/source/data_management/labeling_task_management/querying_the_report_of_a_team_labeling_acceptance_task.rst
View File

File diff suppressed because it is too large Load Diff

224
api-ref/source/data_management/labeling_task_management/querying_the_team_labeling_task_list_by_a_team_member.rst
View File

File diff suppressed because it is too large Load Diff

521
api-ref/source/data_management/labeling_task_management/querying_the_team_labeling_task_list_of_a_dataset.rst
View File

File diff suppressed because it is too large Load Diff

146
api-ref/source/data_management/labeling_task_management/starting_a_team_labeling_task.rst
View File

File diff suppressed because it is too large Load Diff

150
api-ref/source/data_management/labeling_task_management/updating_a_team_labeling_task.rst
View File

File diff suppressed because it is too large Load Diff

284
api-ref/source/data_management/labeling_task_management/updating_the_status_of_a_team_labeling_acceptance_task.rst
View File

File diff suppressed because it is too large Load Diff

92
api-ref/source/data_management/labeling_team_management/creating_a_labeling_team.rst
View File

@ -1,92 +0,0 @@
:original_name: CreateWorkforce.html
.. _CreateWorkforce:
Creating a Labeling Team
========================
Function
--------
This API is used to create a labeling team.
URI
---
POST /v2/{project_id}/workforces
.. table:: **Table 1** Path Parameters
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+====================================================================================================================+
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
.. table:: **Table 2** Request body parameters
+----------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------+
| Parameter | 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 Parameters
-------------------
**Status code: 201**
.. table:: **Table 3** Response body parameters
============ ====== ======================
Parameter Type Description
============ ====== ======================
workforce_id String ID of a labeling team.
============ ====== ======================
Example Requests
----------------
Creating a Labeling Team
.. code-block::
{
"workforce_name" : "team-123",
"description" : "my team"
}
Example Responses
-----------------
**Status code: 201**
Created
.. code-block::
{
"workforce_id" : "ZUH8gqkjuaib8pxkDdz"
}
Status Codes
------------
=========== ============
Status Code Description
=========== ============
201 Created
401 Unauthorized
403 Forbidden
404 Not Found
=========== ============
Error Codes
-----------
See :ref:`Error Codes <modelarts_03_0095>`.

100
api-ref/source/data_management/labeling_team_management/deleting_a_labeling_team.rst
View File

File diff suppressed because it is too large Load Diff

22
api-ref/source/data_management/labeling_team_management/index.rst
View File

@ -1,22 +0,0 @@
:original_name: workforce_management.html
.. _workforce_management:
Labeling Team Management
========================
- :ref:`Querying the Labeling Team List <listworkforces>`
- :ref:`Creating a Labeling Team <createworkforce>`
- :ref:`Querying Details About a Labeling Team <descworkforce>`
- :ref:`Updating a Labeling Team <updateworkforce>`
- :ref:`Deleting a Labeling Team <deleteworkforce>`
.. toctree::
:maxdepth: 1
:hidden:
querying_the_labeling_team_list
creating_a_labeling_team
querying_details_about_a_labeling_team
updating_a_labeling_team
deleting_a_labeling_team

100
api-ref/source/data_management/labeling_team_management/querying_details_about_a_labeling_team.rst
View File

File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More