forked from docs/modelarts
Update content (#36)
Changes to ma_api from doc-exports#14 This is an automatically created Pull Request for changes to ma_api in opentelekomcloud-docs/doc-exports#14. Please do not edit it manually, since update to the original PR will overwrite local changes. Original patch file, as well as complete rst archive, can be found in the artifacts of the opentelekomcloud-docs/doc-exports#14 Reviewed-by: Beibei <None>
This commit is contained in:
otcbot[bot]
GitHub
parent
3aaf8b07d7
commit
aed5c3e2da
Binary file not shown.
|
Before Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
BIN
api-ref/source/_static/images/en-us_image_0000001298629861.png
Normal file
BIN
api-ref/source/_static/images/en-us_image_0000001298629861.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.7 KiB |
@ -14,10 +14,10 @@ Data Management APIs
|
||||
|
||||
Data management APIs include the APIs for managing datasets, dataset versions, samples, and labels. Use these APIs to create datasets and label data. For details, see :ref:`Data Management APIs <modelarts_03_0299>`.
|
||||
|
||||
Development Environment APIs
|
||||
----------------------------
|
||||
DevEnviron APIs
|
||||
---------------
|
||||
|
||||
.. table:: **Table 1** Development environment APIs
|
||||
.. table:: **Table 1** DevEnviron APIs
|
||||
|
||||
+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
||||
| API | Description |
|
||||
@ -26,7 +26,7 @@ Development Environment APIs
|
||||
+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
||||
| :ref:`Querying a List of Development Environment Instances <modelarts_03_0111>` | Query the development environment instances that meet the search criteria. |
|
||||
+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
||||
| :ref:`Querying the Details About a Development Environment Instance <modelarts_03_0112>` | Query the details about a development environment instance. |
|
||||
| :ref:`Querying Details About a Development Environment Instance <modelarts_03_0112>` | Query the details about a development environment instance. |
|
||||
+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
||||
| :ref:`Modifying the Description of a Development Environment Instance <modelarts_03_0113>` | Modify the description of a development environment instance. |
|
||||
+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
||||
@ -141,6 +141,8 @@ Service Management APIs
|
||||
+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Querying Supported Service Deployment Specifications <modelarts_03_0200>` | Query supported service deployment specifications. |
|
||||
+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Querying Dedicated Resource Pools <modelarts_03_0201>` | Query dedicated resource pools. |
|
||||
+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Authorization Management APIs
|
||||
-----------------------------
|
||||
|
||||
@ -26,7 +26,7 @@ Prerequisites
|
||||
|
||||
- You have obtained the endpoints of and :ref:`ModelArts <modelarts_03_0141>`.
|
||||
- You have located the region where the service is deployed and obtained .
|
||||
- You have obtained the project ID. For details, see :ref:`Obtaining a Project ID and Name <modelarts_03_0147>`.
|
||||
- You have obtained the project ID. For details, see :ref:`Obtaining a Project ID <modelarts_03_0147>`.
|
||||
- You have prepared the training code for TensorFlow. For example, you have stored the boot file **train_mnist_tf.py** in the **/test-modelarts/mnist-tensorflow-code/** directory of OBS.
|
||||
- You have prepared a dataset for the training job. For example, you have stored a training dataset in the **/test-modelarts/dataset-mnist/** directory of OBS.
|
||||
- You have created the output path of the training job, for example, **/test-modelarts/mnist-model/output/**.
|
||||
|
||||
@ -6,3 +6,5 @@ API Calling
|
||||
===========
|
||||
|
||||
ModelArts supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see :ref:`Calling APIs <modelarts_03_0005>`.
|
||||
|
||||
In addition, ModelArts provides SDKs of multiple programming languages for you to use. For details about how to use the SDKs, see `ModelArts SDK Reference <https://docs.otc.t-systems.com/en-us/sdkreference/modelarts/modelarts_04_0001.html>`__.
|
||||
|
||||
@ -23,7 +23,7 @@ Basic Concepts
|
||||
|
||||
.. _modelarts_03_0143__en-us_topic_0171316292_en-us_topic_0170640577_en-us_topic_0169294976_fig1189614168311:
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0171392261.gif
|
||||
.. figure:: /_static/images/en-us_image_0000001254415793.gif
|
||||
:alt: **Figure 1** Project isolation model
|
||||
|
||||
|
||||
|
||||
@ -5,24 +5,8 @@
|
||||
Endpoints
|
||||
=========
|
||||
|
||||
Endpoints are **request address** for calling APIs. Endpoints vary depending on services and regions. To obtain the regions and endpoints, contact the enterprise administrator.
|
||||
|
||||
A service endpoint consists of the service name, region ID, and external domain name in the format of "{service_name}.{region_id}.{external_domain_name}". For details about how to obtain each parameter, see :ref:`Table 1 <modelarts_03_0141__en-us_topic_0000001072357044_table8700253831>`.
|
||||
|
||||
.. _modelarts_03_0141__en-us_topic_0000001072357044_table8700253831:
|
||||
|
||||
.. table:: **Table 1** Obtaining an endpoint
|
||||
|
||||
+----------------------+-------------------------------------------------+------------------------------------------+
|
||||
| Parameter | Description | How to Obtain |
|
||||
+======================+=================================================+==========================================+
|
||||
| service_name | Abbreviation of a case-insensitive service name | **modelarts** for ModelArts by default. |
|
||||
+----------------------+-------------------------------------------------+------------------------------------------+
|
||||
| region_id | Region ID | Obtain the value from the administrator. |
|
||||
+----------------------+-------------------------------------------------+------------------------------------------+
|
||||
| external_domain_name | External domain name suffix | Obtain the value from the administrator. |
|
||||
+----------------------+-------------------------------------------------+------------------------------------------+
|
||||
An endpoint is the **request address** for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see `Regions and Endpoints <https://docs.otc.t-systems.com/en-us/endpoint/index.html>`__.
|
||||
|
||||
.. important::
|
||||
|
||||
If an endpoint uses a domain name, configure the hosts file in the format of "{float-ip} {service_name}.{region_id}.{external_domain_name}" on the local PC. Obtain **float-ip** from the administrator.
|
||||
If an endpoint uses a domain name, configure the hosts file in the format of "{float-ip} {service_name}.{region_id}.{external_domain_name}" on the local PC. Obtain **float-ip** from the system administrator.
|
||||
|
||||
@ -5,4 +5,4 @@
|
||||
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. For details about all ModelArts APIs, see :ref:`API Overview <modelarts_03_0002>`.
|
||||
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>`__.
|
||||
|
||||
@ -49,7 +49,7 @@ In :ref:`Making an API Request <modelarts_03_0005>`, the process of calling the
|
||||
|
||||
After a token is obtained, the **X-Auth-Token** header field must be added to requests to specify the token when calling other APIs. For example, if the token is **ABCDEFJ....**, **X-Auth-Token: ABCDEFJ....** can be added to a request as follows:
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
POST https://{endpoint}/v1/{project_id}/services
|
||||
Content-Type: application/json
|
||||
@ -70,6 +70,10 @@ The following uses a demo project to show how to sign a request and use an HTTP
|
||||
|
||||
Download the demo project at https://github.com/api-gate-way/SdkDemo.
|
||||
|
||||
.. note::
|
||||
|
||||
ModelArts is a regional service. Specify the project ID when calling the API. Therefore, before running the demo project, add the project ID (**X-Project-Id**) in line 110 of access() in **AccessServicelmpl.java**. For details about how to obtain a project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`.
|
||||
|
||||
If you do not need the demo project, visit the following URL to download the API Gateway signing SDK:
|
||||
|
||||
Obtain the API Gateway signing SDK from the enterprise administrator.
|
||||
@ -80,17 +84,9 @@ Decompress the downloaded package and reference the obtained JAR files as depend
|
||||
|
||||
#. Generate an AK/SK. (If an AK/SK file has already been obtained, skip this step and locate the downloaded AK/SK file. Generally, the file name will be **credentials.csv**.)
|
||||
|
||||
a. Log in to ManageOne Operation Portal.
|
||||
b. In the upper right corner of the page, click your account avatar and choose **My Settings** from the drop-down list.
|
||||
c. On the **My Settings** page, the **Project List** tab page is displayed by default. Click the **Manage Access Key** tab page.
|
||||
d. Click **Add Access Key** to create an AK/SK pair.
|
||||
e. Click **OK**. The certificate is automatically downloaded.
|
||||
f. After the certificate is downloaded, obtain the AK and SK information from the **credentials** file.
|
||||
|
||||
.. important::
|
||||
|
||||
- Only two access keys can be added for each user.
|
||||
- To ensure access key security, access keys are automatically downloaded only when they are generated for the first time and cannot be obtained from the management console later. Keep them properly.
|
||||
a. Log in to the console, enter the **My Credentials** page, and choose **Access Keys** > **Create Access Key**.
|
||||
b. In the **Create Access Key** dialog box that is displayed, use the login password for verification.
|
||||
c. Click **OK**, open the **credentials.csv** file, and save the key file as prompted. The access key file is saved in the default downloads folder of the browser. Then, the access key (**Access Key Id** and **Secret Access Key**) is obtained.
|
||||
|
||||
#. Download and decompress the demo project.
|
||||
|
||||
@ -100,7 +96,7 @@ Decompress the downloaded package and reference the obtained JAR files as depend
|
||||
|
||||
.. _modelarts_03_0004__en-us_topic_0129435566_fig10881944183710:
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0150917346.gif
|
||||
.. figure:: /_static/images/en-us_image_0000001209775802.gif
|
||||
:alt: **Figure 1** Selecting Existing Projects into Workspace
|
||||
|
||||
|
||||
@ -108,7 +104,7 @@ Decompress the downloaded package and reference the obtained JAR files as depend
|
||||
|
||||
.. _modelarts_03_0004__en-us_topic_0129435566_fig15961458113717:
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0150917350.gif
|
||||
.. figure:: /_static/images/en-us_image_0000001254535753.gif
|
||||
:alt: **Figure 2** Selecting the demo project
|
||||
|
||||
|
||||
@ -116,7 +112,7 @@ Decompress the downloaded package and reference the obtained JAR files as depend
|
||||
|
||||
.. _modelarts_03_0004__en-us_topic_0129435566_fig74501929113815:
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0150917353.gif
|
||||
.. figure:: /_static/images/en-us_image_0000001254215795.gif
|
||||
:alt: **Figure 3** Structure of the demo project
|
||||
|
||||
|
||||
@ -146,7 +142,7 @@ Decompress the downloaded package and reference the obtained JAR files as depend
|
||||
|
||||
b. Edit the **main()** method in the Demo.java file, and replace the bold text with actual values.
|
||||
|
||||
As shown in the following code, if you use other methods such as POST, PUT, and DELETE, see the corresponding comment. Replace the values of **region**, **serviceName**, **ak**, **sk**, and **url**. The URL for obtaining the VPC is used in the sample project. Replace it with the actual URL. Contact the administrator to obtain the endpoint.
|
||||
As shown in the following code, if you use other methods such as POST, PUT, and DELETE, see the corresponding comment. Replace the values of **region**, **serviceName**, **ak**, **sk**, and **url**. The URL for obtaining the VPC is used in the sample project. Replace it with the actual URL. Contact the system administrator to obtain the endpoint.
|
||||
|
||||
.. code-block::
|
||||
|
||||
@ -195,5 +191,5 @@ Decompress the downloaded package and reference the obtained JAR files as depend
|
||||
|
||||
You can view the API call logs on the console.
|
||||
|
||||
.. |image1| image:: /_static/images/en-us_image_0150916848.gif
|
||||
.. |image1| image:: /_static/images/en-us_image_0000001209615816.gif
|
||||
|
||||
|
||||
@ -130,7 +130,7 @@ The body of a request is often sent in a structured format as specified in the C
|
||||
|
||||
The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
|
||||
|
||||
If an API is used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace *user_name*, *domain_name*, and *user_password* with the actual username, account name, and login password, respectively. **project_name** is the project name. For details, see :ref:`Obtaining a Username <modelarts_03_0006>`, :ref:`Obtaining an Account Name and ID <modelarts_03_0148>`, and :ref:`Obtaining a Project Name <modelarts_03_0147>`.
|
||||
If an API is used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace *user_name*, *domain_name*, and *user_password* with the actual username, account name, and login password, respectively. **project_name** is the project name. For details, see :ref:`Obtaining a Username and ID <modelarts_03_0006>`, :ref:`Obtaining an Account Name and ID <modelarts_03_0148>`, and :ref:`Obtaining a Project ID <modelarts_03_0147>`.
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
@ -61,7 +61,7 @@ Similar to a request, a response also has a header, for example, **Content-type*
|
||||
|
||||
.. _modelarts_03_0003__en-us_topic_0171310283_en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511:
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0171113090.png
|
||||
.. figure:: /_static/images/en-us_image_0000001254535751.png
|
||||
:alt: **Figure 1** Header fields of the response to the request for obtaining a user token
|
||||
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ Error Codes
|
||||
+=============+================+===========================================================================================================================================================+===============================================================================================================================================================+======================================================================================================================================================================================================================+
|
||||
| 400 | ModelArts.0104 | Parameter error. | Parameter error. | Check the parameter settings. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.0113 | Create Notebook failed. Quota: {} is exhausted. | Failed to create the notebook instance due to the exhausted quota. | Contact the administrator for a higher quota. |
|
||||
| 400 | ModelArts.0113 | Create Notebook failed. Quota: {} is exhausted. | Failed to create the notebook instance due to the exhausted quota. | Contact the system administrator for a higher quota. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.6301 | The instance already exists. | The instance already exists. | Enter another instance name. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -522,7 +522,9 @@ Error Codes
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 409 | ModelArts.5044 | Operations conflict, please try again later | Failed to perform the operation. | Try again later. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 500 | ModelArts.5000 | Please try again later or contact customer service to solve the problem | Internal error. | System error. Contact technical support. |
|
||||
| 500 | ModelArts.5000 | Please try again later or contact | Internal error. | System error. Contact technical support. |
|
||||
| | | | | |
|
||||
| | | technical support to solve the problem | | |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 500 | ModelArts.5003 | Internal Error: access IAM service failed | Failed to access IAM. | System error. Contact technical support. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -574,7 +576,7 @@ Error Codes
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.3024 | The templateInputs field is incorrectly configured, check if the input is consistent with the template requirements. | Incorrect configuration. Check whether the configuration complies with the template requirements. | The parameter configuration does not comply with the template requirements. Modify the configuration. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.3025 | User ({0}) has only a single share permission and cannot be shared with all users. | User {0} does not have permission to share data with all users. | Only the administrator or accounts in the whitelist have permission to share data with all users. |
|
||||
| 400 | ModelArts.3025 | User ({0}) has only a single share permission and cannot be shared with all users. | User {0} does not have permission to share data with all users. | Only the system administrator or accounts in the whitelist have permission to share data with all users. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.3026 | Failed to delete infer format, infer format ({0}) already be used by template. | Failed to delete input/output mode {0} because it is being used by a template. | Find the template that is using the input/output mode, disassociate the mode from the template, and delete the mode again. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -656,7 +658,7 @@ Error Codes
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 500 | ModelArts.0010 | Internal error. | Internal error. | Contact R&D and O&M personnel. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 500 | ModelArts.0109 | Unauthorized account. | Unauthorized account. | Only the administrator can call alarm APIs. |
|
||||
| 500 | ModelArts.0109 | Unauthorized account. | Unauthorized account. | Only the system administrator can call alarm APIs. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 500 | ModelArts.3006 | Failed to publish model. | Failed to publish the model. | The model metadata failed to be stored to the database. Contact R&D and O&M personnel. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -1116,7 +1118,7 @@ Error Codes
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 500 | ModelArts.7001 | Unknown workspace system error. Try again later or submit a service ticket for professional technical support. | An internal workspace error occurred. | Contact service O&M personnel. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.7002 | Not gray user, please contact the administrator | Workspace authentication error. | Contact the administrator to check whether the user has permissions on the workspace. |
|
||||
| 400 | ModelArts.7002 | Not gray user, please contact the administrator | Workspace authentication error. | Contact the system administrator to check whether the user has permissions on the workspace. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.7003 | no permission to get iam user list, please check permission | IAM permissions are incorrect. | Add the IAM permissions based on the error message. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
@ -9,6 +9,7 @@ Common Parameters
|
||||
|
||||
status_code
|
||||
error_codes
|
||||
obtaining_a_project_id_and_name
|
||||
obtaining_a_project_id
|
||||
obtaining_an_account_name_and_id
|
||||
obtaining_a_username_and_id
|
||||
obtaining_a_project_name
|
||||
|
||||
@ -2,27 +2,27 @@
|
||||
|
||||
.. _modelarts_03_0147:
|
||||
|
||||
Obtaining a Project ID and Name
|
||||
===============================
|
||||
Obtaining a Project ID
|
||||
======================
|
||||
|
||||
Scenarios
|
||||
---------
|
||||
|
||||
A project ID or name is required for some requests when an API is called. Therefore, obtain the project ID and name before calling the API. Use either of the following methods:
|
||||
A project ID is required for some requests when an API is called. Therefore, obtain the project ID before calling the API. Use either of the following methods:
|
||||
|
||||
- :ref:`Obtaining a Project ID and Name from the Console <modelarts_03_0147__en-us_topic_0171436477_section1747620762418>`
|
||||
- :ref:`Obtaining a Project ID from the Console <modelarts_03_0147__en-us_topic_0171436477_section1747620762418>`
|
||||
- :ref:`Obtaining a Project ID by Calling an API <modelarts_03_0147__en-us_topic_0171436477_section3926171216207>`
|
||||
|
||||
.. _modelarts_03_0147__en-us_topic_0171436477_section1747620762418:
|
||||
|
||||
Obtaining a Project ID and Name from the Console
|
||||
------------------------------------------------
|
||||
Obtaining a Project ID from the Console
|
||||
---------------------------------------
|
||||
|
||||
To do so, perform the following operations:
|
||||
|
||||
#. Log in to the console.
|
||||
#. In the upper right corner, click your account avatar icon and choose **My Settings** from the drop-down list.
|
||||
#. On the **My Settings** page, go to the **Project List** tab page, which is displayed by default. View the project ID and name in the project list.
|
||||
#. On the **My Settings** page, go to the **Project List** tab page, which is displayed by default. View the project ID in the project list.
|
||||
|
||||
.. _modelarts_03_0147__en-us_topic_0171436477_section3926171216207:
|
||||
|
||||
@ -0,0 +1,20 @@
|
||||
:original_name: modelarts_03_0247.html
|
||||
|
||||
.. _modelarts_03_0247:
|
||||
|
||||
Obtaining a Project Name
|
||||
========================
|
||||
|
||||
Scenarios
|
||||
---------
|
||||
|
||||
A project ID or name is required for some requests when an API is called. Therefore, obtain the project ID and name before calling the API.
|
||||
|
||||
Obtaining a Project Name from the Console
|
||||
-----------------------------------------
|
||||
|
||||
To do so, perform the following operations:
|
||||
|
||||
#. Log in to the console.
|
||||
#. In the upper right corner, click your account avatar icon and choose **My Settings** from the drop-down list.
|
||||
#. On the **My Settings** page, go to the **Project List** tab page, which is displayed by default. View the project name in the project list.
|
||||
@ -9,13 +9,13 @@ When you call APIs, certain requests require the username and ID. To obtain a us
|
||||
|
||||
#. Log in to the management console after registration.
|
||||
|
||||
#. In the upper right corner, click your account avatar icon and choose **My Settings** from the drop-down list.
|
||||
#. Hover the cursor on the username and choose **My Credentials** from the drop-down list.
|
||||
|
||||
On the **My Settings** page, view the username and ID.
|
||||
On the **My Credentials** page, view the username and ID.
|
||||
|
||||
.. _modelarts_03_0006__en-us_topic_0000001124853294_fig173616433916:
|
||||
.. _modelarts_03_0006__fig106591844293:
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0000001126895190.png
|
||||
.. figure:: /_static/images/en-us_image_0000001298629861.png
|
||||
:alt: **Figure 1** Viewing the username and ID
|
||||
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ When you call APIs, certain requests require the account name and ID. To obtain
|
||||
|
||||
.. _modelarts_03_0148__en-us_topic_0171436478_fig816634061619:
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0000001126894914.png
|
||||
.. figure:: /_static/images/en-us_image_0000001209615814.png
|
||||
:alt: **Figure 1** Viewing the account name and ID
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -15,7 +15,7 @@ URI
|
||||
|
||||
GET /v2/{project_id}/datasets/{dataset_id}/sync-data/status
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
@ -37,41 +37,29 @@ 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
|
||||
----------------
|
||||
|
||||
@ -15,7 +15,7 @@ URI
|
||||
|
||||
POST /v2/{project_id}/datasets/{dataset_id}/sync-data
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -15,7 +15,7 @@ URI
|
||||
|
||||
DELETE /v2/{project_id}/datasets/{dataset_id}
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -15,7 +15,7 @@ URI
|
||||
|
||||
GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/metrics
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
+-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
|
||||
@ -15,7 +15,7 @@ URI
|
||||
|
||||
GET /v2/{project_id}/datasets/{dataset_id}/metrics
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
@ -25,7 +25,7 @@ GET /v2/{project_id}/datasets/{dataset_id}/metrics
|
||||
| project_id | Yes | String | Project ID. For details about how to obtain the 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 |
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -15,7 +15,7 @@ URI
|
||||
|
||||
POST /v2/{project_id}/datasets/{dataset_id}/versions
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
@ -30,47 +30,25 @@ 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
|
||||
-------------------
|
||||
|
||||
@ -15,7 +15,7 @@ URI
|
||||
|
||||
DELETE /v2/{project_id}/datasets/{dataset_id}/versions/{version_id}
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -20,5 +20,3 @@ Data Management
|
||||
data_import_task/index
|
||||
data_export_task/index
|
||||
data_synchronization_task/index
|
||||
intelligent_task/index
|
||||
processing_task/index
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
.. _auto_task:
|
||||
|
||||
================
|
||||
Intelligent Task
|
||||
================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
querying_auto_labeling_sample_list
|
||||
querying_details_about_an_auto_labeling_sample
|
||||
querying_the_intelligent_task_list_by_page
|
||||
starting_intelligent_tasks
|
||||
obtaining_information_about_intelligent_tasks
|
||||
stopping_an_intelligent_task
|
||||
File diff suppressed because it is too large
Load Diff
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
Loading…
x
Reference in New Issue
Block a user