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

Changes to ma_api-ref from docs/doc-exports#232 (Another series of conversion fixes

Browse Source 
- address duplicated anchor in RDS UMN
- address new escape sequences)

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
This commit is contained in:
proposalbot 2022-09-27 11:51:35 +00:00 committed by zuul
parent c1a70e0d9b
commit b112803263
8 changed files with 40 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
api-ref/source/before_you_start/basic_concepts.rst
View File

@ -21,7 +21,6 @@ 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.
.. _modelarts_03_0143__en-us_topic_0171316292_en-us_topic_0170640577_en-us_topic_0169294976_fig1189614168311:
.. figure:: /_static/images/en-us_image_0000001254415793.gif
:alt: **Figure 1** Project isolation model

8
api-ref/source/calling_apis/authentication.rst
View File

@ -94,7 +94,6 @@ Decompress the downloaded package and reference the obtained JAR files as depend
Import the demo project to Eclipse.
.. _modelarts_03_0004__en-us_topic_0129435566_fig10881944183710:
.. figure:: /_static/images/en-us_image_0000001209775802.gif
:alt: **Figure 1** Selecting Existing Projects into Workspace
@ -102,7 +101,6 @@ Decompress the downloaded package and reference the obtained JAR files as depend
**Figure 1** Selecting Existing Projects into Workspace
.. _modelarts_03_0004__en-us_topic_0129435566_fig15961458113717:
.. figure:: /_static/images/en-us_image_0000001254535753.gif
:alt: **Figure 2** Selecting the demo project
@ -110,7 +108,6 @@ Decompress the downloaded package and reference the obtained JAR files as depend
**Figure 2** Selecting the demo project
.. _modelarts_03_0004__en-us_topic_0129435566_fig74501929113815:
.. figure:: /_static/images/en-us_image_0000001254215795.gif
:alt: **Figure 3** Structure of the demo project
@ -134,7 +131,7 @@ Decompress the downloaded package and reference the obtained JAR files as depend
Uncomment the following code snippet in the **AccessServiceImpl.java** file, and specify the project ID and account ID.
.. code-block::
.. code-block:: text
//TODO: Add special headers.
//request.addHeader("X-Project-Id", "xxxxx");
@ -144,7 +141,7 @@ Decompress the downloaded package and reference the obtained JAR files as depend
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::
.. code-block:: text
//TODO: Replace the value of region with the actual region where the service to be accessed is located.
private static final String region = "";
@ -192,4 +189,3 @@ 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

1
api-ref/source/common_parameters/obtaining_a_username_and_id.rst
View File

@ -13,7 +13,6 @@ 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.
.. _modelarts_03_0006__fig106591844293:
.. figure:: /_static/images/en-us_image_0000001298629861.png
:alt: **Figure 1** Viewing the username and ID

1
api-ref/source/common_parameters/obtaining_an_account_name_and_id.rst
View File

@ -13,7 +13,6 @@ 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.
.. _modelarts_03_0148__en-us_topic_0171436478_fig816634061619:
.. figure:: /_static/images/en-us_image_0000001209615814.png
:alt: **Figure 1** Viewing the account name and ID

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

@ -261,18 +261,18 @@ Request Parameters
.. table:: **Table 10** LabelFormat
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=======================+=================+=================+========================================================================================================================================================================================================================================================================+
| label_type | No | String | Label type of text classification. The options are as follows: |
| | | | |
| | | | - **0**: The label is separated from the text, and they are distinguished by the fixed suffix **\_result**. For example, the text file is **abc.txt**, and the label file is **abc_result.txt**. |
| | | | - **1**: Default value. Labels and texts are stored in the same file and separated by separators. You can use **text_sample_separator** to specify the separator between the text and label and **text_label_separator** to specify the separator between labels. |
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text_label_separator | No | String | Separator between labels. By default, a comma (,) is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;, |
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text_sample_separator | No | String | Separator between the text and label. By default, the **Tab** key is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;, |
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=======================+=================+=================+============================================================================================================================================================================================================================================================================+
| label_type | No | String | Label type of text classification. The options are as follows: |
| | | | |
| | | | - **0**: The label is separated from the text, and they are distinguished by the fixed suffix **\_result**. For example, the text file is **abc.txt**, and the label file is **abc_result.txt**. |
| | | | - **1**: Default value. Labels and texts are stored in the same file and separated by separators. You can use **text_sample_separator** to specify the separator between the text and label and **text_label_separator** to specify the separator between labels. |
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text_label_separator | No | String | Separator between labels. By default, a comma (,) is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: ``!@#$%^&*_=|?/':.;,`` |
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text_sample_separator | No | String | Separator between the text and label. By default, the **Tab** key is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: ``!@#$%^&*_=|?/':.;,`` |
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters
-------------------

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

@ -174,18 +174,18 @@ Request Parameters
.. table:: **Table 6** LabelFormat
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=======================+=================+=================+========================================================================================================================================================================================================================================================================+
| label_type | No | String | Label type of text classification. The options are as follows: |
| | | | |
| | | | - **0**: The label is separated from the text, and they are distinguished by the fixed suffix **\_result**. For example, the text file is **abc.txt**, and the label file is **abc_result.txt**. |
| | | | - **1**: Default value. Labels and texts are stored in the same file and separated by separators. You can use **text_sample_separator** to specify the separator between the text and label and **text_label_separator** to specify the separator between labels. |
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text_label_separator | No | String | Separator between labels. By default, a comma (,) is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;, |
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text_sample_separator | No | String | Separator between the text and label. By default, the **Tab** key is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;, |
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=======================+=================+=================+============================================================================================================================================================================================================================================================================+
| label_type | No | String | Label type of text classification. The options are as follows: |
| | | | |
| | | | - **0**: The label is separated from the text, and they are distinguished by the fixed suffix **\_result**. For example, the text file is **abc.txt**, and the label file is **abc_result.txt**. |
| | | | - **1**: Default value. Labels and texts are stored in the same file and separated by separators. You can use **text_sample_separator** to specify the separator between the text and label and **text_label_separator** to specify the separator between labels. |
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text_label_separator | No | String | Separator between labels. By default, a comma (,) is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: ``!@#$%^&*_=|?/':.;,`` |
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text_sample_separator | No | String | Separator between the text and label. By default, the **Tab** key is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: ``!@#$%^&*_=|?/':.;,`` |
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _createdataset__request_label:

26
api-ref/source/data_management/sample_management/adding_samples_in_batches.rst
View File

@ -47,18 +47,18 @@ Request Parameters
.. table:: **Table 3** LabelFormat
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=======================+=================+=================+========================================================================================================================================================================================================================================================================+
| label_type | No | String | Label type of text classification. The options are as follows: |
| | | | |
| | | | - **0**: The label is separated from the text, and they are distinguished by the fixed suffix **\_result**. For example, the text file is **abc.txt**, and the label file is **abc_result.txt**. |
| | | | - **1**: Default value. Labels and texts are stored in the same file and separated by separators. You can use **text_sample_separator** to specify the separator between the text and label and **text_label_separator** to specify the separator between labels. |
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text_label_separator | No | String | Separator between labels. By default, a comma (,) is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;, |
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text_sample_separator | No | String | Separator between the text and label. By default, the **Tab** key is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;, |
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=======================+=================+=================+============================================================================================================================================================================================================================================================================+
| label_type | No | String | Label type of text classification. The options are as follows: |
| | | | |
| | | | - **0**: The label is separated from the text, and they are distinguished by the fixed suffix **\_result**. For example, the text file is **abc.txt**, and the label file is **abc_result.txt**. |
| | | | - **1**: Default value. Labels and texts are stored in the same file and separated by separators. You can use **text_sample_separator** to specify the separator between the text and label and **text_label_separator** to specify the separator between labels. |
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text_label_separator | No | String | Separator between labels. By default, a comma (,) is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: ``!@#$%^&*_=|?/':.;,`` |
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text_sample_separator | No | String | Separator between the text and label. By default, the **Tab** key is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: ``!@#$%^&*_=|?/':.;,`` |
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _uploadsamplesjson__request_sample:
@ -77,7 +77,7 @@ Request Parameters
+-----------------+-----------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| metadata | No | :ref:`SampleMetadata <uploadsamplesjson__request_samplemetadata>` object | Key-value pair of the sample **metadata** attribute. |
+-----------------+-----------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | No | String | Name of sample files. The value contains 0 to 1,024 characters and cannot contain special characters (!<>=&"'). |
| name | No | String | Name of sample files. The value contains 0 to 1,024 characters and cannot contain special characters ``(!<>=&"').`` |
+-----------------+-----------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| sample_type | No | Integer | Sample type. The options are as follows: |
| | | | |

2
api-ref/source/model_management/importing_a_model.rst
View File

@ -59,7 +59,7 @@ Request Body
+--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | Model remarks. The value contains a maximum of 100 characters and cannot contain the following special characters and more: &!'\"<>= |
+--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| model_algorithm | No | String | Model algorithm. If the algorithm is read from the configuration file, this parameter can be left blank. For example, the value can be **predict_analysis**, **object_detection**, or **image_classification**. The value must start with a letter and contain no more than 36 characters. Chinese characters and special characters (&!'\"<>=) are not allowed. |
| model_algorithm | No | String | Model algorithm. If the algorithm is read from the configuration file, this parameter can be left blank. For example, the value can be **predict_analysis**, **object_detection**, or **image_classification**. The value must start with a letter and contain no more than 36 characters. Chinese characters and special characters ``(&!'\"<>=)`` are not allowed. |
+--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| execution_code | No | String | OBS path for storing the execution code. By default, this parameter is left blank. The name of the execution code file is fixed to **customize_service.py**. The inference code file must be stored in the **model** directory. If this parameter is left blank, the system can automatically identify the inference code in the **model** directory. |
+--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+