forked from docs/modelarts
Compare commits
5 Commits
main
...
propose-ma
| Author | SHA1 | Date | |
|---|---|---|---|
| 5d1a90a2b4 | |||
| ac704e7b8c | |||
| a25519afde | |||
| 8908f23fa4 | |||
| 169f7a59c1 |
|
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: 20 KiB After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 9.7 KiB After Width: | Height: | Size: 9.7 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
@ -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 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 <modelarts_03_0410>` | View an authorization list. |
|
||||
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Configuring Authorization <modelarts_03_0409>` | Configure ModelArts authorization. ModelArts functions such as real-time services can be properly used only after required permissions are assigned. |
|
||||
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Deleting Authorization <modelarts_03_0411>` | Delete the authorization of a specified user or all users. |
|
||||
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Creating a ModelArts Agency <modelarts_03_0412>` | Create a ModelArts agency for dependent services such as OBS, SWR, and IEF. |
|
||||
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
:original_name: CreateAuthorization.html
|
||||
:original_name: modelarts_03_0409.html
|
||||
|
||||
.. _CreateAuthorization:
|
||||
.. _modelarts_03_0409:
|
||||
|
||||
Configuring Authorization
|
||||
=========================
|
||||
@ -8,7 +8,7 @@ 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 authorization is configured. This API allows the administrator to configure an agency for IAM users and set an 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 system administrator to configure an agency for IAM users and set an access key of the current user.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
:original_name: CreateModelArtsAgency.html
|
||||
:original_name: modelarts_03_0412.html
|
||||
|
||||
.. _CreateModelArtsAgency:
|
||||
.. _modelarts_03_0412:
|
||||
|
||||
Creating a ModelArts Agency
|
||||
===========================
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
:original_name: DeleteAuthorizations.html
|
||||
:original_name: modelarts_03_0411.html
|
||||
|
||||
.. _DeleteAuthorizations:
|
||||
.. _modelarts_03_0411:
|
||||
|
||||
Deleting Authorization
|
||||
======================
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
:original_name: authorization.html
|
||||
:original_name: modelarts_03_0408.html
|
||||
|
||||
.. _authorization:
|
||||
.. _modelarts_03_0408:
|
||||
|
||||
Authorization Management
|
||||
========================
|
||||
|
||||
- :ref:`Configuring Authorization <createauthorization>`
|
||||
- :ref:`Viewing an Authorization List <getauthorizations>`
|
||||
- :ref:`Deleting Authorization <deleteauthorizations>`
|
||||
- :ref:`Creating a ModelArts Agency <createmodelartsagency>`
|
||||
- :ref:`Configuring Authorization <modelarts_03_0409>`
|
||||
- :ref:`Viewing an Authorization List <modelarts_03_0410>`
|
||||
- :ref:`Deleting Authorization <modelarts_03_0411>`
|
||||
- :ref:`Creating a ModelArts Agency <modelarts_03_0412>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
:original_name: GetAuthorizations.html
|
||||
:original_name: modelarts_03_0410.html
|
||||
|
||||
.. _GetAuthorizations:
|
||||
.. _modelarts_03_0410:
|
||||
|
||||
Viewing an Authorization List
|
||||
=============================
|
||||
@ -33,6 +33,7 @@ GET /v2/{project_id}/authorizations
|
||||
| | | | Options: |
|
||||
| | | | |
|
||||
| | | | - **user_name**: IAM user |
|
||||
| | | | |
|
||||
| | | | - **create_time**: creation time |
|
||||
| | | | |
|
||||
| | | | Default: **user_name** |
|
||||
@ -42,6 +43,7 @@ GET /v2/{project_id}/authorizations
|
||||
| | | | Options: |
|
||||
| | | | |
|
||||
| | | | - **asc**: ascending order |
|
||||
| | | | |
|
||||
| | | | - **desc**: descending order |
|
||||
| | | | |
|
||||
| | | | Default: **asc** |
|
||||
@ -70,10 +72,10 @@ Response Parameters
|
||||
+=============+===================================================================================================+=================================+
|
||||
| total_count | Number | Authorization information. |
|
||||
+-------------+---------------------------------------------------------------------------------------------------+---------------------------------+
|
||||
| auth | Array of :ref:`AuthorizationResponse <getauthorizations__response_authorizationresponse>` objects | Authorization information list. |
|
||||
| auth | Array of :ref:`AuthorizationResponse <modelarts_03_0410__response_authorizationresponse>` objects | Authorization information list. |
|
||||
+-------------+---------------------------------------------------------------------------------------------------+---------------------------------+
|
||||
|
||||
.. _getauthorizations__response_authorizationresponse:
|
||||
.. _modelarts_03_0410__response_authorizationresponse:
|
||||
|
||||
.. table:: **Table 4** AuthorizationResponse
|
||||
|
||||
@ -91,6 +93,7 @@ Response Parameters
|
||||
| | | Options: |
|
||||
| | | |
|
||||
| | | - **agency**: authorization through an agency |
|
||||
| | | |
|
||||
| | | - **credential**: authorization through an access Key (AK/SK) |
|
||||
| | | |
|
||||
| | | Default: **agency** |
|
||||
@ -98,11 +101,12 @@ Response Parameters
|
||||
| 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. |
|
||||
| create_time | Long | Timestamp when a training job was created |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Example Requests
|
||||
|
||||
@ -22,7 +22,7 @@ Basic Concepts
|
||||
Projects group and isolate compute, storage, and network resources across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.
|
||||
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0000001254415793.gif
|
||||
.. figure:: /_static/images/en-us_image_0000001455264321.gif
|
||||
:alt: **Figure 1** Project isolation model
|
||||
|
||||
**Figure 1** Project isolation model
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
Before You Start
|
||||
================
|
||||
|
||||
- :ref:`Overview <modelarts_03_0001>`
|
||||
- :ref:`Overview <modelarts_03_1002>`
|
||||
- :ref:`API Calling <modelarts_03_0140>`
|
||||
- :ref:`Endpoints <modelarts_03_0141>`
|
||||
- :ref:`Basic Concepts <modelarts_03_0143>`
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
:original_name: modelarts_03_0001.html
|
||||
:original_name: modelarts_03_1002.html
|
||||
|
||||
.. _modelarts_03_0001:
|
||||
.. _modelarts_03_1002:
|
||||
|
||||
Overview
|
||||
========
|
||||
|
||||
@ -95,19 +95,19 @@ Decompress the downloaded package and reference the obtained JAR files as depend
|
||||
Import the demo project to Eclipse.
|
||||
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0000001209775802.gif
|
||||
.. figure:: /_static/images/en-us_image_0000001404664602.gif
|
||||
:alt: **Figure 1** Selecting Existing Projects into Workspace
|
||||
|
||||
**Figure 1** Selecting Existing Projects into Workspace
|
||||
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0000001254535753.gif
|
||||
.. figure:: /_static/images/en-us_image_0000001455264277.gif
|
||||
:alt: **Figure 2** Selecting the demo project
|
||||
|
||||
**Figure 2** Selecting the demo project
|
||||
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0000001254215795.gif
|
||||
.. figure:: /_static/images/en-us_image_0000001454864609.gif
|
||||
:alt: **Figure 3** Structure of the demo project
|
||||
|
||||
**Figure 3** Structure of the demo project
|
||||
@ -124,15 +124,14 @@ Decompress the downloaded package and reference the obtained JAR files as depend
|
||||
|
||||
The following describes how to call a POST method to sign the request.
|
||||
|
||||
a. (Optional) Add request header fields.
|
||||
a. Add request header fields.
|
||||
|
||||
Uncomment the following code snippet in the **AccessServiceImpl.java** file, and specify the project ID and account ID.
|
||||
Comment out the following second line of code in the **AccessServiceImpl.java** file, and specify the project ID.
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
//TODO: Add special headers.
|
||||
//request.addHeader("X-Project-Id", "xxxxx");
|
||||
//request.addHeader("X-Domain-Id", "xxxxx");
|
||||
|
||||
b. Edit the **main()** method in the Demo.java file, and replace the bold text with actual values.
|
||||
|
||||
@ -185,4 +184,4 @@ 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_0000001209615816.gif
|
||||
.. |image1| image:: /_static/images/en-us_image_0000001404504698.gif
|
||||
|
||||
@ -126,9 +126,7 @@ The API for obtaining a user token does not require authentication. Therefore, t
|
||||
Request Body
|
||||
------------
|
||||
|
||||
The body of a request is often sent in a structured format as specified in the Content-Type header field. The request body transfers content except the request header. If the request body contains Chinese characters, these characters must be encoded in UTF-8.
|
||||
|
||||
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.
|
||||
The body of a request is often sent in a structured format as specified in the Content-Type header field. The request body transfers content except the request header.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 and ID <modelarts_03_0006>`, :ref:`Obtaining an Account Name and ID <modelarts_03_0148>`, and :ref:`Obtaining a Project ID <modelarts_03_0147>`.
|
||||
|
||||
|
||||
@ -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_0000001254535751.png
|
||||
.. figure:: /_static/images/en-us_image_0000001404984470.png
|
||||
:alt: **Figure 1** Header fields of the response to the request for obtaining a user token
|
||||
|
||||
**Figure 1** Header fields of the response to the request for obtaining a user token
|
||||
|
||||
@ -5,8 +5,25 @@
|
||||
Change History
|
||||
==============
|
||||
|
||||
=========== ===================================
|
||||
Released On Description
|
||||
=========== ===================================
|
||||
2021-04-30 This is the first official release.
|
||||
=========== ===================================
|
||||
+-----------------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| Released On | Description |
|
||||
+===================================+===============================================================================================+
|
||||
| 2023-01-16 | Optimized the descriptions in: :ref:`Importing a Model <modelarts_03_0076>` |
|
||||
+-----------------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| 2022-10-28 | Optimized the descriptions in: |
|
||||
| | |
|
||||
| | - :ref:`Creating a Development Environment Instance <modelarts_03_0110>` |
|
||||
| | - :ref:`Querying a List of Development Environment Instances <modelarts_03_0111>` |
|
||||
| | - :ref:`Querying Details About a Development Environment Instance <modelarts_03_0112>` |
|
||||
| | - :ref:`Modifying the Description of a Development Environment Instance <modelarts_03_0113>` |
|
||||
| | - :ref:`Error Codes <modelarts_03_0095>` |
|
||||
+-----------------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| 2022-08-03 | Optimized the descriptions in: :ref:`Authentication <modelarts_03_0004>`. |
|
||||
+-----------------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| 2022-05-12 | Optimized the descriptions in: |
|
||||
| | |
|
||||
| | - :ref:`DevEnviron <modelarts_03_0108>` |
|
||||
| | - :ref:`Training Management <modelarts_03_0043>` |
|
||||
+-----------------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| 2021-04-30 | This is the first official release. |
|
||||
+-----------------------------------+-----------------------------------------------------------------------------------------------+
|
||||
|
||||
@ -54,8 +54,6 @@ Error Codes
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.6330 | The flavor type of profile does not match the type of flavor. Please check it. | The types are not matched. | Ensure that the flavor type matches the profile type. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.6331 | The evs volume size ranges from {} GB to {} GB. | The EVS disk size exceeds the upper limit. | Check the EVS disk size. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.6332 | Incorrect parameter type. The '{}' parameter must be of the '{}' type. | Parameter type error. | Ensure that the parameter type meets the requirements. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.6333 | The notebook is being restored. Refresh the page and wait for several minutes. The fault may be caused by instance overload. | Notebook instance fault. | The instance is recovering. Try again later. |
|
||||
@ -72,8 +70,6 @@ Error Codes
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.6344 | Delete failed. Please delete the associated development environment instance first. | Failed to delete the repository. | Delete the corresponding notebook instance first. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.6345 | Currently the OBS type instance does not support git capability. | The Git repository cannot be used for OBS instances. | Use notebook instances of the EVS type. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.6346 | The timestamp of auto stop must be later than the current timestamp. | This parameter cannot be modified. | Check the corresponding parameter and ensure that the automatic end time is later than the current time. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.6347 | When the instance is in the '{}' status, the '{}' parameter cannot be modified. | Failed to modify the parameter. | Check the corresponding parameter. |
|
||||
@ -108,8 +104,6 @@ Error Codes
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.6379 | No IAM agency created in Settings. Create an IAM agency on the ModelArts management console. | No agency is created in the global settings. | Create an agency in the global settings. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.6528 | No EVS available. Please try again later. | The EVS disk has been sold out. | Try again later or contact technical support. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 401 | ModelArts.6201 | The user's account has been suspended. | The user account is frozen. | Check the account balance and top up the account. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 401 | ModelArts.6203 | The user's account has been restricted. | The user account is restricted. | Check the account balance and top up the account. |
|
||||
@ -160,7 +154,7 @@ Error Codes
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.4312 | OBS path does not exist | Incorrect or invalid bucket name. | Ensure that the bucket name is correct and that the bucket name exists in OBS. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.4313 | OBS path is invalid | Invalid characters in the OBS path. | Ensure that the OBS path consists of valid characters, including digits, letters, hyphens (-), underscores (_), slashes (/), and Chinese characters. |
|
||||
| 400 | ModelArts.4313 | OBS path is invalid | Invalid characters in the OBS path. | Ensure that the OBS path consists of valid characters, including digits, letters, hyphens (-), underscores (_), slashes (/) |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.4314 | Obs error | OBS access error. | Ensure that you have the permission to access OBS and that the OBS path is valid. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -572,7 +566,7 @@ Error Codes
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.3017 | Failed to publish model because source location noncompliance. | Failed to publish the model because the model source path does not meet specifications. | Check whether the source_location value complies with the specifications. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.3023 | Invalid labels({0}) of model. | Invalid model label {0}. | Ensure that a model label starts with a letter or a Chinese character and contains a maximum of 64 characters, including letters, digits, underscores (_), and Chinese characters. |
|
||||
| 400 | ModelArts.3023 | Invalid labels({0}) of model. | Invalid model label {0}. | Ensure that a model label starts with a letter and contains a maximum of 64 characters, including letters, digits, underscores (_) |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -590,7 +584,7 @@ Error Codes
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.3031 | Cancel sharing failed, ({0}) has not been shared with other tenants. | Failed to cancel the sharing because image {0} is not shared with other users. | Ensure that image {0} is not shared with other users. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.3032 | Image ({0}) cannot be shared to admin ({1}), please check the image permissions. | Failed to share image {0} with the administrator {0}. Check the image permission. | Perform operations according to the error message. |
|
||||
| 400 | ModelArts.3032 | Image ({0}) cannot be shared to admin ({1}), please check the image permissions. | Failed to share image {0} with the system administrator {0}. Check the image permission. | Perform operations according to the error message. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 400 | ModelArts.3033 | Template publishing failed, please provide template label. | Failed to publish the template model because its label is left blank. | Set the model label. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -694,7 +688,7 @@ Error Codes
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 500 | ModelArts.3059 | Task output ({0}) not meeting the specification. | Task output {0} does not comply with specifications. | Ensure that the task output is a valid HTTP or HTTPS address. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 500 | ModelArts.3060 | Task spec ({0}) not meeting the specification. | Advanced task option {0} does not comply with specifications. | Ensure that the advanced option does not contain Chinese characters or the following characters: ``(|)&$?<>.`` Ensure that the value is less than 4000. |
|
||||
| 500 | ModelArts.3060 | Task spec ({0}) not meeting the specification. | Advanced task option {0} does not comply with specifications. | Ensure that the advanced option does not contain the following characters: ``(|)&$?<>.`` Ensure that the value is less than 4000. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 500 | ModelArts.3061 | get Task ({0}) log parameter not meeting the specification. | Log parameters of task {0} do not comply with specifications. | Ensure that the offset or lines value is greater than or equal to 0. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -1118,7 +1112,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 system administrator to check whether the user has permissions on the workspace. |
|
||||
| 400 | ModelArts.7002 | Not gray user, please contact the system 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. |
|
||||
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
@ -14,7 +14,7 @@ When you call APIs, certain requests require the username and ID. To obtain a us
|
||||
On the **My Credentials** page, view the username and ID.
|
||||
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0000001298629861.png
|
||||
.. figure:: /_static/images/en-us_image_0000001454984465.png
|
||||
:alt: **Figure 1** Viewing the username and ID
|
||||
|
||||
**Figure 1** Viewing the username and ID
|
||||
|
||||
@ -14,7 +14,7 @@ When you call APIs, certain requests require the account name and ID. To obtain
|
||||
On the **API Credentials** page, view the account name and ID.
|
||||
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0000001209615814.png
|
||||
.. figure:: /_static/images/en-us_image_0000001404824466.png
|
||||
:alt: **Figure 1** Viewing the account name and ID
|
||||
|
||||
**Figure 1** Viewing the account name and ID
|
||||
|
||||
@ -94,6 +94,9 @@ html_title = "ModelArts - API Reference"
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Do not include sources into the rendered results
|
||||
html_copy_source = False
|
||||
|
||||
# -- Options for PDF output --------------------------------------------------
|
||||
latex_documents = [
|
||||
('index',
|
||||
|
||||
@ -317,7 +317,7 @@ Request Parameters
|
||||
+--------------------------------+-----------------+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| task_name | Yes | String | Name of a team labeling task. The value contains 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). |
|
||||
+--------------------------------+-----------------+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| workforces_config | No | :ref:`WorkforcesConfig <createdataset__request_workforcesconfig>` object | Manpower assignment of a team labeling task. You can delegate the administrator to assign the manpower or do it by yourself. |
|
||||
| workforces_config | No | :ref:`WorkforcesConfig <createdataset__request_workforcesconfig>` object | Manpower assignment of a team labeling task. You can delegate the team administrator to assign the manpower or do it by yourself. |
|
||||
+--------------------------------+-----------------+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _createdataset__request_workforcesconfig:
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
Dataset Management
|
||||
==================
|
||||
|
||||
- :ref:`Response body for querying the dataset list. <listdatasets>`
|
||||
- :ref:`Querying the Dataset List <listdatasets>`
|
||||
- :ref:`Creating a Dataset <createdataset>`
|
||||
- :ref:`Querying Details About a Dataset <descdataset>`
|
||||
- :ref:`Modifying a Dataset <updatedataset>`
|
||||
@ -17,7 +17,7 @@ Dataset Management
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
response_body_for_querying_the_dataset_list.
|
||||
querying_the_dataset_list
|
||||
creating_a_dataset
|
||||
querying_details_about_a_dataset
|
||||
modifying_a_dataset
|
||||
|
||||
@ -34,36 +34,22 @@ GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/stats
|
||||
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------+
|
||||
| locale | No | String | Language. The options are as follows: |
|
||||
| | | | |
|
||||
| | | | - **zh-cn**: Chinese |
|
||||
| | | | |
|
||||
| | | | - **en-us**: English (default value) |
|
||||
| | | | **en-us**: English (default value) |
|
||||
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------+
|
||||
| sample_state | No | String | Query statistics on samples in a specified state. The options are as follows: |
|
||||
| | | | |
|
||||
| | | | - **ALL**: labeled |
|
||||
| | | | |
|
||||
| | | | - **NONE**: unlabeled |
|
||||
| | | | |
|
||||
| | | | - **UNCHECK**: pending acceptance |
|
||||
| | | | |
|
||||
| | | | - **ACCEPTED**: accepted |
|
||||
| | | | |
|
||||
| | | | - **REJECTED**: rejected |
|
||||
| | | | |
|
||||
| | | | - **UNREVIEWED**: pending review |
|
||||
| | | | |
|
||||
| | | | - **REVIEWED**: reviewed |
|
||||
| | | | |
|
||||
| | | | - **WORKFORCE_SAMPLED**: sampled |
|
||||
| | | | |
|
||||
| | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked |
|
||||
| | | | |
|
||||
| | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked |
|
||||
| | | | |
|
||||
| | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted |
|
||||
| | | | |
|
||||
| | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected |
|
||||
| | | | |
|
||||
| | | | - **AUTO_ANNOTATION**: to be confirmed |
|
||||
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------+
|
||||
|
||||
@ -87,7 +73,6 @@ Response Parameters
|
||||
| data_spliting_enable | Boolean | Whether the dataset can be split into training set and validation set based on the sample labeling statistics. The options are as follows: |
|
||||
| | | |
|
||||
| | | - **true**: The dataset can be split into training set and validation set. |
|
||||
| | | |
|
||||
| | | - **false**: The dataset cannot be split into training set and validation set. |
|
||||
+-----------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| grouped_label_stats | Map<String,Array<:ref:`LabelStats <liststats__response_labelstats>`>> | Label statistics grouped by labeling type. |
|
||||
@ -123,23 +108,14 @@ Response Parameters
|
||||
| type | 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 |
|
||||
+-----------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
@ -155,17 +131,11 @@ Response Parameters
|
||||
| @modelarts:default_shape | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: |
|
||||
| | | |
|
||||
| | | - **bndbox**: rectangle |
|
||||
| | | |
|
||||
| | | - **polygon**: polygon |
|
||||
| | | |
|
||||
| | | - **circle**: circle |
|
||||
| | | |
|
||||
| | | - **line**: straight line |
|
||||
| | | |
|
||||
| | | - **dashed**: dotted line |
|
||||
| | | |
|
||||
| | | - **point**: point |
|
||||
| | | |
|
||||
| | | - **polyline**: polyline |
|
||||
+--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| @modelarts:from_type | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. |
|
||||
@ -218,7 +188,6 @@ Response Parameters
|
||||
| type | String | Label attribute type. The options are as follows: |
|
||||
| | | |
|
||||
| | | - **text**: text |
|
||||
| | | |
|
||||
| | | - **select**: single-choice drop-down list |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------+
|
||||
| values | Array of :ref:`LabelAttributeValue <liststats__response_labelattributevalue>` objects | List of label attribute values. |
|
||||
|
||||
@ -2,8 +2,8 @@
|
||||
|
||||
.. _ListDatasets:
|
||||
|
||||
Response body for querying the dataset list.
|
||||
============================================
|
||||
Querying the Dataset List
|
||||
=========================
|
||||
|
||||
Function
|
||||
--------
|
||||
@ -34,8 +34,7 @@ GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/{sample_id}
|
||||
+=================+=================+=================+======================================================+
|
||||
| locale | No | String | Language. The options are as follows: |
|
||||
| | | | |
|
||||
| | | | - **en-us**: English (default value) |
|
||||
| | | | - **zh-cn**: Chinese |
|
||||
| | | | **en-us**: English (default value) |
|
||||
+-----------------+-----------------+-----------------+------------------------------------------------------+
|
||||
| sample_state | No | String | Sample status. The options are as follows: |
|
||||
| | | | |
|
||||
|
||||
@ -54,8 +54,7 @@ GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples
|
||||
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| locale | No | String | Language. The options are as follows: |
|
||||
| | | | |
|
||||
| | | | - **en-us**: English (default value) |
|
||||
| | | | - **zh-cn**: Chinese |
|
||||
| | | | **en-us**: English (default value) |
|
||||
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| low_score | No | String | Lower confidence limit. The default value is **0**. |
|
||||
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
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
@ -161,7 +161,7 @@ Response Body
|
||||
| | | |
|
||||
| | | This parameter is mandatory when **promo_type** is set to **Free** and **status** is set to **soldOut**. |
|
||||
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| storage_list | Array<Storage type> | Supported storage type. The options are **obs**, **evs**, and **efs**. |
|
||||
| storage_list | Array<Storage type> | Supported storage type. The options are **obs** and **efs**. |
|
||||
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| is_permitted | Boolean | Whether the current user has the permission to use this flavor |
|
||||
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+
|
||||
@ -265,7 +265,7 @@ Response Body
|
||||
+=======================+=======================+============================================================================================================================================================================================================+
|
||||
| type | String | Storage type. |
|
||||
| | | |
|
||||
| | | Only **obs** and **evs** are supported. |
|
||||
| | | Only **obs** is supported. |
|
||||
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| location | Object | Storage location. If **type** is set to **obs**, this parameter is mandatory. See :ref:`Table 13 <modelarts_03_0112__en-us_topic_0136223951_table212131963416>`. By default, this parameter is left blank. |
|
||||
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -490,11 +490,10 @@ The following shows how to obtain the details about instance **6fa459ea-ee8a-3ca
|
||||
"extend_storage": null,
|
||||
"storage": {
|
||||
"location": {
|
||||
"path": "/home/ma-user/work",
|
||||
"volume_size": 5,
|
||||
"volume_unit": "GB"
|
||||
"path": "/home/ma-user/work"
|
||||
},
|
||||
"type": "evs"
|
||||
"type": "obs"
|
||||
|
||||
}
|
||||
},
|
||||
"status": "RUNNING",
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -72,8 +72,6 @@ Response Body
|
||||
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| display_en | String | Specifications description in English |
|
||||
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| display_cn | String | Specifications description in Chinese |
|
||||
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Samples
|
||||
-------
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user