Lai, Weijian eda19245f1 modelarts sdk-ref version 21.430 update
Reviewed-by: Jiang, Beibei <beibei.jiang@t-systems.com>
Reviewed-by: Rechenburg, Matthias <matthias.rechenburg@t-systems.com>
Co-authored-by: Lai, Weijian <laiweijian4@huawei.com>
Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>
2023-03-20 09:32:27 +00:00

632 lines
25 KiB
JSON

[
{
"desc":"This document describes how to install and configure a development environment and call functions provided by ModelArts SDK for secondary development.",
"product_code":"modelarts",
"title":"Before You Start",
"uri":"modelarts_04_0001.html",
"doc_type":"sdkreference",
"p_code":"",
"code":"1"
},
{
"desc":"ModelArts Software Development Kit (ModelArts SDK) encapsulates the ModelArts RESTful APIs in Python language to simplify application development. You can directly call M",
"product_code":"modelarts",
"title":"SDK Overview",
"uri":"modelarts_04_0002.html",
"doc_type":"sdkreference",
"p_code":"",
"code":"2"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"modelarts",
"title":"Preparations",
"uri":"modelarts_04_0003.html",
"doc_type":"sdkreference",
"p_code":"",
"code":"3"
},
{
"desc":"ModelArts SDK can be used in the following environments:ModelArts SDK has been integrated into ModelArts Notebook and can be directly used without session authentication.",
"product_code":"modelarts",
"title":"Environment Preparations",
"uri":"modelarts_04_0005.html",
"doc_type":"sdkreference",
"p_code":"3",
"code":"4"
},
{
"desc":"Download the ModelArts SDK software package of the latest version.After the SDK is downloaded, you can use pip to install it. For details about how to install pip, see th",
"product_code":"modelarts",
"title":"Downloading and Installing the SDK",
"uri":"modelarts_04_0004.html",
"doc_type":"sdkreference",
"p_code":"3",
"code":"5"
},
{
"desc":"When calling APIs, you need to specify the project ID in certain URLs. To do so, you need to obtain the project ID first. To obtain a project ID, perform the following op",
"product_code":"modelarts",
"title":"Viewing the Project ID",
"uri":"modelarts_04_0044.html",
"doc_type":"sdkreference",
"p_code":"3",
"code":"6"
},
{
"desc":"Using the SDK in non-notebook environments needs to call IAM, OBS, and ModelArts. Therefore, the endpoints of these services are required. Therefore, the endpoints of the",
"product_code":"modelarts",
"title":"Configuring a Service Endpoint",
"uri":"modelarts_04_0300.html",
"doc_type":"sdkreference",
"p_code":"3",
"code":"7"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"modelarts",
"title":"Session Authentication",
"uri":"modelarts_04_0153.html",
"doc_type":"sdkreference",
"p_code":"",
"code":"8"
},
{
"desc":"The session module authenticates in-cloud resources and initializes ModelArts SDK Client and OBS Client. After a session is set up, you can directly call the ModelArts SD",
"product_code":"modelarts",
"title":"Overview of Session Authentication",
"uri":"modelarts_04_0123.html",
"doc_type":"sdkreference",
"p_code":"8",
"code":"9"
},
{
"desc":"This authentication method is available for OBS Management, Training Management, Model Management, and Service Management.Set account to your domain name and username to ",
"product_code":"modelarts",
"title":"Authentication Using the Username and Password",
"uri":"modelarts_04_0154.html",
"doc_type":"sdkreference",
"p_code":"8",
"code":"10"
},
{
"desc":"This authentication method is available for OBS Management, Training Management, Model Management, and Service Management.Parameters in this command are described as foll",
"product_code":"modelarts",
"title":"AK/SK-based Authentication",
"uri":"modelarts_04_0155.html",
"doc_type":"sdkreference",
"p_code":"8",
"code":"11"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"modelarts",
"title":"OBS Management (Recommended)",
"uri":"modelarts_04_0006.html",
"doc_type":"sdkreference",
"p_code":"",
"code":"12"
},
{
"desc":"ModelArts SDK 1.1.3 supports OBS management, including uploading and downloading files and folders. The operations are as follows:Uploading a File to OBSUploading a Folde",
"product_code":"modelarts",
"title":"Overview of OBS Management",
"uri":"modelarts_04_0217.html",
"doc_type":"sdkreference",
"p_code":"12",
"code":"13"
},
{
"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",
"product_code":"modelarts",
"title":"Uploading a File to OBS",
"uri":"modelarts_04_0218.html",
"doc_type":"sdkreference",
"p_code":"12",
"code":"14"
},
{
"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",
"product_code":"modelarts",
"title":"Uploading a Folder to OBS",
"uri":"modelarts_04_0219.html",
"doc_type":"sdkreference",
"p_code":"12",
"code":"15"
},
{
"desc":"If the size of a file in a folder exceeds 5 GB, the file cannot be downloaded in this mode.In the ModelArts notebook instance, you do not need to enter authentication par",
"product_code":"modelarts",
"title":"Downloading a File from OBS",
"uri":"modelarts_04_0220.html",
"doc_type":"sdkreference",
"p_code":"12",
"code":"16"
},
{
"desc":"If the size of a file in a folder exceeds 5 GB, the file cannot be downloaded in this mode. However, other files whose size is less than 5 GB in the folder can be downloa",
"product_code":"modelarts",
"title":"Downloading a Folder from OBS",
"uri":"modelarts_04_0221.html",
"doc_type":"sdkreference",
"p_code":"12",
"code":"17"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"modelarts",
"title":"Training Management",
"uri":"modelarts_04_0157.html",
"doc_type":"sdkreference",
"p_code":"",
"code":"18"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"modelarts",
"title":"Training Jobs",
"uri":"modelarts_04_0158.html",
"doc_type":"sdkreference",
"p_code":"18",
"code":"19"
},
{
"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",
"doc_type":"sdkreference",
"p_code":"19",
"code":"20"
},
{
"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 Training Jobs",
"uri":"modelarts_04_0160.html",
"doc_type":"sdkreference",
"p_code":"19",
"code":"21"
},
{
"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 Details About a Training Job",
"uri":"modelarts_04_0161.html",
"doc_type":"sdkreference",
"p_code":"19",
"code":"22"
},
{
"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",
"doc_type":"sdkreference",
"p_code":"19",
"code":"23"
},
{
"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",
"doc_type":"sdkreference",
"p_code":"19",
"code":"24"
},
{
"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 Training Job Logs",
"uri":"modelarts_04_0164.html",
"doc_type":"sdkreference",
"p_code":"19",
"code":"25"
},
{
"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",
"product_code":"modelarts",
"title":"Deleting a Training Job",
"uri":"modelarts_04_0166.html",
"doc_type":"sdkreference",
"p_code":"19",
"code":"26"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"modelarts",
"title":"Training Job Versions",
"uri":"modelarts_04_0167.html",
"doc_type":"sdkreference",
"p_code":"18",
"code":"27"
},
{
"desc":"A training job must exist before you create a version for it. You can create a training job version based on Creating a Training Job or job_id and version_id of the objec",
"product_code":"modelarts",
"title":"Creating a Training Job Version",
"uri":"modelarts_04_0168.html",
"doc_type":"sdkreference",
"p_code":"27",
"code":"28"
},
{
"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",
"product_code":"modelarts",
"title":"Querying the List of Training Job Versions",
"uri":"modelarts_04_0169.html",
"doc_type":"sdkreference",
"p_code":"27",
"code":"29"
},
{
"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 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 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",
"doc_type":"sdkreference",
"p_code":"27",
"code":"31"
},
{
"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",
"doc_type":"sdkreference",
"p_code":"27",
"code":"32"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"modelarts",
"title":"Training Job Parameter Configuration",
"uri":"modelarts_04_0173.html",
"doc_type":"sdkreference",
"p_code":"18",
"code":"33"
},
{
"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",
"product_code":"modelarts",
"title":"Creating a Training Job Configuration",
"uri":"modelarts_04_0174.html",
"doc_type":"sdkreference",
"p_code":"33",
"code":"34"
},
{
"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",
"product_code":"modelarts",
"title":"Querying the List of Training Job Parameter Configuration Objects",
"uri":"modelarts_04_0175.html",
"doc_type":"sdkreference",
"p_code":"33",
"code":"35"
},
{
"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 Training Job Configurations",
"uri":"modelarts_04_0176.html",
"doc_type":"sdkreference",
"p_code":"33",
"code":"36"
},
{
"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 Details About a Training Job Configuration",
"uri":"modelarts_04_0177.html",
"doc_type":"sdkreference",
"p_code":"33",
"code":"37"
},
{
"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",
"doc_type":"sdkreference",
"p_code":"33",
"code":"38"
},
{
"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",
"doc_type":"sdkreference",
"p_code":"33",
"code":"39"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"modelarts",
"title":"Visualization Jobs",
"uri":"modelarts_04_0180.html",
"doc_type":"sdkreference",
"p_code":"18",
"code":"40"
},
{
"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",
"product_code":"modelarts",
"title":"Creating a Visualization Job",
"uri":"modelarts_04_0181.html",
"doc_type":"sdkreference",
"p_code":"40",
"code":"41"
},
{
"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",
"product_code":"modelarts",
"title":"Querying the List of Visualization Job Objects",
"uri":"modelarts_04_0182.html",
"doc_type":"sdkreference",
"p_code":"40",
"code":"42"
},
{
"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 Visualization Jobs",
"uri":"modelarts_04_0183.html",
"doc_type":"sdkreference",
"p_code":"40",
"code":"43"
},
{
"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 Details About a Visualization Job",
"uri":"modelarts_04_0184.html",
"doc_type":"sdkreference",
"p_code":"40",
"code":"44"
},
{
"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",
"doc_type":"sdkreference",
"p_code":"40",
"code":"45"
},
{
"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",
"doc_type":"sdkreference",
"p_code":"40",
"code":"46"
},
{
"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",
"doc_type":"sdkreference",
"p_code":"40",
"code":"47"
},
{
"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",
"doc_type":"sdkreference",
"p_code":"40",
"code":"48"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"modelarts",
"title":"Resource and Engine Specifications",
"uri":"modelarts_04_0189.html",
"doc_type":"sdkreference",
"p_code":"18",
"code":"49"
},
{
"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 a Built-in Algorithm",
"uri":"modelarts_04_0190.html",
"doc_type":"sdkreference",
"p_code":"49",
"code":"50"
},
{
"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",
"product_code":"modelarts",
"title":"Querying the List of Resource Flavors",
"uri":"modelarts_04_0191.html",
"doc_type":"sdkreference",
"p_code":"49",
"code":"51"
},
{
"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",
"product_code":"modelarts",
"title":"Querying the List of Engine Types",
"uri":"modelarts_04_0192.html",
"doc_type":"sdkreference",
"p_code":"49",
"code":"52"
},
{
"desc":"Table 1 describes the job statuses.",
"product_code":"modelarts",
"title":"Job Statuses",
"uri":"modelarts_04_0077.html",
"doc_type":"sdkreference",
"p_code":"18",
"code":"53"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"modelarts",
"title":"Model Management",
"uri":"modelarts_04_0193.html",
"doc_type":"sdkreference",
"p_code":"",
"code":"54"
},
{
"desc":"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",
"product_code":"modelarts",
"title":"Importing a Model",
"uri":"modelarts_04_0194.html",
"doc_type":"sdkreference",
"p_code":"54",
"code":"55"
},
{
"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 Model List",
"uri":"modelarts_04_0195.html",
"doc_type":"sdkreference",
"p_code":"54",
"code":"56"
},
{
"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 Model Object List",
"uri":"modelarts_04_0196.html",
"doc_type":"sdkreference",
"p_code":"54",
"code":"57"
},
{
"desc":"You can use the API to query the information about a model object.In the ModelArts notebook instance, you do not need to enter authentication parameters for session authe",
"product_code":"modelarts",
"title":"Querying the Details About a Model",
"uri":"modelarts_04_0197.html",
"doc_type":"sdkreference",
"p_code":"54",
"code":"58"
},
{
"desc":"You can use the API to delete a model object.In a ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details ",
"product_code":"modelarts",
"title":"Deleting a Model",
"uri":"modelarts_04_0198.html",
"doc_type":"sdkreference",
"p_code":"54",
"code":"59"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"modelarts",
"title":"Service Management",
"uri":"modelarts_04_0199.html",
"doc_type":"sdkreference",
"p_code":"",
"code":"60"
},
{
"desc":"Service management indicates deploying a model that has been successfully created as a real-time. This feature provides functions such as real-time prediction, service de",
"product_code":"modelarts",
"title":"Service Management Overview",
"uri":"modelarts_04_0200.html",
"doc_type":"sdkreference",
"p_code":"60",
"code":"61"
},
{
"desc":"Real-time service deployment covers the following aspects:Initialize a real-time service.Deploy a real-time service predictor.Deploy a batch service transformer.The servi",
"product_code":"modelarts",
"title":"Deploying a Real-Time Service",
"uri":"modelarts_04_0201.html",
"doc_type":"sdkreference",
"p_code":"60",
"code":"62"
},
{
"desc":"You can use the API to query details about a service object.In the ModelArts notebook instance, you do not need to enter authentication parameters for session authenticat",
"product_code":"modelarts",
"title":"Querying the Details of a Service",
"uri":"modelarts_04_0203.html",
"doc_type":"sdkreference",
"p_code":"60",
"code":"63"
},
{
"desc":"You can use the API to obtain the service list of a user.In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication",
"product_code":"modelarts",
"title":"Querying the Service List",
"uri":"modelarts_04_0205.html",
"doc_type":"sdkreference",
"p_code":"60",
"code":"64"
},
{
"desc":"You can use the API to obtain the service object list of a user.In the ModelArts notebook instance, you do not need to enter authentication parameters for session authent",
"product_code":"modelarts",
"title":"Querying the List of Service Objects",
"uri":"modelarts_04_0206.html",
"doc_type":"sdkreference",
"p_code":"60",
"code":"65"
},
{
"desc":"You can use the API to update the configurations of a service object.In ModelArts notebook, you do not need to enter authentication parameters for session authentication.",
"product_code":"modelarts",
"title":"Updating Service Configurations",
"uri":"modelarts_04_0207.html",
"doc_type":"sdkreference",
"p_code":"60",
"code":"66"
},
{
"desc":"You can use the API to query the monitoring information about a service.In the ModelArts notebook instance, you do not need to enter authentication parameters for session",
"product_code":"modelarts",
"title":"Querying Service Monitoring Details",
"uri":"modelarts_04_0208.html",
"doc_type":"sdkreference",
"p_code":"60",
"code":"67"
},
{
"desc":"You can use the API to query the logs of a service object.In the ModelArts notebook instance, you do not need to enter authentication parameters for session authenticatio",
"product_code":"modelarts",
"title":"Querying Service Logs",
"uri":"modelarts_04_0209.html",
"doc_type":"sdkreference",
"p_code":"60",
"code":"68"
},
{
"desc":"You can delete a service in either of the following ways:Delete the service created in Deploying a Real-Time Service.Delete the service object returned in Querying the Li",
"product_code":"modelarts",
"title":"Delete a Service",
"uri":"modelarts_04_0211.html",
"doc_type":"sdkreference",
"p_code":"60",
"code":"69"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"modelarts",
"title":"Change History",
"uri":"modelarts_04_0099.html",
"doc_type":"sdkreference",
"p_code":"",
"code":"70"
}
]