Updated on 2023-10-16 GMT+08:00

SDK Overview

ModelArts Software Development Kits (ModelArts SDKs) encapsulate ModelArts REST APIs in Python language to simplify application development. You can directly call ModelArts SDKs to easily start AI training, generate models, and deploy the models as real-time services.

ModelArts SDKs support only Python of versions later than 3.7.x and earlier than 3.10.x. Version 3.7.x is recommended.

Scenarios

ModelArts SDKs can be used only in the ModelArts development environment notebook and local PC environment.

ModelArts SDKs cannot be used in training jobs or real-time services.

  • ModelArts SDKs have been integrated into ModelArts notebook and can be directly used without session authentication.

    Log in to the ModelArts management console, choose DevEnviron > Notebook in the navigation pane, create a notebook instance, and call the ModelArts SDKs on the terminal or IPYNB file. You can call SDKs on a notebook instance to perform operations such as OBS management, job management, model management, and service management by referring to the SDK reference.

  • ModelArts SDKs can be installed, configured, and then used in local environments after session authentication.
    1. Install the SDKs in a local path. Install the SDKs locally by referring to (Optional) Installing the ModelArts SDK Locally. If the SDKs have been installed in a local path, skip this step.
    2. Perform session authentication by referring to (Optional) Session Authentication. The SDKs can be used after the authentication is complete.

SDK Versions

Table 1 ModelArts SDK versions

Released On

Version

Description

2023-04

1.4.18

Optimized and integrated on the basis of earlier versions, including DLI Spark task submission and service deployment in new-version dedicated resource pools for inference.

Supported Regions

The following regions are supported: CN-Hong Kong (ap-southeast-1), AP-Bangkok (ap-southeast-2), AP-Singapore (ap-southeast-3), and LA-Santiago (la-south-2).