diff --git a/docs/modelarts/sdk-ref/ALL_META.TXT.json b/docs/modelarts/sdk-ref/ALL_META.TXT.json index 70aaf559..50c3000f 100644 --- a/docs/modelarts/sdk-ref/ALL_META.TXT.json +++ b/docs/modelarts/sdk-ref/ALL_META.TXT.json @@ -193,7 +193,7 @@ "uri":"modelarts_04_0131.html", "product_code":"modelarts", "code":"20", - "des":"For training on the training platform, if the training fails, you can view the detailed log information on the platform or by calling the API in Querying Training Job Log", + "des":"If a training job failed on the training platform, view detailed logs on the platform or by calling the API in Obtaining Training Job Logs.In ModelArts notebook, you do n", "doc_type":"sdkreference", "kw":"Creating a Training Job,Training Jobs,SDK Reference", "title":"Creating a Training Job", @@ -203,27 +203,27 @@ "uri":"modelarts_04_0160.html", "product_code":"modelarts", "code":"21", - "des":"In a ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other develop", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", - "kw":"Querying the List of Training Jobs,Training Jobs,SDK Reference", - "title":"Querying the List of Training Jobs", + "kw":"Obtaining Training Jobs,Training Jobs,SDK Reference", + "title":"Obtaining Training Jobs", "githuburl":"" }, { "uri":"modelarts_04_0161.html", "product_code":"modelarts", "code":"22", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", - "kw":"Querying the Details About a Training Job,Training Jobs,SDK Reference", - "title":"Querying the Details About a Training Job", + "kw":"Obtaining Details About a Training Job,Training Jobs,SDK Reference", + "title":"Obtaining Details About a Training Job", "githuburl":"" }, { "uri":"modelarts_04_0162.html", "product_code":"modelarts", "code":"23", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", "kw":"Modifying the Description of a Training Job,Training Jobs,SDK Reference", "title":"Modifying the Description of a Training Job", @@ -233,7 +233,7 @@ "uri":"modelarts_04_0163.html", "product_code":"modelarts", "code":"24", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", "kw":"Obtaining the Name of a Training Job Log File,Training Jobs,SDK Reference", "title":"Obtaining the Name of a Training Job Log File", @@ -243,10 +243,10 @@ "uri":"modelarts_04_0164.html", "product_code":"modelarts", "code":"25", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", - "kw":"Querying Training Job Logs,Training Jobs,SDK Reference", - "title":"Querying Training Job Logs", + "kw":"Obtaining Training Job Logs,Training Jobs,SDK Reference", + "title":"Obtaining Training Job Logs", "githuburl":"" }, { @@ -293,17 +293,17 @@ "uri":"modelarts_04_0170.html", "product_code":"modelarts", "code":"30", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", - "kw":"Querying the Details About a Training Job Version,Training Job Versions,SDK Reference", - "title":"Querying the Details About a Training Job Version", + "kw":"Obtaining Details About a Training Job Version,Training Job Versions,SDK Reference", + "title":"Obtaining Details About a Training Job Version", "githuburl":"" }, { "uri":"modelarts_04_0171.html", "product_code":"modelarts", "code":"31", - "des":"You can stop a training job version that is being created only when the job is running.In the ModelArts notebook instance, you do not need to enter authentication paramet", + "des":"You can stop a training job version that is being created only when the job is running.In ModelArts notebook, you do not need to enter authentication parameters for sessi", "doc_type":"sdkreference", "kw":"Stopping a Training Job Version,Training Job Versions,SDK Reference", "title":"Stopping a Training Job Version", @@ -313,7 +313,7 @@ "uri":"modelarts_04_0172.html", "product_code":"modelarts", "code":"32", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", "kw":"Deleting a Training Job Version,Training Job Versions,SDK Reference", "title":"Deleting a Training Job Version", @@ -353,27 +353,27 @@ "uri":"modelarts_04_0176.html", "product_code":"modelarts", "code":"36", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", - "kw":"Querying the List of Training Job Configurations,Training Job Parameter Configuration,SDK Reference", - "title":"Querying the List of Training Job Configurations", + "kw":"Obtaining Training Job Configurations,Training Job Parameter Configuration,SDK Reference", + "title":"Obtaining Training Job Configurations", "githuburl":"" }, { "uri":"modelarts_04_0177.html", "product_code":"modelarts", "code":"37", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", - "kw":"Querying the Details About a Training Job Configuration,Training Job Parameter Configuration,SDK Ref", - "title":"Querying the Details About a Training Job Configuration", + "kw":"Obtaining Details About a Training Job Configuration,Training Job Parameter Configuration,SDK Refere", + "title":"Obtaining Details About a Training Job Configuration", "githuburl":"" }, { "uri":"modelarts_04_0178.html", "product_code":"modelarts", "code":"38", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", "kw":"Modifying a Training Job Configuration,Training Job Parameter Configuration,SDK Reference", "title":"Modifying a Training Job Configuration", @@ -383,7 +383,7 @@ "uri":"modelarts_04_0179.html", "product_code":"modelarts", "code":"39", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", "kw":"Deleting a Training Job Configuration,Training Job Parameter Configuration,SDK Reference", "title":"Deleting a Training Job Configuration", @@ -423,27 +423,27 @@ "uri":"modelarts_04_0183.html", "product_code":"modelarts", "code":"43", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", - "kw":"Querying the List of Visualization Jobs,Visualization Jobs,SDK Reference", - "title":"Querying the List of Visualization Jobs", + "kw":"Obtaining Visualization Jobs,Visualization Jobs,SDK Reference", + "title":"Obtaining Visualization Jobs", "githuburl":"" }, { "uri":"modelarts_04_0184.html", "product_code":"modelarts", "code":"44", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", - "kw":"Querying the Details About a Visualization Job,Visualization Jobs,SDK Reference", - "title":"Querying the Details About a Visualization Job", + "kw":"Obtaining Details About a Visualization Job,Visualization Jobs,SDK Reference", + "title":"Obtaining Details About a Visualization Job", "githuburl":"" }, { "uri":"modelarts_04_0185.html", "product_code":"modelarts", "code":"45", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", "kw":"Modifying the Description of a Visualization Job,Visualization Jobs,SDK Reference", "title":"Modifying the Description of a Visualization Job", @@ -453,7 +453,7 @@ "uri":"modelarts_04_0186.html", "product_code":"modelarts", "code":"46", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", "kw":"Stopping a Visualization Job,Visualization Jobs,SDK Reference", "title":"Stopping a Visualization Job", @@ -463,7 +463,7 @@ "uri":"modelarts_04_0187.html", "product_code":"modelarts", "code":"47", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", "kw":"Restarting a Visualization Job,Visualization Jobs,SDK Reference", "title":"Restarting a Visualization Job", @@ -473,7 +473,7 @@ "uri":"modelarts_04_0188.html", "product_code":"modelarts", "code":"48", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", "kw":"Deleting a Visualization Job,Visualization Jobs,SDK Reference", "title":"Deleting a Visualization Job", @@ -493,10 +493,10 @@ "uri":"modelarts_04_0190.html", "product_code":"modelarts", "code":"50", - "des":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "des":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "doc_type":"sdkreference", - "kw":"Querying a Built-in Algorithm,Resource and Engine Specifications,SDK Reference", - "title":"Querying a Built-in Algorithm", + "kw":"Obtaining a Built-in Algorithm,Resource and Engine Specifications,SDK Reference", + "title":"Obtaining a Built-in Algorithm", "githuburl":"" }, { diff --git a/docs/modelarts/sdk-ref/CLASS.TXT.json b/docs/modelarts/sdk-ref/CLASS.TXT.json index 5fd57222..a8bee08e 100644 --- a/docs/modelarts/sdk-ref/CLASS.TXT.json +++ b/docs/modelarts/sdk-ref/CLASS.TXT.json @@ -171,7 +171,7 @@ "code":"19" }, { - "desc":"For training on the training platform, if the training fails, you can view the detailed log information on the platform or by calling the API in Querying Training Job Log", + "desc":"If a training job failed on the training platform, view detailed logs on the platform or by calling the API in Obtaining Training Job Logs.In ModelArts notebook, you do n", "product_code":"modelarts", "title":"Creating a Training Job", "uri":"modelarts_04_0131.html", @@ -180,25 +180,25 @@ "code":"20" }, { - "desc":"In a ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other develop", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", - "title":"Querying the List of Training Jobs", + "title":"Obtaining Training Jobs", "uri":"modelarts_04_0160.html", "doc_type":"sdkreference", "p_code":"19", "code":"21" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", - "title":"Querying the Details About a Training Job", + "title":"Obtaining Details About a Training Job", "uri":"modelarts_04_0161.html", "doc_type":"sdkreference", "p_code":"19", "code":"22" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", "title":"Modifying the Description of a Training Job", "uri":"modelarts_04_0162.html", @@ -207,7 +207,7 @@ "code":"23" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", "title":"Obtaining the Name of a Training Job Log File", "uri":"modelarts_04_0163.html", @@ -216,9 +216,9 @@ "code":"24" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", - "title":"Querying Training Job Logs", + "title":"Obtaining Training Job Logs", "uri":"modelarts_04_0164.html", "doc_type":"sdkreference", "p_code":"19", @@ -261,16 +261,16 @@ "code":"29" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", - "title":"Querying the Details About a Training Job Version", + "title":"Obtaining Details About a Training Job Version", "uri":"modelarts_04_0170.html", "doc_type":"sdkreference", "p_code":"27", "code":"30" }, { - "desc":"You can stop a training job version that is being created only when the job is running.In the ModelArts notebook instance, you do not need to enter authentication paramet", + "desc":"You can stop a training job version that is being created only when the job is running.In ModelArts notebook, you do not need to enter authentication parameters for sessi", "product_code":"modelarts", "title":"Stopping a Training Job Version", "uri":"modelarts_04_0171.html", @@ -279,7 +279,7 @@ "code":"31" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", "title":"Deleting a Training Job Version", "uri":"modelarts_04_0172.html", @@ -315,25 +315,25 @@ "code":"35" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", - "title":"Querying the List of Training Job Configurations", + "title":"Obtaining Training Job Configurations", "uri":"modelarts_04_0176.html", "doc_type":"sdkreference", "p_code":"33", "code":"36" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", - "title":"Querying the Details About a Training Job Configuration", + "title":"Obtaining Details About a Training Job Configuration", "uri":"modelarts_04_0177.html", "doc_type":"sdkreference", "p_code":"33", "code":"37" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", "title":"Modifying a Training Job Configuration", "uri":"modelarts_04_0178.html", @@ -342,7 +342,7 @@ "code":"38" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", "title":"Deleting a Training Job Configuration", "uri":"modelarts_04_0179.html", @@ -378,25 +378,25 @@ "code":"42" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", - "title":"Querying the List of Visualization Jobs", + "title":"Obtaining Visualization Jobs", "uri":"modelarts_04_0183.html", "doc_type":"sdkreference", "p_code":"40", "code":"43" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", - "title":"Querying the Details About a Visualization Job", + "title":"Obtaining Details About a Visualization Job", "uri":"modelarts_04_0184.html", "doc_type":"sdkreference", "p_code":"40", "code":"44" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", "title":"Modifying the Description of a Visualization Job", "uri":"modelarts_04_0185.html", @@ -405,7 +405,7 @@ "code":"45" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", "title":"Stopping a Visualization Job", "uri":"modelarts_04_0186.html", @@ -414,7 +414,7 @@ "code":"46" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", "title":"Restarting a Visualization Job", "uri":"modelarts_04_0187.html", @@ -423,7 +423,7 @@ "code":"47" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", "title":"Deleting a Visualization Job", "uri":"modelarts_04_0188.html", @@ -441,9 +441,9 @@ "code":"49" }, { - "desc":"In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other devel", + "desc":"In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development enviro", "product_code":"modelarts", - "title":"Querying a Built-in Algorithm", + "title":"Obtaining a Built-in Algorithm", "uri":"modelarts_04_0190.html", "doc_type":"sdkreference", "p_code":"49", diff --git a/docs/modelarts/sdk-ref/modelarts_04_0004.html b/docs/modelarts/sdk-ref/modelarts_04_0004.html index aaf6e9ed..1003b28d 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0004.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0004.html @@ -1,24 +1,10 @@

Downloading and Installing the SDK

-

Download ModelArts SDK

Download the ModelArts SDK software package of the latest version.

+

Downloading the SDK

Download the ModelArts SDK software package of the latest version.

Installing the SDK

After the SDK is downloaded, you can use pip to install it. For details about how to install pip, see the pip official website. To install the ModelArts SDK, run the following command:

pip install modelarts-latest-py2.py3-none-any.whl

-
The required dependency packages are installed by default during SDK installation. The details are as follows:
certifi >= 14.05.14
-six >= 1.10
-python_dateutil >= 2.5.3
-setuptools >= 21.0.0
-urllib3 >= 1.15.1
-requests >= 2.19.1
-esdk-obs-python == 3.0.5
-Flask==1.0.2
-Flask-Cors==3.0.4
-gunicorn==19.8.1
-mxnet-model-server==0.3
-psutil==5.4.6
-prometheus_client==0.3.1
-

If an error message is displayed during the installation, indicating that a required dependency package is missing, run the following command to install the dependency package as prompted. In the command, xxxx indicates the name of the dependency package.

pip install xxxx

diff --git a/docs/modelarts/sdk-ref/modelarts_04_0131.html b/docs/modelarts/sdk-ref/modelarts_04_0131.html index b0ee8a3b..2aec2e29 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0131.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0131.html @@ -1,8 +1,8 @@

Creating a Training Job

-

For training on the training platform, if the training fails, you can view the detailed log information on the platform or by calling the API in Querying Training Job Logs.

-

Sample Code

In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

+

If a training job failed on the training platform, view detailed logs on the platform or by calling the API in Obtaining Training Job Logs.

+

Sample Code

In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

  • Example 1: Create a training job using the data stored on OBS.
     1
  2
  3
@@ -88,7 +88,7 @@
                       train_instance_type='modelarts.vm.cpu.2u',                  # Training environment flavor
                       train_instance_count=1,                                       # Number of training nodes
                       job_description='pytorch-sentiment with ModelArts SDK')       # Training job description
-job_instance = estimator.fit(dataset_id='4AZNvFkN7KYr5EdhFkH', dataset_version_id='UOF9BIeSGArwVt0oI6T', wait=False, job_name='my_training_job')
+job_instance = estimator.fit(dataset_id='your_dataset_id', dataset_version_id='your_dataset_version_id', wait=False, job_name='my_training_job')
    @@ -135,213 +135,213 @@

Parameter Description

-
Table 1 Estimator request parameters

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Estimator request parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

modelarts_session

+

modelarts_session

Yes

+

Yes

Object

+

Object

Session object. For details about the initialization method, see Session Authentication.

+

Session object. For details about the initialization method, see Session Authentication.

train_instance_count

+

train_instance_count

Yes

+

Yes

Long

+

Long

Number of compute nodes in a training job

+

Number of compute nodes in a training job

code_dir

+

code_dir

No

+

No

String

+

String

Code directory of a training job, for example, /bucket/src/. Leave this parameter blank when model_name is set.

+

Code directory of a training job, for example, /bucket/src/. Leave this parameter blank when model_name is set.

boot_file

+

boot_file

No

+

No

String

+

String

Boot file of a training job, which needs to be stored in the code directory. For example, /bucket/src/boot.py. Leave this parameter blank when model_name is set.

+

Boot file of a training job, which needs to be stored in the code directory. For example, /bucket/src/boot.py. Leave this parameter blank when model_name is set.

output_path

+

output_path

Yes

+

Yes

String

+

String

Output path of a training job

+

Output path of a training job

hyperparameters

+

hyperparameters

No

+

No

JSON Array

+

JSON Array

Running parameters of a training job. It is a collection of label-value pairs of the string type. This parameter is a container environment variable when a job uses a custom image.

+

Running parameters of a training job. It is a collection of label-value pairs of the string type. This parameter is a container environment variable when a job uses a custom image. For details about hyperparameters if a built-in algorithm is used, see Algorithms and Their Running Parameters.

log_url

+

log_url

No

+

No

String

+

String

OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: /usr/log/

+

OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: /usr/log/

train_instance_type

+

train_instance_type

Yes

+

Yes

Long

+

Long

Resource flavor selected for a training job. If you choose to train on the training platform, obtain the value by calling the API described in Querying the List of Resource Flavors.

+

Resource flavor selected for a training job. If you choose to train on the training platform, obtain the value by calling the API described in Obtaining Resource Flavors.

framework_type

+

framework_type

No

+

No

String

+

String

Engine selected for a training job. Obtain the value by calling the API described in Querying the List of Engine Types. Leave this parameter blank when model_name is set.

+

Engine selected for a training job. Obtain the value by calling the API described in Obtaining Engine Types. Leave this parameter blank when model_name is set.

framework_version

+

framework_version

No

+

No

String

+

String

Engine version selected for a training job. Obtain the value by calling the API described in Querying the List of Engine Types. Leave this parameter blank when model_name is set.

+

Engine version selected for a training job. Obtain the value by calling the API described in Obtaining Engine Types. Leave this parameter blank when model_name is set.

job_description

+

job_description

No

+

No

String

+

String

Description of a training job

+

Description of a training job

user_image_url

+

user_image_url

No

+

No

String

+

String

SWR URL of the custom image used by a training job. Example value: 100.125.5.235:20202/jobmng/custom-cpu-base:1.0

+

SWR URL of the custom image used by a training job. Example value: 100.125.5.235:20202/jobmng/custom-cpu-base:1.0

user_command

+

user_command

No

+

No

String

+

String

Boot command used to start the container of the custom image of a training job. The format is bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}.

+

Boot command used to start the container of the custom image of a training job. The format is bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}.
-
Table 2 fit request parameters

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - -
Table 2 fit request parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

inputs

+

inputs

Yes

+

Yes

String

+

String

Data storage location of a training job.

+

Data storage location of a training job.

inputs cannot be used with dataset_id and dataset_version_id, or with data_source at the same time. However, one of the parameters must exist.

Only this parameter is supported in local training.

dataset_id

+

dataset_id

No

+

No

String

+

String

Dataset ID of a training job. To obtain the dataset ID, view basic information about the dataset.

+

Dataset ID of a training job. To obtain the dataset ID, view basic information about the dataset.

This parameter must be used together with dataset_version_id, but cannot be used together with inputs.

dataset_version_id

+

dataset_version_id

No

+

No

String

+

String

Dataset version ID of a training job. To obtain the dataset version ID, view basic information about the dataset.

+

Dataset version ID of a training job. To obtain the dataset version ID, view basic information about the dataset.

This parameter must be used together with dataset_id, but cannot be used together with inputs.

wait

+

wait

No

+

No

Boolean

+

Boolean

Whether to wait for the completion of a training job. Default value: False

+

Whether to wait for the completion of a training job. Default value: False

job_name

+

job_name

No

+

No

String

+

String

Name of a training job, consisting of 1 to 64 alphanumeric characters. If this parameter is left blank, a job name is generated randomly.

+

Name of a training job, consisting of 1 to 64 alphanumeric characters. If this parameter is left blank, a job name is generated randomly.
-
Table 3 Parameters in the successful response to training

Parameter

+
- - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0158.html b/docs/modelarts/sdk-ref/modelarts_04_0158.html index eed81b7e..a92b8281 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0158.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0158.html @@ -7,15 +7,15 @@
Table 3 Parameters in the successful response to training

Parameter

Type

+

Type

Description

+

Description

TrainingJob

+

TrainingJob

Object

+

Object

Training object. This object contains attributes such as job_id and version_id, and operations on a training job, such as querying, modifying, or deleting the training job. For example, you can use job_instance.job_id to obtain the ID of a training job.

+

Training object. This object contains attributes such as job_id and version_id, and operations on a training job, such as querying, modifying, or deleting the training job. For example, you can use job_instance.job_id to obtain the ID of a training job.
- -
1
 2
 3
@@ -39,7 +39,7 @@

Integer

Job status to be queried. By default, jobs of all statuses are queried. For example, to view jobs that fail to be created, set this parameter to 3, 5, 6, or 13. For details about the job statuses, see Job Statuses.

+

Job status to be queried. By default, jobs of all statuses are queried. For example, to view jobs that fail to be created, set this parameter to 3, 5, 6, or 13. For details about job statuses, see Job Statuses.

per_page

@@ -76,7 +76,7 @@

String

The options are as follows:

-
  • asc: ascending order
  • desc: descending order. The default value is desc.
+
  • asc: ascending order
  • desc: descending order. The default value is desc.

search_content

@@ -85,77 +85,77 @@

String

Search content, for example, a training job name. The value is a string of 0 to 100 characters. By default, this parameter is left blank.

+

Search content, for example, a training job name. The value must contain 0 to 100 characters. By default, this parameter is left blank.
-
Table 2 get_job_list response parameters

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - -
Table 2 get_job_list response parameters

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message when the API call fails.

+

Error message when the API call fails.

This parameter is not included when the API call succeeds.

error_code

+

error_code

String

+

String

Error code when the API fails to be called. For details, see .

+

Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

This parameter is not included when the API call succeeds.

job_total_count

+

job_total_count

Integer

+

Integer

Total number of created jobs

+

Total number of created jobs

job_count_limit

+

job_count_limit

Integer

+

Integer

Number of training jobs that can be created

+

Number of training jobs that can be created

is_success

+

is_success

Boolean

+

Boolean

Whether the API call succeeds

+

Whether the API call succeeds

quotas

+

quotas

Integer

+

Integer

Maximum number of training jobs

+

Maximum number of training jobs

jobs

+

jobs

JSON Array

+

JSON Array

Attributes of a training job. For details, see Table 3.

+

Attributes of a training job. For details, see Table 3.
-
Table 3 jobs parameters

Parameter

+
@@ -188,7 +188,7 @@ -
Table 3 jobs parameters

Parameter

Type

Byte

Status of a training job. For details about the job statuses, see Job Statuses.

+

Status of a training job. For details about job statuses, see Job Statuses.

create_time

diff --git a/docs/modelarts/sdk-ref/modelarts_04_0161.html b/docs/modelarts/sdk-ref/modelarts_04_0161.html index 42e90f34..22be18ec 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0161.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0161.html @@ -1,7 +1,7 @@ -

Querying the Details About a Training Job

-

Sample Code

In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

+

Obtaining Details About a Training Job

+

Sample Code

In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

  • Method 1: Use the specified job_id and version_id.
    1
 2
 3
@@ -27,542 +27,542 @@

    Parameter Description

    -
    Table 1 Estimator request parameters

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 1 Estimator request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    +

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    job_id

    +

    job_id

    Yes

    +

    Yes

    String

    +

    String

    ID of a training job. You can query job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response obtained in Querying the List of Training Jobs.

    +

    ID of a training job. Obtain job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response in Obtaining Training Jobs.

    version_id

    +

    version_id

    Yes

    +

    Yes

    String

    +

    String

    Version ID of a training job. You can query version_id using the training job object generated in Creating a Training Job, for example, job_instance.version_id, or from the response obtained in Querying the List of Training Jobs.

    +

    Version ID of a training job. Obtain version_id using the training job object generated in Creating a Training Job, for example, job_instance.version_id, or from the response in Obtaining Training Jobs.
    -
    Table 2 get_job_info response parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 2 get_job_info response parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message when the API call fails.

    +

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    error_code

    +

    error_code

    String

    +

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    is_success

    +

    is_success

    Boolean

    +

    Boolean

    Whether the API call succeeds

    +

    Whether the API call succeeds

    job_id

    +

    job_id

    Long

    +

    Long

    Training job ID

    +

    Training job ID

    job_name

    +

    job_name

    String

    +

    String

    Training job name

    +

    Training job name

    job_desc

    +

    job_desc

    String

    +

    String

    Description of a training job

    +

    Description of a training job

    version_id

    +

    version_id

    Long

    +

    Long

    Version ID of a training job

    +

    Version ID of a training job

    version_name

    +

    version_name

    String

    +

    String

    Version name of a training job

    +

    Version name of a training job

    pre_version_id

    +

    pre_version_id

    Long

    +

    Long

    Name of the previous version of a training job

    +

    Name of the previous version of a training job

    engine_type

    +

    engine_type

    Short

    +

    Short

    Engine type of a training job. The mapping between engine_type and engine_name is as follows:

    +

    Engine type of a training job. The mapping between engine_type and engine_name is as follows:

    • engine_type: 1, engine_name: TensorFlow
    • engine_type: 2, engine_name: MXNet
    • engine_type: 3, engine_name: Ray
    • engine_type: 4, engine_name: Caffe
    • engine_type: 5, engine_name: Spark_MLlib
    • engine_type: 9, engine_name: XGBoost-Sklearn
    • engine_type: 10, engine_name: PyTorch
    • engine_type: 12, engine_name: Horovod

    engine_name

    +

    engine_name

    String

    +

    String

    Name of the engine selected for a training job. Currently, the following engines are supported:

    +

    Name of the engine selected for a training job. Currently, the following engines are supported:

    • Caffe
    • Horovod
    • MXNet
    • PyTorch
    • Ray
    • Spark_MLlib
    • TensorFlow
    • XGBoost-Sklearn

    engine_id

    +

    engine_id

    Long

    +

    Long

    ID of the engine selected for a training job

    +

    ID of the engine selected for a training job

    engine_version

    +

    engine_version

    String

    +

    String

    Version of the engine selected for a training job

    +

    Version of the engine selected for a training job

    status

    +

    status

    Integer

    +

    Integer

    Status of a training job. For details about the job statuses, see Job Statuses.

    +

    Status of a training job. For details about job statuses, see Job Statuses.

    app_url

    +

    app_url

    String

    +

    String

    Code directory of a training job

    +

    Code directory of a training job

    boot_file_url

    +

    boot_file_url

    String

    +

    String

    Boot file of a training job

    +

    Boot file of a training job

    create_time

    +

    create_time

    Long

    +

    Long

    Time when a training job is created

    +

    Time when a training job is created

    parameter

    +

    parameter

    JSON Array

    +

    JSON Array

    Running parameters of a training job. It is a collection of label-value pairs. This parameter is a container environment variable when a job uses a custom image.

    +

    Running parameters of a training job. It is a collection of label-value pairs. This parameter is a container environment variable when a job uses a custom image.

    duration

    +

    duration

    Long

    +

    Long

    Training job running duration, in milliseconds

    +

    Training job running duration, in milliseconds

    spec_id

    +

    spec_id

    Long

    +

    Long

    ID of the resource specifications selected for a training job

    +

    ID of the resource specifications selected for a training job

    core

    +

    core

    String

    +

    String

    Number of cores of the resource specifications

    +

    Number of cores of the resource specifications

    cpu

    +

    cpu

    String

    +

    String

    CPU memory of the resource specifications

    +

    CPU memory of the resource specifications

    gpu_num

    +

    gpu_num

    Integer

    +

    Integer

    Number of GPUs of the resource specifications

    +

    Number of GPUs of the resource specifications

    gpu_type

    +

    gpu_type

    String

    +

    String

    GPU type of the resource specifications

    +

    GPU type of the resource specifications

    worker_server_num

    +

    worker_server_num

    Integer

    +

    Integer

    Number of workers in a training job

    +

    Number of workers in a training job

    data_url

    +

    data_url

    String

    +

    String

    Dataset of a training job

    +

    Dataset of a training job

    train_url

    +

    train_url

    String

    +

    String

    OBS path to the training job output file

    +

    OBS path to the training job output file

    dataset_version_id

    +

    dataset_version_id

    String

    +

    String

    Dataset version ID of a training job

    +

    Dataset version ID of a training job

    dataset_id

    +

    dataset_id

    String

    +

    String

    Dataset ID of a training job

    +

    Dataset ID of a training job

    data_source

    +

    data_source

    JSON Array

    +

    JSON Array

    Datasets of a training job

    +

    Datasets of a training job

    model_id

    +

    model_id

    Long

    +

    Long

    Model ID of a training job

    +

    Model ID of a training job

    model_metric_list

    +

    model_metric_list

    JSON Array

    +

    JSON Array

    Model metrics of a training job

    +

    Model metrics of a training job

    system_metric_list

    +

    system_metric_list

    JSON Array

    +

    JSON Array

    System monitoring metrics of a training job

    +

    System monitoring metrics of a training job

    user_image_url

    +

    user_image_url

    String

    +

    String

    SWR URL of the custom image used by a training job

    +

    SWR URL of the custom image used by a training job

    user_command

    +

    user_command

    String

    +

    String

    Boot command used to start the container of the custom image of a training job

    +

    Boot command used to start the container of the custom image of a training job
    -
    Table 3 data_source parameters

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 3 data_source parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    dataset_id

    +

    dataset_id

    String

    +

    String

    Dataset ID of a training job

    +

    Dataset ID of a training job

    dataset_version

    +

    dataset_version

    String

    +

    String

    Dataset version ID of a training job

    +

    Dataset version ID of a training job

    type

    +

    type

    String

    +

    String

    Dataset type

    +

    Dataset type

    obs: Data from OBS is used.

    dataset: Data from a specified dataset is used.

    data_url

    +

    data_url

    String

    +

    String

    OBS bucket path

    +

    OBS bucket path
    -
    Table 4 model_metric_list parameters

    Parameter

    +
    - - - - - -
    Table 4 model_metric_list parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    metric

    JSON Array

    +

    JSON Array

    Validation metrics of a class of a training job

    +

    Validation metrics of a class of a training job

    total_metric

    JSON Array

    +

    JSON Array

    All validation metrics of a training job

    +

    All validation metrics of a training job
    -
    Table 5 system_metric_list parameters

    Parameter

    +
    - - - - - - - -
    Table 5 system_metric_list parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    cpuUsage

    JSON Array

    +

    JSON Array

    CPU usage of a training job

    +

    CPU usage of a training job

    memUsage

    JSON Array

    +

    JSON Array

    Memory usage of a training job

    +

    Memory usage of a training job

    gpuUtil

    JSON Array

    +

    JSON Array

    GPU usage of a training job

    +

    GPU usage of a training job
    -
    Table 6 metric parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 6 metric parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    metric_values

    +

    metric_values

    JSON Array

    +

    JSON Array

    Validation metrics of a class of a training job

    +

    Validation metrics of a class of a training job

    reserved_data

    +

    reserved_data

    JSON Array

    +

    JSON Array

    Reserved parameter

    +

    Reserved parameter

    metric_meta

    +

    metric_meta

    JSON Array

    +

    JSON Array

    A class of a training job, including the class ID and name

    +

    A class of a training job, including the class ID and name
    -
    Table 7 metric_values parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 7 metric_values parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    recall

    +

    recall

    JSON Array

    +

    JSON Array

    Recall of a class of a training job

    +

    Recall of a class of a training job

    precision

    +

    precision

    JSON Array

    +

    JSON Array

    Precision of a class of a training job

    +

    Precision of a class of a training job

    accuracy

    +

    accuracy

    JSON Array

    +

    JSON Array

    Accuracy of a class of a training job

    +

    Accuracy of a class of a training job
    -
    Table 8 total_metric parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 8 total_metric parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    total_metric_meta

    +

    total_metric_meta

    JSON Array

    +

    JSON Array

    Reserved parameter

    +

    Reserved parameter

    total_reserved_data

    +

    total_reserved_data

    JSON Array

    +

    JSON Array

    Reserved parameter

    +

    Reserved parameter

    total_metric_values

    +

    total_metric_values

    JSON Array

    +

    JSON Array

    All validation metrics of a training job

    +

    All validation metrics of a training job
    -
    Table 9 total_metric_values parameters

    Parameter

    +
    - - - - - - - - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0162.html b/docs/modelarts/sdk-ref/modelarts_04_0162.html index d7b4dc3c..1d033015 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0162.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0162.html @@ -1,7 +1,7 @@

    Modifying the Description of a Training Job

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    • Method 1: Modify the description of a training job based on the specified job_id.
    Table 9 total_metric_values parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    f1_score

    +

    f1_score

    Float

    +

    Float

    F1 score of a training job

    +

    F1 score of a training job

    recall

    +

    recall

    Float

    +

    Float

    Total recall of a training job

    +

    Total recall of a training job

    precision

    +

    precision

    Float

    +

    Float

    Total precision of a training job

    +

    Total precision of a training job

    accuracy

    +

    accuracy

    Float

    +

    Float

    Total accuracy of a training job

    +

    Total accuracy of a training job

    		 
    1
 2
 3
@@ -27,90 +27,90 @@

    Parameter Description

    -
    Table 1 Estimator request parameters

    Parameter

    +
    - - - - - - - - -
    Table 1 Estimator request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    +

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    job_id

    +

    job_id

    Yes

    +

    Yes

    String

    +

    String

    ID of a training job. You can query job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response obtained in Querying the List of Training Jobs.

    +

    ID of a training job. Obtain job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response in Obtaining Training Jobs.
    -
    Table 2 update_job_description request parameters

    Parameter

    +
    - - - - - - -
    Table 2 update_job_description request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    description

    +

    description

    Yes

    +

    Yes

    String

    +

    String

    Description of the training job to be modified

    +

    Description of the training job to be modified
    -
    Table 3 update_job_description response parameters

    Parameter

    +
    - - - - - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0163.html b/docs/modelarts/sdk-ref/modelarts_04_0163.html index 3037b6ad..ccefe058 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0163.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0163.html @@ -1,7 +1,7 @@

    Obtaining the Name of a Training Job Log File

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    • Method 1: Obtain the file based on the specified job_id and version_id.
    Table 3 update_job_description response parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message when the API call fails.

    +

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    error_code

    +

    error_code

    String

    +

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    is_success

    +

    is_success

    Boolean

    +

    Boolean

    Whether the API call succeeds

    +

    Whether the API call succeeds

    		 
    1
 2
 3
@@ -27,81 +27,81 @@

    Parameter Description

    -
    Table 1 Estimator request parameters

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 1 Estimator request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    +

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    job_id

    +

    job_id

    Yes

    +

    Yes

    String

    +

    String

    ID of a training job. You can query job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response obtained in Querying the List of Training Jobs.

    +

    ID of a training job. Obtain job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response in Obtaining Training Jobs.

    version_id

    +

    version_id

    Yes

    +

    Yes

    String

    +

    String

    Version ID of a training job. You can query version_id using the training job object generated in Creating a Training Job, for example, job_instance.version_id, or from the response obtained in Querying the List of Training Jobs.

    +

    Version ID of a training job. Obtain version_id using the training job object generated in Creating a Training Job, for example, job_instance.version_id, or from the response in Obtaining Training Jobs.
    -
    Table 2 get_job_log_file_list response parameters

    Parameter

    +
    - - - - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0164.html b/docs/modelarts/sdk-ref/modelarts_04_0164.html index ae27e2c9..5311dec0 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0164.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0164.html @@ -1,7 +1,7 @@ -

    Querying Training Job Logs

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Obtaining Training Job Logs

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    • Method 1: Use the specified job_id and version_id.
    Table 2 get_job_log_file_list response parameters

    Parameter

    Type

    +

    Type

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    error_code

    +

    error_code

    String

    +

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    log_file_list

    +

    log_file_list

    List

    +

    List

    Log file name of a training job. A single-node job has only one log file, and a distributed job has multiple log files.

    is_success

    +

    is_success

    Boolean

    +

    Boolean

    Whether the API call succeeds

    1
 2
 3
@@ -27,138 +27,138 @@

    Parameter Description

    -
    Table 1 Estimator request parameters

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 1 Estimator request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    +

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    job_id

    +

    job_id

    Yes

    +

    Yes

    String

    +

    String

    ID of a training job. You can query job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response obtained in Querying the List of Training Jobs.

    +

    ID of a training job. Obtain job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response in Obtaining Training Jobs.

    version_id

    +

    version_id

    Yes

    +

    Yes

    String

    +

    String

    Version ID of a training job. You can query version_id using the training job object generated in Creating a Training Job, for example, job_instance.version_id, or from the response obtained in Querying the List of Training Jobs.

    +

    Version ID of a training job. Obtain version_id using the training job object generated in Creating a Training Job, for example, job_instance.version_id, or from the response in Obtaining Training Jobs.
    -
    Table 2 get_job_log request parameters

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 2 get_job_log request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    log_file

    +

    log_file

    Yes

    +

    Yes

    String

    +

    String

    Name of a training job log file

    +

    Name of a training job log file

    start_byte

    +

    start_byte

    No

    +

    No

    Long

    +

    Long

    Start position for obtaining the log. The default value is 0. The value range is [-1, +∞]. If the value is -1, the log with the latest offset is obtained.

    +

    Start position for obtaining the log. The default value is 0. The value range is [-1, +∞]. If the value is -1, the log with the latest offset is obtained.

    offset

    +

    offset

    No

    +

    No

    Long

    +

    Long

    Length of the obtained log. The default value is 2048. The value range is [-2048, 2048].

    +

    Length of the obtained log. The default value is 2048. The value range is [-2048, 2048].
    -
    Table 3 get_job_log response parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0166.html b/docs/modelarts/sdk-ref/modelarts_04_0166.html index 22357826..17b27ca0 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0166.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0166.html @@ -45,7 +45,7 @@ - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0167.html b/docs/modelarts/sdk-ref/modelarts_04_0167.html index 11b9e469..0d1ae12b 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0167.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0167.html @@ -9,7 +9,7 @@
  • Querying the List of Training Job Versions
    • -
  • Querying the Details About a Training Job Version
    +
  • Obtaining Details About a Training Job Version
  • Stopping a Training Job Version
    • diff --git a/docs/modelarts/sdk-ref/modelarts_04_0168.html b/docs/modelarts/sdk-ref/modelarts_04_0168.html index 151c58eb..b2bd32bf 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0168.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0168.html @@ -272,7 +272,7 @@ - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0170.html b/docs/modelarts/sdk-ref/modelarts_04_0170.html index 6ffec5c1..99344a66 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0170.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0170.html @@ -1,7 +1,7 @@ -

    Querying the Details About a Training Job Version

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Obtaining Details About a Training Job Version

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    • Method 1: Use the specified job_id.
    Table 3 get_job_log response parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message when the API call fails.

    +

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    error_code

    +

    error_code

    String

    +

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    content

    +

    content

    String

    +

    String

    Content of the requested log

    +

    Content of the requested log

    lines

    +

    lines

    Integer

    +

    Integer

    Number of lines in the log

    +

    Number of lines in the log

    start_line

    +

    start_line

    String

    +

    String

    Start position of the obtained log

    +

    Start position of the obtained log

    end_line

    +

    end_line

    String

    +

    String

    End position of the obtained log

    +

    End position of the obtained log

    String

    ID of a training job. You can query job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response obtained in Querying the List of Training Jobs.

    +

    ID of a training job. You can query job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response obtained in Obtaining Training Jobs.

    String

    ID of a training job. You can query job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response obtained in Querying the List of Training Jobs.

    +

    ID of a training job. You can query job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response obtained in Obtaining Training Jobs.

    pre_version_id

    @@ -281,7 +281,7 @@

    Long

    ID of the previous version of a training job. You can query pre_version_id using the training job object generated in Creating a Training Job, for example, job_instance.version_id, or from the response obtained in Querying the List of Training Jobs.

    +

    ID of the previous version of a training job. You can query pre_version_id using the training job object generated in Creating a Training Job, for example, job_instance.version_id, or from the response obtained in Obtaining Training Jobs.

    inputs

    diff --git a/docs/modelarts/sdk-ref/modelarts_04_0169.html b/docs/modelarts/sdk-ref/modelarts_04_0169.html index 40787690..c2455e29 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0169.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0169.html @@ -41,7 +41,7 @@

    String

    ID of a training job. You can query job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response obtained in Querying the List of Training Jobs.

    +

    ID of a training job. You can query job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response obtained in Obtaining Training Jobs.
    - - @@ -36,18 +36,18 @@ - - - - @@ -74,7 +74,7 @@ - @@ -381,7 +381,7 @@ 
    1
 2
 3
@@ -26,9 +26,9 @@

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    job_id

    Yes

    String

    +

    String

    ID of a training job. You can query job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response obtained in Querying the List of Training Jobs.

    +

    ID of a training job. Obtain job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response in Obtaining Training Jobs.

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.
    -
    Table 5 model_metric_list parameters

    Parameter

    +
    @@ -440,40 +440,40 @@
    Table 5 model_metric_list parameters

    Parameter

    Type

    -
    Table 7 metric parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 7 metric parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    metric_values

    +

    metric_values

    JSON Array

    +

    JSON Array

    Validation metrics of a class of a training job

    +

    Validation metrics of a class of a training job

    reserved_data

    +

    reserved_data

    JSON Array

    +

    JSON Array

    Reserved parameter

    +

    Reserved parameter

    metric_meta

    +

    metric_meta

    JSON Array

    +

    JSON Array

    A class of a training job, including the class ID and name

    +

    A class of a training job, including the class ID and name
    -
    Table 8 metric_values parameters

    Parameter

    +
    @@ -506,7 +506,7 @@
    Table 8 metric_values parameters

    Parameter

    Type

    -
    Table 9 total_metric parameters

    Parameter

    +
    @@ -539,7 +539,7 @@
    Table 9 total_metric parameters

    Parameter

    Type

    -
    Table 10 total_metric_values parameters

    Parameter

    +
    diff --git a/docs/modelarts/sdk-ref/modelarts_04_0171.html b/docs/modelarts/sdk-ref/modelarts_04_0171.html index f0be2dec..33c8a423 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0171.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0171.html @@ -2,7 +2,7 @@

    Stopping a Training Job Version

    You can stop a training job version that is being created only when the job is running.

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    • Method 1: Stop a training job version based on the specified job_id and version_id.
    Table 10 total_metric_values parameters

    Parameter

    Type

    		 
    1
 2
 3
@@ -28,76 +28,76 @@

    Parameter Description

    -
    Table 1 Estimator request parameters

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 1 Estimator request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    +

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    job_id

    +

    job_id

    Yes

    +

    Yes

    String

    +

    String

    ID of a training job. You can query job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response obtained in Querying the List of Training Jobs.

    +

    ID of a training job. Obtain job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response in Obtaining Training Jobs.

    version_id

    +

    version_id

    Yes

    +

    Yes

    String

    +

    String

    Version ID of a training job. You can query version_id from the response obtained in Querying the List of Training Job Versions.

    +

    Version ID of a training job. Obtain version_id from the response in Querying the List of Training Job Versions.
    -
    Table 2 stop_job_version response parameters

    Parameter

    +
    - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0172.html b/docs/modelarts/sdk-ref/modelarts_04_0172.html index 490f380e..f31d1fde 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0172.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0172.html @@ -1,7 +1,7 @@

    Deleting a Training Job Version

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    • Method 1: Delete a training job version based on the specified job_id and version_id.
    Table 2 stop_job_version response parameters

    Parameter

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    Error message when the API call fails.

    +

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    error_code

    +

    error_code

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    is_success

    +

    is_success

    Boolean

    Whether the API call succeeds

    +

    Whether the API call succeeds

    		 
    1
 2
 3
@@ -27,74 +27,74 @@

    Parameter Description

    -
    Table 1 Estimator request parameters

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 1 Estimator request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    +

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    job_id

    +

    job_id

    Yes

    +

    Yes

    String

    +

    String

    ID of a training job. You can query job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response obtained in Querying the List of Training Jobs.

    +

    ID of a training job. Obtain job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response in Obtaining Training Jobs.

    version_id

    +

    version_id

    Yes

    +

    Yes

    String

    +

    String

    Version ID of a training job. You can query version_id from the response obtained in Querying the List of Training Job Versions.

    +

    Version ID of a training job. Obtain version_id from the response in Querying the List of Training Job Versions.
    -
    Table 2 delete_job_version response parameters

    Parameter

    +
    - - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0173.html b/docs/modelarts/sdk-ref/modelarts_04_0173.html index a93c353e..83b6eb60 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0173.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0173.html @@ -8,9 +8,9 @@
  • Querying the List of Training Job Parameter Configuration Objects
    • -
  • Querying the List of Training Job Configurations
    +
  • Obtaining Training Job Configurations
    • -
  • Querying the Details About a Training Job Configuration
    +
  • Obtaining Details About a Training Job Configuration
  • Modifying a Training Job Configuration
    • diff --git a/docs/modelarts/sdk-ref/modelarts_04_0176.html b/docs/modelarts/sdk-ref/modelarts_04_0176.html index d422dac0..dc57f1b6 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0176.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0176.html @@ -1,7 +1,7 @@ -

    Querying the List of Training Job Configurations

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Obtaining Training Job Configurations

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    Table 2 delete_job_version response parameters

    Parameter

    Type

    +

    Type

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    error_code

    +

    error_code

    String

    +

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    is_success

    +

    is_success

    Boolean

    +

    Boolean

    Whether the API call succeeds

    		 
    1
 2
 3
@@ -14,67 +14,67 @@

    Parameter Description

    -
    Table 1 get_job_configs_list request parameters

    Parameter

    +
    - - - - - - - - - - - - - @@ -83,110 +83,110 @@
    Table 1 get_job_configs_list request parameters

    Parameter

    Mandatory

    Type

    +

    Type

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    per_page

    +

    per_page

    No

    Integer

    +

    Integer

    Number of job parameters displayed on each page. The value range is [1, 1000]. Default value: 10

    page

    +

    page

    No

    Integer

    +

    Integer

    Index of the page to be queried. Default value: 1

    sortBy/sort_by

    +

    sortBy/sort_by

    No

    String

    +

    String

    When AK/SK-based authentication is used, the parameter name is sortBy. When account-based authentication is used, the parameter name is sort_by. The parameter specifies the sorting mode of the query. The value can be job_name, job_desc, status, duration, engine_type, or create_time. Default value: job_name

    order

    +

    order

    No

    String

    +

    String

    Sorting order. The options are as follows:

    • asc: ascending order. It is the default value.
    • desc: descending order

    search_content

    +

    search_content

    No

    String

    +

    String

    Search content, for example, a parameter name. By default, this parameter is left blank.

    -
    Table 2 get_job_configs_list response parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 2 get_job_configs_list response parameters

    Parameter

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    Error message when the API call fails.

    +

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    error_code

    +

    error_code

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    config_total_count

    +

    config_total_count

    Integer

    Total number of the queried training job configurations

    +

    Total number of the queried training job configurations

    configs

    +

    configs

    JSON Array

    configs parameters

    +

    configs parameters

    is_success

    +

    is_success

    Boolean

    Whether the API call succeeds

    +

    Whether the API call succeeds
    -
    Table 3 configs parameters

    Parameter

    +
    - - - - - - - - - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0177.html b/docs/modelarts/sdk-ref/modelarts_04_0177.html index a62ea019..d801766a 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0177.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0177.html @@ -1,7 +1,7 @@ -

    Querying the Details About a Training Job Configuration

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Obtaining Details About a Training Job Configuration

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    • Method 1: Use the specified config_name.
    Table 3 configs parameters

    Parameter

    Type

    Description

    +

    Description

    config_name

    +

    config_name

    String

    Name of a training job parameter configuration

    +

    Name of a training job parameter configuration

    config_desc

    +

    config_desc

    String

    Description of a training job parameter configuration

    +

    Description of a training job parameter configuration

    create_time

    +

    create_time

    Long

    Time when a training job is created

    +

    Time when a training job is created

    engine_type

    +

    engine_type

    Short

    Engine type of a training job

    +

    Engine type of a training job

    engine_name

    +

    engine_name

    String

    Name of the engine selected for a training job

    +

    Name of the engine selected for a training job

    engine_id

    +

    engine_id

    Long

    ID of the engine selected for a training job

    +

    ID of the engine selected for a training job

    engine_version

    +

    engine_version

    String

    Version of the engine selected for a training job

    +

    Version of the engine selected for a training job
    - - @@ -41,186 +41,186 @@ - - - -
    1
 2
 3
@@ -31,9 +31,9 @@

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    config_name

    Yes

    String

    +

    String

    Name of a training job parameter configuration

    +

    Name of a training job parameter configuration
    -
    Table 2 get_job_configs_info response parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0178.html b/docs/modelarts/sdk-ref/modelarts_04_0178.html index b01e8e84..9a2f5d62 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0178.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0178.html @@ -1,7 +1,7 @@

    Modifying a Training Job Configuration

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    • Example 1: Modify a training job parameter configuration using the data stored on OBS.
    Table 2 get_job_configs_info response parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message when the API call fails.

    +

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    error_code

    +

    error_code

    String

    +

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    config_name

    +

    config_name

    String

    +

    String

    Name of a training job parameter configuration

    +

    Name of a training job parameter configuration

    config_desc

    +

    config_desc

    String

    +

    String

    Description of a training job parameter configuration

    +

    Description of a training job parameter configuration

    worker_server_num

    +

    worker_server_num

    Integer

    +

    Integer

    Number of workers in a training job

    +

    Number of workers in a training job

    app_url

    +

    app_url

    String

    +

    String

    Code directory of a training job

    +

    Code directory of a training job

    boot_file_url

    +

    boot_file_url

    String

    +

    String

    Boot file of a training job

    +

    Boot file of a training job

    model_id

    +

    model_id

    Long

    +

    Long

    Model ID of a training job

    +

    Model ID of a training job

    parameter

    +

    parameter

    JSON Array

    +

    JSON Array

    Running parameters of a training job. It is a collection of label-value pairs. This parameter is a container environment variable when a job uses a custom image.

    +

    Running parameters of a training job. It is a collection of label-value pairs. This parameter is a container environment variable when a job uses a custom image.

    spec_id

    +

    spec_id

    Long

    +

    Long

    ID of the resource specifications selected for a training job

    +

    ID of the resource specifications selected for a training job

    data_url

    +

    data_url

    String

    +

    String

    Dataset of a training job

    +

    Dataset of a training job

    dataset_id

    +

    dataset_id

    String

    +

    String

    Dataset ID of a training job

    +

    Dataset ID of a training job

    dataset_version_id

    +

    dataset_version_id

    String

    +

    String

    Dataset version ID of a training job

    +

    Dataset version ID of a training job

    engine_type

    +

    engine_type

    Short

    +

    Short

    Engine type of a training job

    +

    Engine type of a training job

    engine_name

    +

    engine_name

    String

    +

    String

    Name of the engine selected for a training job

    +

    Name of the engine selected for a training job

    engine_id

    +

    engine_id

    Long

    +

    Long

    ID of the engine selected for a training job

    +

    ID of the engine selected for a training job

    engine_version

    +

    engine_version

    String

    +

    String

    Version of the engine selected for a training job

    +

    Version of the engine selected for a training job

    train_url

    +

    train_url

    String

    +

    String

    OBS URL of the output file of a training job. By default, this parameter is left blank. Example value: /usr/train/

    +

    OBS URL of the output file of a training job. By default, this parameter is left blank. Example value: /usr/train/

    log_url

    +

    log_url

    String

    +

    String

    OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: /usr/train/

    +

    OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: /usr/train/

    user_image_url

    +

    user_image_url

    String

    +

    String

    SWR URL of the custom image used by a training job

    +

    SWR URL of the custom image used by a training job

    user_command

    +

    user_command

    String

    +

    String

    Boot command used to start the container of the custom image of a training job

    +

    Boot command used to start the container of the custom image of a training job

    is_success

    +

    is_success

    Boolean

    +

    Boolean

    Whether the API call succeeds

    +

    Whether the API call succeeds

    		 
     1
  2
  3
@@ -90,293 +90,293 @@

    Parameter Description

    -
    Table 1 Estimator request parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 1 Estimator request parameters

    Parameter

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    train_instance_count

    +

    train_instance_count

    Yes

    Long

    +

    Long

    Number of workers in a training job

    +

    Number of workers in a training job

    code_dir

    +

    code_dir

    No

    String

    +

    String

    Code directory of a training job, for example, /bucket/src/. Leave this parameter blank when model_name is set.

    +

    Code directory of a training job, for example, /bucket/src/. Leave this parameter blank when model_name is set.

    boot_file

    +

    boot_file

    No

    String

    +

    String

    Boot file of a training job, which needs to be stored in the code directory. For example, /bucket/src/boot.py. Leave this parameter blank when model_name is set.

    +

    Boot file of a training job, which needs to be stored in the code directory. For example, /bucket/src/boot.py. Leave this parameter blank when model_name is set.

    model_name

    +

    model_name

    No

    Long

    +

    Long

    Name of the built-in algorithm used by a training job. If you have configured model_name, you do not need to configure app_url, boot_file_url, framework_type, and framework_version.

    +

    Name of the built-in algorithm used by a training job. If you have configured model_name, you do not need to configure app_url, boot_file_url, framework_type, and framework_version.

    output_path

    +

    output_path

    Yes

    String

    +

    String

    Output path of a training job

    +

    Output path of a training job

    hyperparameters

    +

    hyperparameters

    No

    JSON Array

    +

    JSON Array

    Running parameters of a training job. It is a collection of label-value pairs. This parameter is a container environment variable when a job uses a custom image.

    +

    Running parameters of a training job. It is a collection of label-value pairs. This parameter is a container environment variable when a job uses a custom image.

    log_url

    +

    log_url

    No

    String

    +

    String

    OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: /usr/log/

    +

    OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: /usr/log/

    train_instance_type

    +

    train_instance_type

    Yes

    Long

    +

    Long

    Resource flavor selected for a training job. If you choose to train on the training platform, obtain the value by calling the API described in Querying the List of Resource Flavors.

    +

    Resource flavor selected for a training job. If you choose to train on the training platform, obtain the value by calling the API described in Obtaining Resource Flavors.

    framework_type

    +

    framework_type

    No

    String

    +

    String

    Engine selected for a training job. Obtain the value by calling the API described in Querying the List of Engine Types. Leave this parameter blank when model_name is set.

    +

    Engine selected for a training job. Obtain the value by calling the API described in Obtaining Engine Types. Leave this parameter blank when model_name is set.

    framework_version

    +

    framework_version

    No

    String

    +

    String

    Engine version selected for a training job. Obtain the value by calling the API described in Querying the List of Engine Types. Leave this parameter blank when model_name is set.

    +

    Engine version selected for a training job. Obtain the value by calling the API described in Obtaining Engine Types. Leave this parameter blank when model_name is set.

    job_description

    +

    job_description

    No

    String

    +

    String

    Description of a training job

    +

    Description of a training job

    user_image_url

    +

    user_image_url

    No

    String

    +

    String

    SWR URL of the custom image used by a training job. Example value: 100.125.5.235:20202/jobmng/custom-cpu-base:1.0

    +

    SWR URL of the custom image used by a training job. Example value: 100.125.5.235:20202/jobmng/custom-cpu-base:1.0

    user_command

    +

    user_command

    No

    String

    +

    String

    Boot command used to start the container of the custom image of a training job. The format is bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}.

    +

    Boot command used to start the container of the custom image of a training job. The format is bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}.
    -
    Table 2 update_job_configs request parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - -
    Table 2 update_job_configs request parameters

    Parameter

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    config_name

    +

    config_name

    Yes

    String

    +

    String

    Name of a training job parameter configuration. The value is a string of 1 to 20 characters consisting of only digits, letters, underscores (_), and hyphens (-). By default, if this parameter is left blank, the value is dynamically generated by date.

    +

    Name of a training job parameter configuration. The value must contain 1 to 20 characters consisting of only digits, letters, underscores (_), and hyphens (-). By default, if this parameter is left blank, the value is dynamically generated by date.

    config_desc

    +

    config_desc

    No

    String

    +

    String

    Description of a training job parameter configuration. The value is a string of 0 to 256 characters. By default, this parameter is left blank.

    +

    Description of a training job parameter configuration. The value must contain 0 to 256 characters. By default, this parameter is left blank.

    inputs

    +

    inputs

    No

    String

    +

    String

    OBS storage path of a training job

    +

    OBS storage path of a training job

    dataset_id

    +

    dataset_id

    No

    String

    +

    String

    Dataset ID of a training job. This parameter must be used together with dataset_version_id, but cannot be used together with inputs.

    +

    Dataset ID of a training job. This parameter must be used together with dataset_version_id, but cannot be used together with inputs.

    dataset_version_id

    +

    dataset_version_id

    No

    String

    +

    String

    Dataset version ID of a training job. This parameter must be used together with dataset_id, but cannot be used together with inputs.

    +

    Dataset version ID of a training job. This parameter must be used together with dataset_id, but cannot be used together with inputs.

    data_source

    +

    data_source

    No

    JSON Array

    +

    JSON Array

    Dataset of a training job. This parameter cannot be used together with inputs, dataset_id, or dataset_version_id.

    +

    Dataset of a training job. This parameter cannot be used together with inputs, dataset_id, or dataset_version_id.
    -
    Table 3 data_source parameters

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 3 data_source parameters

    Parameter

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    dataset_id

    +

    dataset_id

    No

    String

    +

    String

    Dataset ID of a training job

    +

    Dataset ID of a training job

    dataset_version

    +

    dataset_version

    No

    String

    +

    String

    Dataset version ID of a training job

    +

    Dataset version ID of a training job

    type

    +

    type

    Yes

    String

    +

    String

    Dataset type. The value can be obs or dataset.

    +

    Dataset type. The value can be obs or dataset.

    data_url

    +

    data_url

    No

    String

    +

    String

    OBS bucket path. This parameter cannot be used together with dataset_id or dataset_version.

    +

    OBS bucket path. This parameter cannot be used together with dataset_id or dataset_version.
    -
    Table 4 update_job_configs response parameters

    Parameter

    +
    - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0179.html b/docs/modelarts/sdk-ref/modelarts_04_0179.html index 17ac3a1c..beb8b08f 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0179.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0179.html @@ -1,7 +1,7 @@

    Deleting a Training Job Configuration

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    • Method 1: Delete a training job parameter configuration based on the specified config_name.
    Table 4 update_job_configs response parameters

    Parameter

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    Error message when the API call fails.

    +

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    error_code

    +

    error_code

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    is_success

    +

    is_success

    Boolean

    Whether the API call succeeds

    +

    Whether the API call succeeds

    		 
    1
 2
 3
@@ -27,67 +27,67 @@

    Parameter Description

    -
    Table 1 Estimator request parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 1 Estimator request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    +

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    config_name

    +

    config_name

    Yes

    +

    Yes

    String

    +

    String

    Name of a training job parameter configuration

    +

    Name of a training job parameter configuration
    -
    Table 2 delete_job_configs response parameters

    Parameter

    +
    - - - - - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0180.html b/docs/modelarts/sdk-ref/modelarts_04_0180.html index 264551e9..4a5d5534 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0180.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0180.html @@ -8,9 +8,9 @@
  • Querying the List of Visualization Job Objects
    • -
  • Querying the List of Visualization Jobs
    +
  • Obtaining Visualization Jobs
    • -
  • Querying the Details About a Visualization Job
    +
  • Obtaining Details About a Visualization Job
  • Modifying the Description of a Visualization Job
    • diff --git a/docs/modelarts/sdk-ref/modelarts_04_0183.html b/docs/modelarts/sdk-ref/modelarts_04_0183.html index e2a41a25..504abf79 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0183.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0183.html @@ -1,7 +1,7 @@ -

    Querying the List of Visualization Jobs

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Obtaining Visualization Jobs

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    Table 2 delete_job_configs response parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message when the API call fails.

    +

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    error_code

    +

    error_code

    String

    +

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    is_success

    +

    is_success

    Boolean

    +

    Boolean

    Whether the API call succeeds

    +

    Whether the API call succeeds

    		 
    1
 2
 3
@@ -14,193 +14,193 @@

    Parameter Description

    -
    Table 1 get_visualization_job_list request parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - -
    Table 1 get_visualization_job_list request parameters

    Parameter

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    status

    +

    status

    No

    String

    +

    String

    Status of a visualization job. For details about the job statuses, see Job Statuses.

    +

    Status of a visualization job. For details about job statuses, see Job Statuses.

    per_page

    +

    per_page

    No

    Integer

    +

    Integer

    Number of jobs displayed on each page. The value range is [1, 100]. Default value: 10

    +

    Number of jobs displayed on each page. The value range is [1, 100]. Default value: 10

    page

    +

    page

    No

    Integer

    +

    Integer

    Index of the page to be queried. Default value: 1

    +

    Index of the page to be queried. Default value: 1

    sortBy/sort_by

    +

    sortBy/sort_by

    No

    String

    +

    String

    When AK/SK-based authentication is used, the parameter name is sortBy. When the username and password are used for authentication, the parameter name is sort_by. The parameter specifies the sorting mode of the query. The value can be job_name, job_desc, status, duration, create_time, or log_dir. Default value: job_name

    +

    When AK/SK-based authentication is used, the parameter name is sortBy. When the username and password are used for authentication, the parameter name is sort_by. The parameter specifies the sorting mode of the query. The value can be job_name, job_desc, status, duration, create_time, or log_dir. Default value: job_name

    order

    +

    order

    No

    String

    +

    String

    Sorting order. The options are as follows:

    +

    Sorting order. The options are as follows:

    • asc: ascending order. It is the default value.
    • desc: descending order

    search_content

    +

    search_content

    No

    String

    +

    String

    Search content, for example, a visualization job name. The value is a string of 0 to 100 characters. By default, this parameter is left blank.

    +

    Search content, for example, a visualization job name. The value must contain 0 to 100 characters. By default, this parameter is left blank.
    -
    Table 2 get_visualization_job_list response parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - -
    Table 2 get_visualization_job_list response parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_code

    +

    error_code

    String

    +

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    error_msg

    +

    error_msg

    String

    +

    String

    Error message when the API call fails.

    +

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    job_total_count

    +

    job_total_count

    Integer

    +

    Integer

    Total number of the queried visualization jobs

    +

    Total number of the queried visualization jobs

    job_count_limit

    +

    job_count_limit

    Integer

    +

    Integer

    Number of visualization jobs that can be created

    +

    Number of visualization jobs that can be created

    jobs

    +

    jobs

    JSON Array

    +

    JSON Array

    Visualization job attributes. For details, see Table 3.

    +

    Visualization job attributes. For details, see Table 3.
    -
    Table 3 jobs parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0184.html b/docs/modelarts/sdk-ref/modelarts_04_0184.html index 30262582..9662212b 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0184.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0184.html @@ -1,7 +1,7 @@ -

    Querying the Details About a Visualization Job

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Obtaining Details About a Visualization Job

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    • Method 1: Use the specified visualization_id.
    Table 3 jobs parameters

    Parameter

    Type

    +

    Type

    Description

    job_id

    +

    job_id

    Integer

    +

    Integer

    ID of a visualization job

    job_name

    +

    job_name

    String

    +

    String

    Name of a visualization job

    status

    +

    status

    Integer

    +

    Integer

    Status of a visualization job. For details about the job statuses, see Job Statuses.

    +

    Status of a visualization job. For details about job statuses, see Job Statuses.

    create_time

    +

    create_time

    Long

    +

    Long

    Time when a visualization job is created

    duration

    +

    duration

    Long

    +

    Long

    Running duration of a visualization job, in milliseconds

    job_desc

    +

    job_desc

    String

    +

    String

    Description of a visualization job

    service_url

    +

    service_url

    String

    +

    String

    Endpoint of a visualization job

    train_url

    +

    train_url

    String

    +

    String

    Path to visualization job logs

    1
 2
 3
@@ -27,130 +27,130 @@

    Parameter Description

    -
    Table 1 VisualizationJob request parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 1 VisualizationJob request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    +

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    visualization_id

    +

    visualization_id

    Yes

    +

    Yes

    String

    +

    String

    ID of a visualization job

    +

    ID of a visualization job
    -
    Table 2 get_visualization_job_info response parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0185.html b/docs/modelarts/sdk-ref/modelarts_04_0185.html index 3b0573e0..c6d2435c 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0185.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0185.html @@ -1,7 +1,7 @@

    Modifying the Description of a Visualization Job

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    • Method 1: Modify the description of a visualization job based on the specified visualization_id.
    Table 2 get_visualization_job_info response parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_code

    +

    error_code

    String

    +

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    error_msg

    +

    error_msg

    String

    +

    String

    Error message when the API call fails.

    +

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    job_name

    +

    job_name

    String

    +

    String

    Name of a visualization job

    +

    Name of a visualization job

    service_url

    +

    service_url

    String

    +

    String

    Endpoint of a visualization job

    +

    Endpoint of a visualization job

    is_success

    +

    is_success

    Boolean

    +

    Boolean

    Whether the API call succeeds

    +

    Whether the API call succeeds

    duration

    +

    duration

    Long

    +

    Long

    Running duration of a visualization job

    +

    Running duration of a visualization job

    create_time

    +

    create_time

    Long

    +

    Long

    Time when a visualization job is created

    +

    Time when a visualization job is created

    train_url

    +

    train_url

    String

    +

    String

    OBS path to the visualization job output file

    +

    OBS path to the visualization job output file

    job_id

    +

    job_id

    Long

    +

    Long

    ID of a visualization job

    +

    ID of a visualization job

    job_desc

    +

    job_desc

    String

    +

    String

    Description of a visualization job

    +

    Description of a visualization job

    resource_id

    +

    resource_id

    String

    +

    String

    Resource ID of a visualization job

    +

    Resource ID of a visualization job

    status

    +

    status

    Integer

    +

    Integer

    Status of a visualization job. For details about the job statuses, see Job Statuses.

    +

    Status of a visualization job. For details about job statuses, see Job Statuses.

    		 
    1
 2
 3
@@ -27,88 +27,88 @@

    Parameter Description

    -
    Table 1 VisualizationJob request parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 1 VisualizationJob request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    +

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    visualization_id

    +

    visualization_id

    Yes

    +

    Yes

    String

    +

    String

    ID of a visualization job

    +

    ID of a visualization job
    -
    Table 2 update_visualization_job request parameters

    Parameter

    +
    - - - - - - -
    Table 2 update_visualization_job request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    job_desc

    +

    job_desc

    Yes

    +

    Yes

    String

    +

    String

    Description of a visualization job. The value is a string of 0 to 256 characters.

    +

    Description of a visualization job. The value must contain 0 to 256 characters.
    -
    Table 3 update_visualization_job response parameters

    Parameter

    +
    - - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0186.html b/docs/modelarts/sdk-ref/modelarts_04_0186.html index ddec1a59..05b4ce8c 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0186.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0186.html @@ -1,7 +1,7 @@

    Stopping a Visualization Job

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    • Method 1: Stop a visualization job based on the specified visualization_id.
    Table 3 update_visualization_job response parameters

    Parameter

    Type

    +

    Type

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    error_code

    +

    error_code

    String

    +

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    is_success

    +

    is_success

    Boolean

    +

    Boolean

    Whether the API call succeeds

    		 
    1
 2
 3
@@ -27,67 +27,67 @@

    Parameter Description

    -
    Table 1 VisualizationJob request parameters

    Parameter

    +
    - - - - -
    Table 1 VisualizationJob request parameters

    Parameter

    Mandatory

    Type

    Description

    +

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    visualization_id

    +

    visualization_id

    Yes

    String

    ID of a visualization job

    +

    ID of a visualization job
    -
    Table 2 stop_visualization_job response parameters

    Parameter

    +
    - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0187.html b/docs/modelarts/sdk-ref/modelarts_04_0187.html index 0434e39f..c66ab8dd 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0187.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0187.html @@ -1,7 +1,7 @@

    Restarting a Visualization Job

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    • Method 1: Restart a visualization job based on the specified visualization_id.
    Table 2 stop_visualization_job response parameters

    Parameter

    Type

    Description

    +

    Description

    error_code

    +

    error_code

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    error_msg

    +

    error_msg

    String

    Error message when the API call fails.

    +

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    is_success

    +

    is_success

    Boolean

    Whether the API call succeeds

    +

    Whether the API call succeeds

    		 
    1
 2
 3
@@ -27,67 +27,67 @@

    Parameter Description

    -
    Table 1 VisualizationJob request parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 1 VisualizationJob request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    +

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    visualization_id

    +

    visualization_id

    Yes

    +

    Yes

    String

    +

    String

    ID of a visualization job

    +

    ID of a visualization job
    -
    Table 2 restart_visualization_job response parameters

    Parameter

    +
    - - - - - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0188.html b/docs/modelarts/sdk-ref/modelarts_04_0188.html index 464581e3..3c8cdbab 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0188.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0188.html @@ -1,7 +1,7 @@

    Deleting a Visualization Job

    -

    Sample Code

    In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    +

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    • Method 1: Delete a visualization job based on the specified visualization_id.
    Table 2 restart_visualization_job response parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_code

    +

    error_code

    String

    +

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    error_msg

    +

    error_msg

    String

    +

    String

    Error message when the API call fails.

    +

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    is_success

    +

    is_success

    Boolean

    +

    Boolean

    Whether the API call succeeds

    +

    Whether the API call succeeds

    		 
    1
 2
 3
@@ -27,67 +27,67 @@

    Parameter Description

    -
    Table 1 VisualizationJob request parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 1 VisualizationJob request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    +

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    visualization_id

    +

    visualization_id

    Yes

    +

    Yes

    String

    +

    String

    ID of a visualization job

    +

    ID of a visualization job
    -
    Table 2 delete_visualization_job response parameters

    Parameter

    +
    - - - - - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0189.html b/docs/modelarts/sdk-ref/modelarts_04_0189.html index 3aae4d1f..b41935ce 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0189.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0189.html @@ -5,7 +5,7 @@
      -
    • Querying a Built-in Algorithm
      +
    • Obtaining a Built-in Algorithm
    • Querying the List of Resource Flavors
      • diff --git a/docs/modelarts/sdk-ref/modelarts_04_0190.html b/docs/modelarts/sdk-ref/modelarts_04_0190.html index 9e660b07..79ca9ca9 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0190.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0190.html @@ -1,7 +1,7 @@ -

      Querying a Built-in Algorithm

      -

      Sample Code

      In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

      +

      Obtaining a Built-in Algorithm

      +

      Sample Code

      In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    Table 2 delete_visualization_job response parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_code

    +

    error_code

    String

    +

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    error_msg

    +

    error_msg

    String

    +

    String

    Error message when the API call fails.

    +

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    is_success

    +

    is_success

    Boolean

    +

    Boolean

    Whether the API call succeeds

    +

    Whether the API call succeeds

    		 
    1
 2
 3
@@ -14,176 +14,176 @@

    Parameter Description

    -
    Table 1 get_built_in_algorithms request parameters

    Parameter

    +
    - - - - - - -
    Table 1 get_built_in_algorithms request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    modelarts_session

    +

    modelarts_session

    Yes

    +

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.
    -
    Table 2 get_built_in_algorithms response parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 2 get_built_in_algorithms response parameters

    Parameter

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    Error message when the API call fails.

    +

    Error message when the API call fails.

    This parameter is not included when the API call succeeds.

    error_code

    +

    error_code

    String

    Error code when the API fails to be called. For details, see .

    +

    Error code when the API fails to be called. For details, see Error Codes in ModelArts API Reference.

    This parameter is not included when the API call succeeds.

    model_total_count

    +

    model_total_count

    Integer

    Number of models

    +

    Number of models

    models

    +

    models

    JSON Array

    Parameter list of a model

    +

    Parameter list of a model

    is_success

    +

    is_success

    Boolean

    Whether the API call succeeds

    +

    Whether the API call succeeds
    -
    Table 3 models parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modelarts/sdk-ref/modelarts_04_0194.html b/docs/modelarts/sdk-ref/modelarts_04_0194.html index da5fd907..09dd9056 100644 --- a/docs/modelarts/sdk-ref/modelarts_04_0194.html +++ b/docs/modelarts/sdk-ref/modelarts_04_0194.html @@ -3,18 +3,29 @@

    Importing a Model

    The model import function covers the following aspects:

    • Initialize the existing model and create a model object based on the model ID.
    • Create a model. For details about the attributes of the created model, see Querying the Details About a Model.
    +

    Sample Model File

    Take a custom PyTorch script as an example. Download model.zip that can be directly deployed, decompress the package, and upload it to OBS. For details about the structure of the PyTorch model package, see Model Package Specifications.

    +
    +
    OBS bucket or directory name
+├── resnet
+│   ├── model (Mandatory) Fixed subdirectory name. The subdirectory is used to store model-related files.
+│   │  ├──<<Custom Python package>> (Optional) Customized Python package, which can be directly referenced in model inference code
+│   │  ├──mnist_mlp.pt (Mandatory) PyTorch model file, which contains variable and weight information and is saved as state_dict
+│   │  ├──config.json (Mandatory) Model configuration file. The file name is fixed to config.json. Only one model configuration file is supported.
+│   │  ├──customize_service.py (Mandatory) Model inference code. The file name is fixed to customize_service.py. Only one model inference file is supported. The files on which customize_service.py depends can be directly stored in the model directory.

    Sample Code

    In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    Table 3 models parameters

    Parameter

    Type

    Description

    +

    Description

    model_id

    +

    model_id

    Integer

    Model ID

    +

    Model ID

    model_name

    +

    model_name

    String

    Model name

    +

    Model name

    model_usage

    +

    model_usage

    Integer

    Model usage. The options are as follows:

    -
    • 1: image classification
    • 2: object class and location
    • 3: image semantic segmentation
    • 4: natural language processing
    +

    Model usage. The options are as follows:

    +
    • 1: image classification
    • 2: object class and location
    • 3: image semantic segmentation
    • 4: natural language processing

    model_precision

    +

    model_precision

    String

    Model precision

    +

    Model precision

    model_size

    +

    model_size

    Long

    Model size, in bytes

    +

    Model size, in bytes

    model_train_dataset

    +

    model_train_dataset

    String

    Model training dataset

    +

    Model training dataset

    model_dataset_format

    +

    model_dataset_format

    String

    Dataset format required by a model

    +

    Dataset format required by a model

    model_description_url

    +

    model_description_url

    String

    URL of the model description

    +

    URL of the model description

    parameter

    +

    parameter

    JSON Array

    Running parameters of a model. It is a collection of label-value pairs. This parameter is a container environment variable when a job uses a custom image. For details, see the sample request.

    +

    Running parameters of a model. It is a collection of label-value pairs. This parameter is a container environment variable when a job uses a custom image. For details, see the sample request.

    create_time

    +

    create_time

    Long

    Time when a model is created

    +

    Time when a model is created

    engine_id

    +

    engine_id

    Long

    Engine ID of a model

    +

    Engine ID of a model

    engine_name

    +

    engine_name

    String

    Engine name of a model

    +

    Engine name of a model

    engine_version

    +

    engine_version

    String

    Engine version of a model

    +

    Engine version of a model

    		 
    1
 2
 3
-4
    from modelarts.session import Session
+4
+5
    from modelarts.session import Session
 from modelarts.model import Model
-from modelarts.config.model_config import ServiceConfig,Params,Dependencies,Packages 
+from modelarts.config.model_config import ServiceConfig, Params, Dependencies, Packages
+
 session = Session()
    -
    • Method 1: Initialize an existing model.
      1
      model_instance = Model(session, model_id="input your model id")
+
      • Method 1: Initialize an existing model.
        1
        model_instance = Model(session, model_id="your_model_id")
 
        
 
 
        
@@ -30,53 +41,37 @@
  9
 10
 11
-12
      model_instance = Model(
-                     session, 
-                     model_name="input model name",              # Model name
-                     model_version="1.0.0",                      # Model version
-                     source_location=model_location,             # OBS path to a model file, for example, obs://your_obs_bucket/mode_file_path
-                     model_type="MXNet",                         # Model type
-                     model_algorithm="image_classification",     # Model algorithm
-                     execution_code="OBS_PATH",                        
-                     input_params=input_params,                  # For details, see the input_params format description.
-                     output_params=output_params,                # For details, see the output_params format description.
-                     dependencies=dependencies,                  # For details, see the dependencies format description.
-                     apis=apis)
+12
+13
      model_location = "/your_obs_bucket/model_path"            # Change to the OBS path to the model file
+execution_code = "/your_obs_bucket/model_path/customize_service.py"
+runtime = "python3.7" 
+
+model_instance = Model(
+                        session,
+                        model_name="input_model_name",    #  (Optional) Model name
+                        model_version="1.0.0",            # (Optional) Model version
+                        source_location=model_location,   # OBS path to the model file, for example, /your_obs_bucket/model_path
+                        model_type="PyTorch",             # Model type
+                        execution_code=execution_code,    # (Optional) OBS path to the execution script, for example, /your_obs_bucket/model_path/customize_service.py
+                        runtime = runtime                 # (Optional) Supported runtime environment
+                       )
      -
      • Definition formats of input_params and output_params parameter groups used in method 2

        The SDK provides the definition of input_params and output_params parameter groups. The types of input_params and output_params are list, and those of the tuple objects in the list are Params.

        -

        The following uses input_params as an example:

        -
        1
-2
-3
-4
-5
-6
-7
-8
-9
        input_params = []                                                # The type of input_params is list. Multiple objects of the Params type can be stored.
-input_params1 = Params( 
-                        url='url',                               # URL
-                        param_name='param_name',                 # Parameter name
-                        param_type='param_type',                 # Parameter type
-                        min='min',                                                     
-                        max='max',                               
-                        param_desc='param_desc')
-input_params.append(input_params1)
-
        - -
        -
      • Definition formats of the dependencies parameter group used in method 2

        The SDK provides the definition of the dependencies parameter group. The type of dependencies is list, and those of the tuple objects in the list are Dependencies.

        +

        dependencies will overwrite the data in config.json in the preceding example. You do not need to use dependencies. The following section describes the dependencies formats.

        +
        +
        • Definition formats of the dependencies parameter group used in method 2

          The SDK provides the definition of the dependencies parameter group. The type of dependencies is list, and those of the tuple objects in the list are Dependencies.

          The code is as follows:

          1
 2
 3
 4
-5
          dependencies = []
-dependency1 = Dependencies( 
-                            installer="pip",                     # Installation mode. pip is supported.
-                            packages=packages)                   # Collection of dependency packages. For details about the definition format, see the definition of packages.
+5
+6
          dependencies = []
+dependency1 = Dependencies(
+        installer="pip",                # Installation mode. pip is supported.
+        packages=packages               # Collection of dependency packages. For details, see packages.
+        )
 dependencies.append(dependency1)
          @@ -88,11 +83,11 @@ 3 4 5 -6
    packages  = []
-package1 =  Packages( 
-                      package_name="package_name",               # Package name
-                      package_version="version",                 # Package version
-                      restraint="restraint")  
+6
    packages = []
+package1 = Packages(
+    package_name="package_name",       # Package name
+    package_version="version",         # Package version
+    restraint="EXACT")                 
 packages.append(package1)
    @@ -100,367 +95,376 @@

    The following is an example of creating a dependencies parameter group:

    dependencies = []
 packages = [{
-            "package_name": "numpy",
-            "package_version": "1.15.0",
-            "restraint": "EXACT"},
-		{
-            "package_name": "h5py",
-            "package_version": "2.8.0",
-            "restraint": "EXACT"}
-          ]
-dependency = Dependencies(installer="pip", packages=packages) 
+    "package_name": "numpy",
+    "package_version": "1.15.0",
+    "restraint": "EXACT"
+    }, {
+        "package_name": "h5py",
+        "package_version": "2.8.0",
+        "restraint": "EXACT"
+    }]
+dependency = Dependencies(installer="pip", packages=packages)
 dependencies.append(dependency)

    Parameter Description

    -
    Table 1 Parameters for initializing a model

    Parameter

    +
    - - - - - - - - - - -
    Table 1 Parameters for initializing a model

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    session

    +

    session

    Yes

    +

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    model_id

    +

    model_id

    Yes

    +

    Yes

    String

    +

    String

    Model ID

    +

    Model ID
    -
    Table 2 Parameters for creating a model

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + +
    Table 2 Parameters for creating a model

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    session

    +

    session

    Yes

    +

    Yes

    Object

    +

    Object

    Session object. For details about the initialization method, see Session Authentication.

    +

    Session object. For details about the initialization method, see Session Authentication.

    model_name

    +

    model_name

    No

    +

    No

    String

    +

    String

    Name of a model, which contains 1 to 64 characters that consist of only letters, digits, underscores (_), and hyphens (-). It must start with a letter. If this parameter is not specified, the system automatically generates a model name.

    +

    Name of a model, which contains 1 to 64 characters that consist of only letters, digits, underscores (_), and hyphens (-). It must start with a letter. If this parameter is not specified, the system automatically generates a model name.

    model_version

    +

    model_version

    Yes

    +

    Yes

    String

    +

    String

    Model version in the format of Digit.Digit.Digit. The value range of the digits is [0, 99]. The version number cannot start with 0, for example, 01.01.01.

    +

    Model version in the format of Digit.Digit.Digit. The value range of the digits is [0, 99]. The version number cannot start with 0, for example, 01.01.01.

    publish

    +

    publish

    No

    +

    No

    Bool

    +

    Bool

    Whether to publish a model. The options are as follows:

    +

    Whether to publish a model. The options are as follows:

    • True: Publish the model. (Default value)
    • False: Do not publish the model.

    source_location_type

    +

    source_location_type

    No

    +

    No

    String

    +

    String

    Model location type. The options are as follows:

    +

    Model location type. The options are as follows:

    • OBS_SOURCE: OBS path. (Default value)
    • LOCAL_SOURCE: local path.

    source_location

    +

    source_location

    Yes

    +

    Yes

    String

    +

    String

    Path (parent directory) of the model file

    +

    Path (parent directory) of the model file

    • If source_location_type is set to OBS_SOURCE, the model file path is an OBS path in the format of /obs_bucketname/.../model_file_parent_dir/.
    • If source_location_type is set to LOCAL_SOURCE, the model file path is a local path in the format of /local_path/.../model_file_parent_dir/.

    environment

    +

    environment

    No

    +

    No

    Environment instance

    +

    Environment instance

    Environment required for normal model running, such as the Python or TensorFlow version

    +

    Environment required for normal model running, such as the Python or TensorFlow version

    source_job_id

    +

    source_job_id

    No

    +

    No

    String

    +

    String

    ID of the source training job. If the model is generated from a training job, specify this parameter for source tracing. If the model is imported from a third-party meta model, leave this parameter blank. By default, this parameter is left blank.

    +

    ID of the source training job. If the model is generated from a training job, specify this parameter for source tracing. If the model is imported from a third-party meta model, leave this parameter blank. By default, this parameter is left blank.

    source_job_version

    +

    source_job_version

    No

    +

    No

    String

    +

    String

    Version of the source training job. If the model is generated from a training job, specify this parameter for source tracing. If the model is imported from a third-party meta model, leave this parameter blank. By default, this parameter is left blank.

    +

    Version of the source training job. If the model is generated from a training job, specify this parameter for source tracing. If the model is imported from a third-party meta model, leave this parameter blank. By default, this parameter is left blank.

    source_type

    +

    source_type

    No

    +

    No

    String

    +

    String

    Model source type. Currently, the value can only be auto, which indicates an ExeML model (model download is not allowed). If the model is deployed by a training job, leave this parameter blank. By default, this parameter is left blank.

    +

    Model source type. Currently, the value can only be auto, which indicates an ExeML model (model download is not allowed). If the model is deployed by a training job, leave this parameter blank. By default, this parameter is left blank.

    model_type

    +

    model_type

    Yes

    +

    Yes

    String

    +

    String

    Model type. The value can be TensorFlow, MXNet, Spark_MLlib, Scikit_Learn, XGBoost, MindSpore, Image, or PyTorch.

    +

    Model type. The value can be TensorFlow, MXNet, Spark_MLlib, Scikit_Learn, XGBoost, MindSpore, Image, or PyTorch.

    model_algorithm

    +

    model_algorithm

    No

    +

    No

    String

    +

    String

    Model algorithm. If the algorithm has been configured in the model configuration file, this parameter can be left blank. For example, predict_analysis, object_detection, or image_classification.

    +

    Model algorithm. If the algorithm has been configured in the model configuration file, this parameter can be left blank. For example, predict_analysis, object_detection, or image_classification.

    description

    +

    description

    No

    +

    No

    String

    +

    String

    Model description, which contains a maximum of 100 characters and cannot contain the following special characters: !<>=&'"

    +

    Model description, which contains a maximum of 100 characters and cannot contain the following special characters: !<>=&'"

    execution_code

    +

    execution_code

    No

    +

    No

    String

    +

    String

    OBS path to the execution script. The inference script must be stored in the model directory in the path where the model is located. For details, see the source_location parameter. The script name is fixed to customize_service.py.

    +

    OBS path to the script to be executed. If customize_service.py is not output by the model, configure this parameter to specify the path. The inference script must be stored in the model directory in the path where the model is located. For details, see the source_location parameter. The script name is fixed to customize_service.py.

    input_params

    +

    runtime

    No

    +

    No

    params array

    +

    String

    List of input parameters for model inference. By default, this parameter is left blank. If the apis information has been configured in the model configuration file, you do not need to set this parameter. The backend automatically reads the input parameters from the apis field in the configuration file.

    +

    Supported runtime environment. This parameter is mandatory if model_type is used. The runtime parameter varies depending on engines. For details, see Supported AI engines and their runtime.

    output_params

    +

    input_params

    No

    +

    No

    params array

    +

    params array

    List of output parameters for model inference. By default, this parameter is left blank. If the apis information has been configured in the model configuration file, you do not need to set this parameter. The backend automatically reads the output parameters from the apis field in the configuration file.

    +

    List of input parameters for model inference. By default, this parameter is left blank. If the apis information has been configured in the model configuration file, you do not need to set this parameter. The backend automatically reads the input parameters from the apis field in the configuration file.

    dependencies

    +

    output_params

    No

    +

    No

    dependency array

    +

    params array

    Dependency package required for running the code and model. By default, this parameter is left blank. If the dependencies information has been configured in the model configuration file, you do not need to set this parameter. The backend automatically reads the dependencies to be installed from the dependencies field in the configuration file.

    +

    List of output parameters for model inference. By default, this parameter is left blank. If the apis information has been configured in the model configuration file, you do not need to set this parameter. The backend automatically reads the output parameters from the apis field in the configuration file.

    apis

    +

    dependencies

    No

    +

    No

    String

    +

    dependency array

    List of inference APIs provided by a model. By default, this parameter is left blank. If the apis information has been configured in the model configuration file, you do not need to set this parameter. The backend automatically reads the configured inference API information from the apis field in the configuration file.

    +

    Dependency package required for running the code and model. By default, this parameter is left blank. If the dependencies information has been configured in the model configuration file, you do not need to set this parameter. The backend automatically reads the dependencies to be installed from the dependencies field in the configuration file.

    +

    apis

    +

    No

    +

    String

    +

    List of inference APIs provided by a model. By default, this parameter is left blank. If the apis information has been configured in the model configuration file, you do not need to set this parameter. The backend automatically reads the configured inference API information from the apis field in the configuration file.
    -
    Table 3 params parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 3 params parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    url

    +

    url

    Yes

    +

    Yes

    String

    +

    String

    Request path of a model inference API

    +

    Request path of a model inference API

    param_name

    +

    param_name

    Yes

    +

    Yes

    String

    +

    String

    Parameter name, which contains a maximum of 64 characters

    +

    Parameter name, which contains a maximum of 64 characters

    param_type

    +

    param_type

    Yes

    +

    Yes

    String

    +

    String

    Basic parameter types of JSON schema, including string, object, array, boolean, number, and integer

    +

    Basic parameter types of JSON schema, including string, object, array, boolean, number, and integer

    min

    +

    min

    No

    +

    No

    Double

    +

    Double

    This parameter is optional when param_type is set to int or float. By default, this parameter is left blank.

    +

    This parameter is optional when param_type is set to int or float. By default, this parameter is left blank.

    max

    +

    max

    No

    +

    No

    Double

    +

    Double

    This parameter is optional when param_type is set to int or float. By default, this parameter is left blank.

    +

    This parameter is optional when param_type is set to int or float. By default, this parameter is left blank.

    param_desc

    +

    param_desc

    No

    +

    No

    String

    +

    String

    Parameter description, which contains a maximum of 100 characters. By default, this parameter is left blank.

    +

    Parameter description, which contains a maximum of 100 characters. By default, this parameter is left blank.
    -
    Table 4 dependency parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 4 dependency parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    installer

    +

    installer

    Yes

    +

    Yes

    String

    +

    String

    Installation mode. Only pip is supported.

    +

    Installation mode. Only pip is supported.

    packages

    +

    packages

    Yes

    +

    Yes

    package array

    +

    package array

    Collection of dependency packages

    +

    Collection of dependency packages
    -
    Table 5 package parameters

    Parameter

    +
    - - - - - - - - - - - - - - - @@ -468,45 +472,49 @@ dependencies.append(dependency)
    Table 5 package parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    package_name

    +

    package_name

    Yes

    +

    Yes

    String

    +

    String

    Name of a dependency package

    +

    Name of a dependency package

    package_version

    +

    package_version

    No

    +

    No

    String

    +

    String

    Version of a dependency package

    +

    Version of a dependency package

    restraint

    +

    restraint

    No

    +

    No

    String

    +

    String

    Version filtering condition. This parameter is mandatory only when package_version exists. Possible values are as follows:

    +

    Version filtering condition. This parameter is mandatory only when package_version exists. Possible values are as follows:

    • EXACT: the specified version
    • ATLEAST: not earlier than the specified version
    • ATMOST: not later than the specified version
    -
    Table 6 create_model response parameters

    Parameter

    +
    - - - - - - -
    Table 6 create_model response parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    model_instance

    +

    model_instance

    Yes

    +

    Yes

    Model object

    +

    Model object

    Model object, which can be any of the APIs described in this chapter

    +

    Model object, which can be any of the APIs described in this chapter
    -
    Example of creating a model in a handwritten digit recognition project using MXNet:
    1
-2
-3
-4
-5
-6
-7
-8
-9
    from modelarts.session import Session
+
     
    Example of creating a model in a handwritten digit recognition project using MXNet:
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
    from modelarts.session import Session
 from modelarts.model import Model
+
 session = Session()
 model_instance = Model(session,
-                       model_name = "digit recognition",
-                       model_version = "1.0.0",
-                       source_location = model_location,
-                       model_type      = "MXNet",
-                       model_algorithm = "image_classification")
+                       model_name="digit_recognition",
+                       model_version="1.0.0",
+                       source_location=model_location,
+                       model_type="MXNet",
+                       model_algorithm="image_classification"
+                       )
 
    
 
 
    
diff --git a/docs/modelarts/sdk-ref/modelarts_04_0195.html b/docs/modelarts/sdk-ref/modelarts_04_0195.html
index 10a4d230..fa3e4629 100644
--- a/docs/modelarts/sdk-ref/modelarts_04_0195.html
+++ b/docs/modelarts/sdk-ref/modelarts_04_0195.html
@@ -6,8 +6,10 @@
 
    1
 2
 3
-4
    from modelarts.session import Session 
+4
+5
    from modelarts.session import Session 
 from modelarts.model import Model
+
 session = Session() 
 model_list = Model.get_model_list(session)
 
    
@@ -17,8 +19,10 @@
 
    1
 2
 3
-4
    from modelarts.session import Session 
+4
+5
    from modelarts.session import Session 
 from modelarts.model import Model
+
 session = Session() 
 model_list = Model.get_model_list(session, model_status="published", model_name="digit", order="desc")
 
    
@@ -26,93 +30,93 @@
 
    
 
    
 
    Parameter Description
    
-
    Table 1 Query parameters
    Parameter
    
+
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -121,33 +125,33 @@
 
    Table 1 Query parameters
    Parameter
    
 
    Mandatory
    
+
    Mandatory
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
     		
 
    
 
    model_name
    
+
    model_name
    
 
    No
    
+
    No
    
 
    String
    
+
    String
    
     		
 
    Model name. Fuzzy match is supported.
    
     		
 
    model_version
    
+
    model_version
    
 
    No
    
+
    No
    
 
    String
    
+
    String
    
     		
 
    Model version
    
     		
 
    model_status
    
+
    model_status
    
 
    No
    
+
    No
    
 
    String
    
+
    String
    
 
    Model status. The value can be publishing, published, or failed. You can query jobs based on their statuses.
    
+
    Model status. The value can be publishing, published, or failed. Obtain jobs based on their statuses.
    
     		
 
    description
    
+
    description
    
 
    No
    
+
    No
    
 
    String
    
+
    String
    
     		
 
    Description. Fuzzy match is supported.
    
     		
 
    offset
    
+
    offset
    
 
    No
    
+
    No
    
 
    Integer
    
+
    Integer
    
     		
 
    Index of the page to be queried. Default value: 0
    
     		
 
    limit
    
+
    limit
    
 
    No
    
+
    No
    
 
    Integer
    
+
    Integer
    
     		
 
    Maximum number of records returned on each page. Default value: 280
    
     		
 
    sort_by
    
+
    sort_by
    
 
    No
    
+
    No
    
 
    String
    
+
    String
    
     		
 
    Sorting mode. The value can be create_at, model_version, or model_size. Default value: create_at
    
     		
 
    order
    
+
    order
    
 
    No
    
+
    No
    
 
    String
    
+
    String
    
     		
 
    Sorting order. The value can be asc or desc, indicating the ascending or descending order. Default value: desc
    
     		
 
    workspace_id
    
+
    workspace_id
    
 
    No
    
+
    No
    
 
    String
    
+
    String
    
     		
 
    Workspace ID. Default value: 0
    
 
    
 
    
 
-
    Table 2 get_model_list parameters
    Parameter
    
+
    
-
-
-
-
-
-
-
-
-
-
-
@@ -155,89 +159,89 @@
 
 
-
    Table 2 get_model_list parameters
    Parameter
    
 
    Type
    
+
    Type
    
 
    Description
    
+
    Description
    
     		
 
    
 
    total_count
    
+
    total_count
    
 
    Integer
    
+
    Integer
    
 
    Total number of models that meet the search criteria when no paging is implemented
    
+
    Total number of models that meet the search criteria when no paging is implemented
    
     		
 
    count
    
+
    count
    
 
    Integer
    
+
    Integer
    
 
    Number of models
    
+
    Number of models
    
     		
 
    models
    
+
    models
    
 
    model array
    
+
    model array
    
 
    Model metadata
    
+
    Model metadata
    
     		
 
    
     
 
    Table 3 model parameters
    Parameter
    
+
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/modelarts/sdk-ref/modelarts_04_0196.html b/docs/modelarts/sdk-ref/modelarts_04_0196.html
index 9faeb93d..aeff2ab6 100644
--- a/docs/modelarts/sdk-ref/modelarts_04_0196.html
+++ b/docs/modelarts/sdk-ref/modelarts_04_0196.html
@@ -5,8 +5,10 @@
 
    • Scenario 1: Obtain all model objects of a user.
    Table 3 model parameters
    Parameter
    
 
    Type
    
+
    Type
    
 
    Description
    
+
    Description
    
     		
 
    
 
    model_id
    
+
    model_id
    
 
    String
    
+
    String
    
 
    Model ID
    
+
    Model ID
    
     		
 
    model_name
    
+
    model_name
    
 
    String
    
+
    String
    
 
    Model name
    
+
    Model name
    
     		
 
    model_version
    
+
    model_version
    
 
    String
    
+
    String
    
 
    Model version
    
+
    Model version
    
     		
 
    model_type
    
+
    model_type
    
 
    String
    
+
    String
    
 
    Model type. The value can be TensorFlow, MXNet, Spark_MLlib, Scikit_Learn, XGBoost, MindSpore, Image, or PyTorch.
    
+
    Model type. The value can be TensorFlow, MXNet, Spark_MLlib, Scikit_Learn, XGBoost, MindSpore, Image, or PyTorch.
    
     		
 
    model_size
    
+
    model_size
    
 
    Long
    
+
    Long
    
 
    Model size, in bytes
    
+
    Model size, in bytes
    
     		
 
    tenant
    
+
    tenant
    
 
    String
    
+
    String
    
 
    Tenant to whom a model belongs
    
+
    Tenant to whom a model belongs
    
     		
 
    project
    
+
    project
    
 
    String
    
+
    String
    
 
    Project to which a model belongs
    
+
    Project to which a model belongs
    
     		
 
    owner
    
+
    owner
    
 
    String
    
+
    String
    
 
    User to whom a model belongs
    
+
    User to whom a model belongs
    
     		
 
    create_at
    
+
    create_at
    
 
    Long
    
+
    Long
    
 
    Time when a model is created, in milliseconds calculated from 1970.1.1 0:0:0 UTC
    
+
    Time when a model is created, in milliseconds calculated from 1970.1.1 0:0:0 UTC
    
     		
 
    description
    
+
    description
    
 
    String
    
+
    String
    
 
    Model description
    
+
    Model description
    
     		
 
    source_type
    
+
    source_type
    
 
    String
    
+
    String
    
 
    Model source type. This parameter is valid only when the model is deployed by an ExeML project. The value is auto.
    
+
    Model source type. This parameter is valid only when the model is deployed by an ExeML project. The value is auto.
    
     		
 
    
 
    1
 2
 3
-4
    from modelarts.session import Session
+4
+5
    from modelarts.session import Session
 from modelarts.model import Model
+
 session = Session()
 model_object_list = Model.get_model_object_list(session)
 
    
@@ -16,8 +18,10 @@
 
    • Scenario 2: Obtain a model object based on the search criteria.
      1
 2
 3
-4
      from modelarts.session import Session
+4
+5
      from modelarts.session import Session
 from modelarts.model import Model
+
 session = Session()
 model_object_list = Model.get_model_object_list(session, model_status="published", model_name="digit", order="desc")
 
      
@@ -27,128 +31,128 @@
 
      
 
      Parameters
      • After you obtain a model list, the size of the list is equal to the number of models that have been deployed by the current user. Each element in the list is a model object. The object attributes are the same as those in Querying the Details About a Model. For example, in model_list = [model_instance1, model_instance2, model_instance3 ...], each model_instance in the list is a model API that can be called.
      • The model list can be obtained based on the query parameters. Table 1 describes the query parameters.
      • When you obtain a model list, details about the models are returned. See Table 2 and Table 3.
      • A maximum of 150 model objects can be obtained.
      
 
-
      Table 1 Query parameters
      Parameter
      
+
      
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
      Table 1 Query parameters
      Parameter
      
 
      Mandatory
      
+
      Mandatory
      
 
      Type
      
+
      Type
      
 
      Description
      
+
      Description
      
       		
 
      
 
      model_name
      
+
      model_name
      
 
      No
      
+
      No
      
 
      String
      
+
      String
      
 
      Model name. Fuzzy match is supported.
      
+
      Model name. Fuzzy match is supported.
      
       		
 
      model_version
      
+
      model_version
      
 
      No
      
+
      No
      
 
      String
      
+
      String
      
 
      Model version
      
+
      Model version
      
       		
 
      model_status
      
+
      model_status
      
 
      No
      
+
      No
      
 
      String
      
+
      String
      
 
      Model status. The value can be publishing, published, or failed. You can obtain models based on their statuses.
      
+
      Model status. The value can be publishing, published, or failed. You can obtain models based on their statuses.
      
       		
 
      description
      
+
      description
      
 
      No
      
+
      No
      
 
      String
      
+
      String
      
 
      Description. Fuzzy match is supported.
      
+
      Description. Fuzzy match is supported.
      
       		
 
      offset
      
+
      offset
      
 
      No
      
+
      No
      
 
      Integer
      
+
      Integer
      
 
      Index of the page to be obtained. Default value: 0
      
+
      Index of the page to be obtained. Default value: 0
      
       		
 
      limit
      
+
      limit
      
 
      No
      
+
      No
      
 
      Integer
      
+
      Integer
      
 
      Maximum number of records returned on each page. Default value: 280
      
+
      Maximum number of records returned on each page. Default value: 280
      
       		
 
      sort_by
      
+
      sort_by
      
 
      No
      
+
      No
      
 
      String
      
+
      String
      
 
      Sorting mode. The value can be create_at, model_version, or model_size. Default value: create_at
      
+
      Sorting mode. The value can be create_at, model_version, or model_size. Default value: create_at
      
       		
 
      order
      
+
      order
      
 
      No
      
+
      No
      
 
      String
      
+
      String
      
 
      Sorting order. The value can be asc or desc, indicating the ascending or descending order. Default value: desc
      
+
      Sorting order. The value can be asc or desc, indicating the ascending or descending order. Default value: desc
      
       		
 
      workspace_id
      
+
      workspace_id
      
 
      No
      
+
      No
      
 
      String
      
+
      String
      
 
      Workspace ID. Default value: 0
      
+
      Workspace ID. Default value: 0
      
       		
 
      
       
 
      
 
      
 
-
      Table 2 get_model_list parameters
      Parameter
      
+
      
-
-
-
-
-
-
-
-
-
-
-
@@ -156,89 +160,89 @@
 
 
-
      Table 2 get_model_list parameters
      Parameter
      
 
      Type
      
+
      Type
      
 
      Description
      
+
      Description
      
       		
 
      
 
      total_count
      
+
      total_count
      
 
      Integer
      
+
      Integer
      
 
      Total number of models that meet the search criteria when no paging is implemented
      
+
      Total number of models that meet the search criteria when no paging is implemented
      
       		
 
      count
      
+
      count
      
 
      Integer
      
+
      Integer
      
 
      Number of models
      
+
      Number of models
      
       		
 
      models
      
+
      models
      
 
      model array
      
+
      model array
      
 
      Model metadata
      
+
      Model metadata
      
       		
 
      
       
 
      Table 3 model parameters
      Parameter
      
+
      
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/modelarts/sdk-ref/modelarts_04_0201.html b/docs/modelarts/sdk-ref/modelarts_04_0201.html
index c2edfcc0..df941346 100644
--- a/docs/modelarts/sdk-ref/modelarts_04_0201.html
+++ b/docs/modelarts/sdk-ref/modelarts_04_0201.html
@@ -8,10 +8,12 @@
 
      • Method 1: Initialize the predictor that has been deployed as a real-time service.
      Table 3 model parameters
      Parameter
      
 
      Type
      
+
      Type
      
 
      Description
      
+
      Description
      
       		
 
      
 
      model_id
      
+
      model_id
      
 
      String
      
+
      String
      
 
      Model ID
      
+
      Model ID
      
       		
 
      model_name
      
+
      model_name
      
 
      String
      
+
      String
      
 
      Model name
      
+
      Model name
      
       		
 
      model_version
      
+
      model_version
      
 
      String
      
+
      String
      
 
      Model version
      
+
      Model version
      
       		
 
      model_type
      
+
      model_type
      
 
      String
      
+
      String
      
 
      Model type. The value can be TensorFlow, MXNet, Spark_MLlib, Scikit_Learn, XGBoost, MindSpore, Image, or PyTorch.
      
+
      Model type. The value can be TensorFlow, MXNet, Spark_MLlib, Scikit_Learn, XGBoost, MindSpore, Image, or PyTorch.
      
       		
 
      model_size
      
+
      model_size
      
 
      Long
      
+
      Long
      
 
      Model size, in bytes
      
+
      Model size, in bytes
      
       		
 
      tenant
      
+
      tenant
      
 
      String
      
+
      String
      
 
      Tenant to whom a model belongs
      
+
      Tenant to whom a model belongs
      
       		
 
      project
      
+
      project
      
 
      String
      
+
      String
      
 
      Project to which a model belongs
      
+
      Project to which a model belongs
      
       		
 
      owner
      
+
      owner
      
 
      String
      
+
      String
      
 
      User to which a model belongs
      
+
      User to which a model belongs
      
       		
 
      create_at
      
+
      create_at
      
 
      Long
      
+
      Long
      
 
      Time when a model is created, in milliseconds calculated from 1970.1.1 0:0:0 UTC
      
+
      Time when a model is created, in milliseconds calculated from 1970.1.1 0:0:0 UTC
      
       		
 
      description
      
+
      description
      
 
      String
      
+
      String
      
 
      Model description
      
+
      Model description
      
       		
 
      source_type
      
+
      source_type
      
 
      String
      
+
      String
      
 
      Model source type. This parameter is valid only when the model is deployed by an ExeML project. The value is auto.
      
+
      Model source type. This parameter is valid only when the model is deployed by an ExeML project. The value is auto.
      
       		
 
      
 
      1
 2
 3
-4
      from modelarts.session import Session
+4
+5
      from modelarts.session import Session
 from modelarts.model import Predictor
+
 session = Session()
-predictor_instance = Predictor(session, service_id="input your service_id")
+predictor_instance = Predictor(session, service_id="your_service_id")
 
      
 
 
@@ -27,42 +29,44 @@
  9
 10
 11
-12
      from modelarts.session import Session
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
      from modelarts.session import Session
 from modelarts.model import Model
-from modelarts.config.model_config import ServiceConfig,TransformerConfig 
+from modelarts.config.model_config import ServiceConfig, TransformerConfig, Schedule
+
 session = Session()
-model_instance = Model(session, model_id="input your model_id")
-predictor_instance = model_instance.deploy_predictor( 
-                                             service_name="input service predictor name",
-                                             infer_type="real-time",
-                                             vpc_id="vpc_id",
-                                             subnet_network_id="subnet_network_id ",
-                                             security_group_id="security_group_id",
-                                             configs=configs)                # predictor configuration parameters. For details, see the format description of the configs parameter.
+model_instance = Model(session, model_id='your_model_id')
+vpc_id = None                                        # (Optional) ID of the VPC where the real-time service instance is deployed. This parameter is left blank by default.
+subnet_network_id = None                             # (Optional) Subnet ID. This parameter is left blank by default.
+security_group_id = None                             # (Optional) Security group. This parameter is left blank by default.
+configs = [ServiceConfig(model_id=model_instance.model_id,
+                         weight="100",
+                         instance_count=1,
+                         specification="modelarts.vm.cpu.2u")]  # For details, see specification.
+predictor_instance = model_instance.deploy_predictor(
+            service_name="service_predictor_name",
+            infer_type="real-time",
+            vpc_id=vpc_id,
+            subnet_network_id=subnet_network_id,
+            security_group_id=security_group_id,
+            configs=configs                          # predictor configuration parameter. For details, see configs.
+            schedule = [Schedule(op_type='stop', time_unit='HOURS', duration=1)]       # (Optional) Specify the runtime duration for a real-time service.
+)
 
      
 
 
 
      The model_id parameter specifies the model to be deployed as a real-time service. You can obtain the value by calling the API described in Obtaining the Model List or from the ModelArts management console.
      
 
-
      • Method 3: Deploy a batch service transformer.
        1
-2
-3
-4
-5
-6
-7
        transformer = model_instance.deploy_transformer( 
-                                                 service_name="input service transformer name",
-                                                 infer_type="batch",
-                                                 vpc_id="vpc_id",
-                                                 subnet_network_id="subnet_network_id ",
-                                                 security_group_id="security_group_id",
-                                                 configs=configs)            # transformer configuration parameter. For details, see the format description of the configs parameter.
-
        
-
-
        
-
      
-
      • Definition formats of the configs parameter group used for deploying a real-time service predictor and a batch service transformer
        • Deploying a real-time service predictor:
          The SDK provides the definition of the configs parameter. The type of configs is list, and those of the tuple objects in the list are ServiceConfig. The code is as follows:
          
-
           1
+
          • Method 3: Deploy a batch service transformer.
             1
  2
  3
  4
@@ -74,24 +78,41 @@
 10
 11
 12
-13
-14
            configs = []
-service_config1 = ServiceConfig( 
-                                 model_id="model_id1",
-                                 weight="70",
-                                 specification="specification",
-                                 instance_count=2,
-                                 envs=envs)         # Environment variable value, for example, envs = {"model_name":"mxnet-model-1", "load_epoch":"0"}
-service_config2 = ServiceConfig( 
-                                 model_id="model_id2",
-                                 weight="30",
-                                 specification="specification",
-                                 instance_count=2,
-                                 envs=envs)         # Environment variable value, for example, envs = {"model_name":"mxnet-model-1", "load_epoch":"0"}
-configs.append(service_config1, service_config2)
+13
            vpc_id = None                                        # (Optional) ID of the VPC where the real-time service instance is deployed. This parameter is left blank by default.
+subnet_network_id = None                             # (Optional) Subnet ID. This parameter is left blank by default.
+security_group_id = None                             # (Optional) Security group. This parameter is left blank by default.
+
+transformer = model_instance.deploy_transformer(
+        service_name="service_transformer_name",
+        infer_type="batch",
+        vpc_id=vpc_id,
+        subnet_network_id=subnet_network_id,
+        security_group_id=security_group_id,
+        configs=configs                          # transformer configuration parameter. For details, see configs.
+
+)
 
            
 
 
            
+
          
+
          • Definition formats of the configs parameter group used for deploying a real-time service predictor and a batch service transformer
            • Deploying a real-time service predictor:
              The SDK provides the definition of the configs parameter. The type of configs is list, and those of the tuple objects in the list are ServiceConfig. The code is as follows:
              
+
              configs = []
+envs = {"model_name":"mxnet-model-1", "load_epoch":"0"}
+
+service_config1 = ServiceConfig(
+        model_id="model_id1",                 # model_id1 and model_id2 must be different versions of the same model.
+        weight="70",
+        specification="modelarts.vm.cpu.2u",  # For details, see specification.
+        instance_count=2,
+        envs=envs)                            # (Optional) Configure the environment variable, for example, envs = {"model_name":"mxnet-model-1", "load_epoch":"0"}.
+service_config2 = ServiceConfig(
+        model_id='model_id2',
+        weight="30",
+        specification="modelarts.vm.cpu.2u",  # For details, see specification.
+        instance_count=2,
+        envs=envs)                            # (Optional) Configure the environment variable, for example, envs = {"model_name":"mxnet-model-1", "load_epoch":"0"}.
+configs.append(service_config1)
+configs.append(service_config2)
              
 
            • Deploying a batch service transformer:
              The SDK provides the definition of the configs parameter. The type of configs is list, and those of the tuple objects in the list are TransformerConfig. The code is as follows:
              
 
               1
  2
@@ -104,17 +125,25 @@
  9
 10
 11
-12
              configs = []
-transformer_config1 = TransformerConfig( 
-                                         model_id="model_id",
-                                         specification="specification",
-                                         instance_count=2,
-                                         src_path="src_path",
-                                         dest_path="dest_path",
-                                         req_uri="req_uri",
-                                         mapping_type="mapping_type",
-                                         mapping_rule="mapping_rule",
-                                         envs=envs)      # Environment variable value, for example, envs = {"model_name":"mxnet-model-1", "load_epoch":"0"}
+12
+13
+14
+15
+16
              configs = []
+mapping_rule = None                               # (Optional) Mapping between input parameters and CSV data
+mapping_type= "file"                              # file or CSV
+envs = {"model_name":"mxnet-model-1", "load_epoch":"0"}
+
+transformer_config1 = TransformerConfig(
+            model_id="model_id",
+            specification="modelarts.vm.cpu.2u",   # For details, see specification.
+            instance_count=2,
+            src_path="/shp-cn4/sdk-demo/",         # OBS path to the input of the batch task
+            dest_path="/shp-cn4/data-out/",        # OBS path to the output of the batch task
+            req_uri="/",
+            mapping_type=mapping_type,
+            mapping_rule=mapping_rule,
+            envs=envs)                             # (Optional) Configure the environment variable, for example, envs = {"model_name":"mxnet-model-1", "load_epoch":"0"}.
 configs.append(transformer_config1)
 
              
 
@@ -125,30 +154,30 @@
 
              Parameter Description
              
 
              
-
-
-
-
-
-
-
-
-
@@ -157,345 +186,345 @@
 
 
              Table 1 Parameter description
              Parameter
              
 
              Mandatory
              
+
              Mandatory
              
 
              Type
              
+
              Type
              
 
              Description
              
+
              Description
              
               		
 
              
               
 
              service_id
              
 
              Yes
              
+
              Yes
              
 
              String
              
+
              String
              
 
              Service ID, which can be obtained from the real-time service on the ModelArts management console
              
+
              Service ID, which can be obtained from the real-time service on the ModelArts management console
              
               		
 
              
 
              session
              
 
              Yes
              
+
              Yes
              
 
              Object
              
+
              Object
              
 
              Session object. For details about the initialization method, see Session Authentication.
              
+
              Session object. For details about the initialization method, see Session Authentication.
              
               		
 
              
 
              
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
              Table 2 Parameters for deploying the predictor and transformer
              Parameter
              
 
              Mandatory
              
+
              Mandatory
              
 
              Type
              
+
              Type
              
 
              Description
              
+
              Description
              
               		
 
              
               
 
              service_name
              
 
              No
              
+
              No
              
 
              String
              
+
              String
              
 
              Service name, which consists of 1 to 64 characters. It must start with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed.
              
+
              Service name, which consists of 1 to 64 characters. It must start with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed.
              
               		
 
              
 
              description
              
 
              No
              
+
              No
              
 
              String
              
+
              String
              
 
              Service description, which contains a maximum of 100 characters. By default, this parameter is left blank.
              
+
              Service description, which contains a maximum of 100 characters. By default, this parameter is left blank.
              
               		
 
              
 
              infer_type
              
 
              No
              
+
              No
              
 
              String
              
+
              String
              
 
              Inference mode. The value can be real-time or batch. The default value is real-time.
              
+
              Inference mode. The value can be real-time or batch. The default value is real-time.
              
 
              • real-time: real-time service. A model is deployed as a web service and provides real-time test UI and monitoring capabilities. The service keeps running.
              • batch: batch service. A batch service can perform inference on batch data and automatically stops after data processing is completed.
              
               		
 
              
 
              vpc_id
              
 
              No
              
+
              No
              
 
              String
              
+
              String
              
 
              ID of the VPC to which a real-time service instance is deployed. By default, this parameter is left blank. In this case, ModelArts allocates a dedicated VPC to each user, and users are isolated from each other. If you need to access other service components in the VPC of the service instance, set this parameter to the ID of the corresponding VPC.
              
+
              ID of the VPC to which a real-time service instance is deployed. By default, this parameter is left blank. In this case, ModelArts allocates a dedicated VPC to each user, and users are isolated from each other. To access other service components in the VPC of the service instance, set this parameter to the ID of the corresponding VPC.
              
 
              Once a VPC is configured, it cannot be modified. When vpc_id and cluster_id are configured, only the dedicated cluster parameter takes effect.
              
               		
 
              
 
              subnet_network_id
              
 
              No
              
+
              No
              
 
              String
              
+
              String
              
 
              ID of a subnet. By default, this parameter is left blank. This parameter is mandatory when vpc_id is configured. Enter the network ID displayed in the subnet details on the VPC management console. A subnet provides dedicated network resources that are isolated from other networks.
              
+
              ID of a subnet. By default, this parameter is left blank. This parameter is mandatory when vpc_id is configured. Enter the network ID displayed in the subnet details on the VPC management console. A subnet provides dedicated network resources that are isolated from other networks.
              
               		
 
              
 
              security_group_id
              
 
              No
              
+
              No
              
 
              String
              
+
              String
              
 
              Security group. By default, this parameter is left blank. This parameter is mandatory when vpc_id is configured. A security group is a virtual firewall that provides secure network access control policies for service instances. A security group must contain at least one inbound rule to permit the requests whose protocol is TCP, source address is 0.0.0.0/0, and port number is 8080.
              
+
              Security group. By default, this parameter is left blank. This parameter is mandatory when vpc_id is configured. A security group is a virtual firewall that provides secure network access control policies for service instances. A security group must contain at least one inbound rule to permit the requests whose protocol is TCP, source address is 0.0.0.0/0, and port number is 8080.
              
               		
 
              
 
              configs
              
 
              Yes
              
+
              Yes
              
 
              configs parameters of predictor and transformer
              
+
              configs parameters of predictor and transformer
              
 
              Model running configurations
              
+
              Model running configurations
              
 
              • When infer_type is set to batch, only one model can be configured.
              • When infer_type is set to real-time, you can configure multiple models and assign traffic weights based on service requirements. The version numbers of the models must be different.
              
               		
 
              
 
              schedule
              
 
              No
              
+
              No
              
 
              schedule array
              
+
              schedule array
              
 
              Service scheduling configuration, which can be configured only for real-time services. By default, this parameter is not used. Services run for a long time. For details, see Table 6.
              
+
              Service scheduling configuration, which can be configured only for real-time services. By default, this parameter is not used. Services run for a long time. For details, see Table 6.
              
               		
 
              
               
 
              
 
              
 
-
              Table 3 configs parameters of predictor
              Parameter
              
+
              
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
              Table 3 configs parameters of predictor
              Parameter
              
 
              Mandatory
              
+
              Mandatory
              
 
              Type
              
+
              Type
              
 
              Description
              
+
              Description
              
               		
 
              
 
              model_id
              
+
              model_id
              
 
              Yes
              
+
              Yes
              
 
              String
              
+
              String
              
 
              Model ID. You can obtain the value by calling the API described in Obtaining the Model List or from the ModelArts management console.
              
+
              Model ID. You can obtain the value by calling the API described in Obtaining the Model List or from the ModelArts management console.
              
               		
 
              weight
              
+
              weight
              
 
              Yes
              
+
              Yes
              
 
              Integer
              
+
              Integer
              
 
              Weight of traffic allocated to a model. This parameter is mandatory only when infer_type is set to real-time. The sum of multiple weights must be equal to 100. If multiple model versions are configured in a real-time service and different traffic weights are set, ModelArts continuously accesses the prediction API of the service and forwards prediction requests to the model instances of the corresponding versions based on the weights.
              
+
              Weight of traffic allocated to a model. This parameter is mandatory only when infer_type is set to real-time. The sum of multiple weights must be equal to 100. If multiple model versions are configured in a real-time service and different traffic weights are set, ModelArts continuously accesses the prediction API of the service and forwards prediction requests to the model instances of the corresponding versions based on the weights.
              
 
              {
-"service_name": "mnist",
-"description": "mnist service",
-"infer_type": "real-time",
-"config": [
-{
-"model_id": "xxxmodel-idxxx",
-"weight": "70",
-"specification": "modelarts.vm.cpu.2u",
-"instance_count": 1,
-"envs":
-{
-"model_name": "mxnet-model-1",
-"load_epoch": "0"
-}
-},
-{
-"model_id": "xxxxxx",
-"weight": "30",
-"specification": "modelarts.vm.cpu.2u",
-"instance_count": 1
-}
-]
+    "service_name": "mnist",
+    "description": "mnist service",
+    "infer_type": "real-time",
+    "config": [
+        {
+            "model_id": "xxxmodel-idxxx",
+            "weight": "70",
+            "specification": "modelarts.vm.cpu.2u",
+            "instance_count": 1,
+            "envs":
+                {
+                    "model_name": "mxnet-model-1",
+                    "load_epoch": "0"
+                }
+        },
+        {
+            "model_id": "xxxxxx",
+            "weight": "30",
+            "specification": "modelarts.vm.cpu.2u",
+            "instance_count": 1
+        }
+    ]
 }
              
               		
 
              specification
              
+
              specification
              
 
              Yes
              
+
              Yes
              
 
              String
              
+
              String
              
 
              Resource specifications. 
              
+
              Resource specifications. 
              
               		
 
              instance_count
              
+
              instance_count
              
 
              Yes
              
+
              Yes
              
 
              Integer
              
+
              Integer
              
 
              Number of instances deployed in a model. The maximum number of instances is 5. To use more instances, submit a service ticket.
              
+
              Number of instances deployed in a model. The maximum number of instances is 5. To use more instances, submit a service ticket.
              
               		
 
              envs
              
+
              envs
              
 
              No
              
+
              No
              
 
              Map<String, String>
              
+
              Map<String, String>
              
 
              (Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank.
              
+
              (Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank.
              
               		
 
              
               
 
              
 
              
 
-
              Table 4 configs parameters of transformer
              Parameter
              
+
              
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -503,65 +532,65 @@
 
              Table 4 configs parameters of transformer
              Parameter
              
 
              Mandatory
              
+
              Mandatory
              
 
              Type
              
+
              Type
              
 
              Description
              
+
              Description
              
               		
 
              
 
              model_id
              
+
              model_id
              
 
              Yes
              
+
              Yes
              
 
              String
              
+
              String
              
 
              Model ID
              
+
              Model ID
              
               		
 
              specification
              
+
              specification
              
 
              Yes
              
+
              Yes
              
 
              String
              
+
              String
              
 
              Resource flavor. Currently, modelarts.vm.cpu.2u and modelarts.vm.gpu.p4 are available.
              
+
              Resource flavor. Currently, modelarts.vm.cpu.2u and modelarts.vm.gpu.p4 are available.
              
               		
 
              instance_count
              
+
              instance_count
              
 
              Yes
              
+
              Yes
              
 
              Integer
              
+
              Integer
              
 
              Number of instances deployed in a model. The value range during the closed beta test is [1, 2].
              
+
              Number of instances deployed in a model. The value range during the closed beta test is [1, 2].
              
               		
 
              envs
              
+
              envs
              
 
              No
              
+
              No
              
 
              Map<String, String>
              
+
              Map<String, String>
              
 
              (Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank.
              
+
              (Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank.
              
               		
 
              src_path
              
+
              src_path
              
 
              Yes
              
+
              Yes
              
 
              String
              
+
              String
              
 
              OBS path of the input data of a batch job
              
+
              OBS path of the input data of a batch job
              
               		
 
              dest_path
              
+
              dest_path
              
 
              Yes
              
+
              Yes
              
 
              String
              
+
              String
              
 
              OBS path of the output data of a batch job
              
+
              OBS path of the output data of a batch job
              
               		
 
              req_uri
              
+
              req_uri
              
 
              Yes
              
+
              Yes
              
 
              String
              
+
              String
              
 
              Inference API called in a batch task, that is, the RESTful API exposed in the model image. You must select an API URL from the config.json file of the model for inference. If a built-in inference image of ModelArts is used, the API is displayed as /.
              
+
              Inference API called in a batch task, that is, the RESTful API exposed in the model image. You must select an API URL from the config.json file of the model for inference. If a built-in inference image of ModelArts is used, the API is displayed as /.
              
               		
 
              mapping_type
              
+
              mapping_type
              
 
              Yes
              
+
              Yes
              
 
              String
              
+
              String
              
 
              Mapping type of the input data. The value can be file or csv.
              
+
              Mapping type of the input data. The value can be file or csv.
              
 
              • If you select file, each inference request corresponds to a file in the input data path. When this mode is used, req_uri of a model can have only one input parameter and the type of this parameter is file.
              • If you select csv, each inference request corresponds to a row of data in the CSV file. When this mode is used, the files in the input data path can only be in CSV format and mapping_rule needs to be configured to map the index of each parameter in the inference request body to the CSV file.
              
 
              The following shows how to create a batch service whose mapping_type is set to file:
              
 
              {
-"service_name": "batchservicetest",
-"description": "",
-"infer_type": "batch",
-"config": [{
-"model_id": "598b913a-af3e-41ba-a1b5-bf065320f1e2",
-"specification": "modelarts.vm.cpu.2u",
-"instance_count": 1,
-"src_path": "https://infers-data.obs.xxx.com/xgboosterdata/",
-"dest_path": "https://infers-data.obs.xxx.com/output/",
-"req_uri": "/",
-"mapping_type": "file"
-}]
+    "service_name": "batchservicetest",
+    "description": "",
+    "infer_type": "batch",
+    "config": [{
+        "model_id": "598b913a-af3e-41ba-a1b5-bf065320f1e2",
+        "specification": "modelarts.vm.cpu.2u",
+        "instance_count": 1,
+        "src_path": "https://infers-data.obs.xxx.com/xgboosterdata/",
+        "dest_path": "https://infers-data.obs.xxx.com/output/",
+        "req_uri": "/",
+        "mapping_type": "file"
+    }]
 }
              
 
              The following shows how to create a batch service whose mapping_type is set to csv:
              
 
              {
-"service_name": "batchservicetest",
-"description": "",
-"infer_type": "batch",
-"config": [{
-"model_id": "598b913a-af3e-41ba-a1b5-bf065320f1e2",
-"specification": "modelarts.vm.cpu.2u",
-"instance_count": 1,
-"src_path": "https://infers-data.obs.xxx.com/xgboosterdata/",
-"dest_path": "https://infers-data.obs.xxx.com/output/",
-"req_uri": "/",
-"mapping_type": "csv",
-"mapping_rule": {
-"type": "object",
-"properties": {
-"data": {
-"type": "object",
-"properties": {
-"req_data": {
-"type": "array",
-"items": [{
-"type": "object",
-"properties": {
-"input5": {
-"type": "number",
-"index": 0
-},
-"input4": {
-"type": "number",
-"index": 1
-},
-"input3": {
-"type": "number",
-"index": 2
-},
-"input2": {
-"type": "number",
-"index": 3
-},
-"input1": {
-"type": "number",
-"index": 4
-}
-}
-}]
-}
-}
-}
-}
-}
-}]
+    "service_name": "batchservicetest",
+    "description": "",
+    "infer_type": "batch",
+    "config": [{
+        "model_id": "598b913a-af3e-41ba-a1b5-bf065320f1e2",
+        "specification": "modelarts.vm.cpu.2u",
+        "instance_count": 1,
+        "src_path": "https://infers-data.obs.xxx.com/xgboosterdata/",
+        "dest_path": "https://infers-data.obs.xxx.com/output/",
+        "req_uri": "/",
+        "mapping_type": "csv",
+        "mapping_rule": {
+            "type": "object",
+            "properties": {
+                "data": {
+                    "type": "object",
+                    "properties": {
+                        "req_data": {
+                            "type": "array",
+                            "items": [{
+                                "type": "object",
+                                "properties": {
+                                    "input5": {
+                                        "type": "number",
+                                        "index": 0
+                                    },
+                                    "input4": {
+                                        "type": "number",
+                                        "index": 1
+                                    },
+                                    "input3": {
+                                        "type": "number",
+                                        "index": 2
+                                    },
+                                    "input2": {
+                                        "type": "number",
+                                        "index": 3
+                                    },
+                                    "input1": {
+                                        "type": "number",
+                                        "index": 4
+                                    }
+                                }
+                            }]
+                        }
+                    }
+                }
+            }
+        }
+    }]
 }
              
               		
 
              mapping_rule
              
+
              mapping_rule
              
 
              No
              
+
              No
              
 
              Map
              
+
              Map
              
 
              Mapping between input parameters and CSV data. This parameter is mandatory only when mapping_type is set to csv. The mapping rule is similar to the input parameter definition in the config.json model configuration file. You only need to configure the index parameters under each parameter of the string, number, integer, or boolean type, and the value of this parameter to the values of the index parameters in the CSV file to send an inference request. Use commas (,) to separate multiple pieces of CSV data. The values of the index parameters start from 0. If the value of the index parameter is -1, ignore this parameter. For details, see the sample code of deploying transformer.
              
+
              Mapping between input parameters and CSV data. This parameter is mandatory only when mapping_type is set to csv. The mapping rule is similar to the input parameter definition in the config.json model configuration file. You only need to configure the index parameters under each parameter of the string, number, integer, or boolean type, and the value of this parameter to the values of the index parameters in the CSV file to send an inference request. Use commas (,) to separate multiple pieces of CSV data. The values of the index parameters start from 0. If the value of the index parameter is -1, ignore this parameter. For details, see the sample code of deploying transformer.
              
 
              The format of the inference request body described in mapping_rule is as follows:
              
 
              {
-"data": {
-"req_data": [{
-"input1": 1,
-"input2": 2,
-"input3": 3,
-"input4": 4,
-"input5": 5
-}]
-}
+    "data": {
+        "req_data": [{
+            "input1": 1,
+            "input2": 2,
+            "input3": 3,
+            "input4": 4,
+            "input5": 5
+        }]
+    }
 }
              
               		
 
              
 
              
 
-
              Table 5 Parameters in the response to the request for deploying predictor and transformer
              Parameter
              
+
              
-
-
-
-
-
-
-
              Table 5 Parameters in the response to the request for deploying predictor and transformer
              Parameter
              
 
              Mandatory
              
+
              Mandatory
              
 
              Type
              
+
              Type
              
 
              Description
              
+
              Description
              
               		
 
              
 
              predictor
              
+
              predictor
              
 
              Yes
              
+
              Yes
              
 
              Predictor object
              
+
              Predictor object
              
 
              Predictor object. Its attributes include all functions described in this chapter.
              
+
              Predictor object. Its attributes include all functions described in this chapter.
              
               		
 
              
               
 
              
 
              
 
-
              Table 6 schedule parameters
              Parameter
              
+
              
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -583,9 +612,9 @@
 14
              Table 6 schedule parameters
              Parameter
              
 
              Mandatory
              
+
              Mandatory
              
 
              Type
              
+
              Type
              
 
              Description
              
+
              Description
              
               		
 
              
 
              op_type
              
+
              op_type
              
 
              Yes
              
+
              Yes
              
 
              String
              
+
              String
              
 
              Scheduling type. Currently, only the value stop is supported.
              
+
              Scheduling type. Currently, only the value stop is supported.
              
               		
 
              time_unit
              
+
              time_unit
              
 
              Yes
              
+
              Yes
              
 
              String
              
+
              String
              
 
              Scheduling time unit. The options are as follows:
              
+
              Scheduling time unit. The options are as follows:
              
 
              • DAYS
              • HOURS
              • MINUTES
              
               		
 
              duration
              
+
              duration
              
 
              Yes
              
+
              Yes
              
 
              Integer
              
+
              Integer
              
 
              Value that maps to the time unit. For example, if the task stops after two hours, set time_unit to HOURS and duration to 2.
              
+
              Value that maps to the time unit. For example, if the task stops after two hours, set time_unit to HOURS and duration to 2.
              
               		
 
              
 
              from modelarts.session import Session
 from modelarts.model import Model
 from modelarts.config.model_config import ServiceConfig,TransformerConfig 
-model_instance = Model(session, model_id = "input you model id")
+model_instance = Model(session, model_id = "input your model id")
 configs = []
-config1 = ServiceConfig(model_id="input you model id", 
+config1 = ServiceConfig(model_id="input your model id",
                         weight="100", 
                         instance_count=1, 
                         specification="modelarts.vm.cpu.2u",
diff --git a/docs/modelarts/sdk-ref/modelarts_04_0207.html b/docs/modelarts/sdk-ref/modelarts_04_0207.html
index 67e97dc3..a010a455 100644
--- a/docs/modelarts/sdk-ref/modelarts_04_0207.html
+++ b/docs/modelarts/sdk-ref/modelarts_04_0207.html
@@ -248,33 +248,33 @@
 
              
 
              
 
-
              Table 4 update_service_config response parameters
              Parameter
              
+
              
-
-
-
-
-
-
-
-
-
-
-
              Table 4 update_service_config response parameters
              Parameter
              
 
              Mandatory
              
+
              Mandatory
              
 
              Type
              
+
              Type
              
 
              Description
              
+
              Description
              
               		
 
              
 
              error_code
              
+
              error_code
              
 
              Yes
              
+
              Yes
              
 
              String
              
+
              String
              
 
              Error code when the API call fails.
              
+
              Error code when the API call fails.
              
 
              This parameter is not included when the API call succeeds.
              
               		
 
              error_msg
              
+
              error_msg
              
 
              Yes
              
+
              Yes
              
 
              String
              
+
              String
              
 
              Error message when the API call fails.
              
+
              Error message when the API call fails.
              
 
              This parameter is not included when the API call succeeds.