华为云用户手册

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式一：根据指定的job_id和version_id停止 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() estimator = Estimator(session, job_id="182626", version_id="278813") status = estimator.stop_job_version() 方式二：根据创建训练作业版本生成的训练作业版本对象停止 1 status = job_version_instance.stop_job_version() 方式三：根据查询训练作业版本列表返回的指定训练作业版本对象停止 1 status = job_version_instance_list[0].stop_job_version()

参数说明 表1 get_visualization_job_object_list请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法见Session鉴权。 status 否 String 可视化作业的运行状态，详细作业状态列表请查看作业状态参考。 per_page 否 Integer 指定每一页展示作业的总量，默认为“10”，“per_page”可选的范围为[1，100]。 page 否 Integer 指定要查询页的索引，默认为“1”。 sortBy/sort_by 否 String 当使用AK/SK认证方式时，参数名为sortBy；当使用用户名密码认证方式时，参数名为sort_by。指定查询的排序方式，默认是作业名称“job_name”，目前支持的排序还有作业描述“job_desc”，作业状态“status”，运行时长“duration”以及创建时间 “create_time”，日志存储目录“log_dir”。 order 否 String 可选值。 “asc”为递增排序，默认为“asc”。 “desc”为递减排序。 search_content 否 String 指定要查询的文字信息，例如可视化作业名字，默认为空，字符串的长度为[0，100]。 is_show 否 Boolean 是否打印可视化作业列表，默认为“True”。 表2 get_visualization_job_object_list成功响应后返回可视化作业对象列表，其中列表中的每个元素参数说明如下： 参数 类型 描述 VisualizationJob Object 可视化作业对象。该对象包含visualization_id、create_time、job_name、status属性，及对可视化作业的查询、更新、停止、重启和删除等操作。 表3 VisualizationJob属性说明 参数 参数类型 描述 create_time Long 可视化作业的创建时间。 job_name String 可视化作业的名称。 status Byte 可视化训练作业的运行状态，详细作业状态列表请参见作业状态参考。 job_id String 可视化作业ID。 is_success Boolean 接口调用是否成功。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import VisualizationJob session = Session() job_visualization_instance_list = VisualizationJob.get_visualization_job_object_list(modelarts_session=session, is_show=True, status=8, per_page=10, page=1, sort_by="create_time", order="asc", search_content="job") print(job_visualization_instance_list)

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式一： 根据指定的visualization_id更新 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import VisualizationJob session = Session() job = VisualizationJob(modelarts_session=session, visualization_id='8992') job_description = job.update_visualization_job(job_desc='update visualization job') 方式二： 根据创建可视化作业生成的可视化作业对象更新 1 job_description = job_visualization_instance.update_visualization_job(job_desc='update visualization job') 方式三： 根据查询可视化作业对象列表返回的指定可视化作业对象更新 1 job_description = job_visualization_instance_list[0].update_visualization_job(job_desc='update visualization job')

参数说明 表1 VisualizationJob请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法见Session鉴权。 visualization_id 是 String 可视化作业ID。 表2 update_visualization_job请求参数说明 参数 是否必选 参数类型 描述 job_desc 是 String 对可视化作业的描述，字符串的长度限制为[0，256]。 表3 update_visualization_job返回参数说明 参数 参数类型 描述 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 is_success Boolean 接口调用是否成功。

参数说明 表1 Estimator请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法请参见Session鉴权。 job_id 是 String 训练作业的ID。job_id可通过创建训练作业生成的训练作业对象查询，如“job_instance.job_id”。或可通过查询训练作业列表的响应中获取。 version_id 是 String 训练作业的版本ID。version_id可通过创建训练作业生成的训练作业对象查询，如“job_instance.version_id”。或可通过查询训练作业列表的响应获取。 表2 get_job_info返回参数说明 参数 参数类型 描述 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 is_success Boolean 接口调用是否成功。 job_id Long 训练作业的ID。 job_name String 训练作业的名称。 job_desc String 训练作业的描述信息。 version_id Long 训练作业的版本ID。 version_name String 训练作业的版本名称。 pre_version_id Long 训练作业前一版本的名称。 engine_type Short 训练作业的引擎类型。“engine_type”和“engine_name”对应关系如下： 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 String 训练作业的引擎名称。目前支持的引擎名称如下： Caffe Horovod MXNet PyTorch Ray Spark_MLlib TensorFlow XGBoost-Sklearn engine_id Long 训练作业的引擎ID。 engine_version String 训练作业使用的引擎版本。 status Integer 训练作业的状态，详细作业状态列表请参见作业状态参考。 app_url String 训练作业的代码目录。 boot_file_url String 训练作业的代码启动文件。 create_time Long 训练作业的创建时间。 parameter JSON Array 训练作业的运行参数，为label-value格式；当为自定义镜像训练作业的时候，此参数为容器环境变量。 duration Long 训练作业的运行时间，单位为毫秒。 spec_id Long 训练作业资源规格ID。 core String 资源规格的核数。 cpu String 资源规格CPU内存。 gpu_num Integer 资源规格GPU的个数。 gpu_type String 资源规格GPU的类型。 worker_server_num Integer 训练作业worker的个数。 data_url String 训练作业的数据集。 train_url String 训练作业输出文件OBS路径。 dataset_version_id String 训练作业的数据集版本ID。 dataset_id String 训练作业的数据集ID。 data_source JSON Array 训练作业使用的多数据集。 model_id Long 训练作业的模型ID。 model_metric_list JSON Array 训练作业的模型评测参数。 system_metric_list JSON Array 训练作业的系统监控指标。 user_image_url String 自定义镜像训练作业的自定义镜像的SWR-URL。 user_command String 自定义镜像训练作业的自定义镜像的容器的启动命令。 表3 data_source属性列表 参数 参数类型 描述 dataset_id String 训练作业的数据集ID。 dataset_version String 训练作业的数据集版本ID。 type String 数据集类型。 “obs”：表示使用OBS的数据。 “dataset”：表示使用数据集的数据。 data_url String OBS的桶路径。 表4 model_metric_list属性列表 参数 参数类型 描述 metric JSON Array 训练作业的模型单个分类测评参数。 total_metric JSON Array 训练作业的模型总测评参数。 表5 system_metric_list属性列表 参数 参数类型 描述 cpuUsage JSON Array 训练作业CPU资源占用率。 memUsage JSON Array 训练作业内存资源占用率。 gpuUtil JSON Array 训练作业GPU资源占用率。 表6 metric属性列表 参数 参数类型 描述 metric_values JSON Array 训练作业模型单个分类测评参数指标。 reserved_data JSON Array 预留字段。 metric_meta JSON Array 训练作业模型单个分类，包含类ID和类名。 表7 metric_values属性列表 参数 参数类型 描述 recall JSON Array 训练作业模型单个分类召回率。 precision JSON Array 训练作业模型单个分类精确率。 accuracy JSON Array 训练作业模型单个分类准确率。 表8 total_metric属性列表 参数 参数类型 描述 total_metric_meta JSON Array 预留字段。 total_reserved_data JSON Array 预留字段。 total_metric_values JSON Array 训练作业模型总测评参数指标。 表9 total_metric_values属性列表 参数 参数类型 描述 f1_score Float 训练作业模型总召回。 recall Float 训练作业模型总召回率。 precision Float 训练作业模型总精确率。 accuracy Float 训练作业模型总准确率。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式一：根据指定的job_id和version_id查询 1 2 3 4 5 6 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() estimator = Estimator(modelarts_session=session, job_id="182626", version_id="278813") job_info = estimator.get_job_info() print(job_info)

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式1：根据导入模型或模型调试生成的模型对象进行模型对象删除 1 2 3 4 5 6 from modelarts.session import Session from modelarts.model import Model session = Session() model_instance = Model(session, model_id="your_model_id") model_instance.delete_model() 方式2：根据查询模型对象列表返回的模型对象进行模型删除 1 2 3 4 5 6 7 from modelarts.session import Session from modelarts.model import Model session = Session() model_object_list = Model.get_model_object_list(session) model_instance = model_object_list[0] model_instance.delete_model()

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() engine_list = Estimator.get_framework_list(modelarts_session=session) print(engine_list)

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() job_config_instance_list = Estimator.get_job_configs_object_list(modelarts_session=session, is_show=True, per_page=10, page=1, sort_by="create_time", order="asc", search_content="configname") print(job_config_instance_list)

参数说明 表1 get_job_configs_object_list请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法见Session鉴权。 per_page 否 Integer 指定每一页展示作业参数的总量，默认为“10”，“per_page”可选的范围为[1，1000]。 page 否 Integer 指定要查询页的索引，默认为“1”。 sortBy/sort_by 否 String 当使用AK/SK认证方式时，参数名为sortBy；当使用用户名密码认证方式时，参数名为sort_by。指定查询的排序方式，默认是作业名称“job_name”，目前支持的排序还有作业描述“job_desc”，作业状态“status”，运行时长“duration”，引擎类型“engine_type”以及创建时间 “create_time”。 order 否 String 可选值有： “asc”为递增排序，默认为“asc”。 “desc”为递减排序。 search_content 否 String 指定要查询的文字信息，例如参数名称。默认为空。 is_show 否 Boolean 是否打印训练作业参数列表，默认为“True”。 “get_job_configs_object_list”成功响应后返回训练对象列表，其中列表中的每个元素参数请参见表2。 表2 TrainingJob对象描述 参数 类型 描述 TrainingJob Object 训练对象。该对象包含config_name等属性，及对训练作业参数的查询、删除等操作，如可通过job_config_instance.config_name获取训练作业参数名称。

参数说明 表1 参数说明 参数 是否必选 参数类型 描述 data_type 是 String 当前支持三种格式：files、images、json， 即文本、图片、json格式。 data 是 String 针对files、images类型的数据， 该参数为其本地路径，如 : data = "/home/ma-user/work/test.jpg" 针对json类型的数据， 该参数可以是其本地路径，如： data = "/home/ma-user/work/test.json" 同时也可以为“dict”类型的变量 ，如： data = { "is_training": "False", "observations": [[1,2,3,4]], "default_policy/eps:0" : "0.0" } path 否 String 服务内的推理路径，默认为"/"。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 场景：部署在线服务Predictor的推理预测 1 2 3 4 5 6 7 from modelarts.session import Session from modelarts.model import Predictor session = Session() predictor_instance = Predictor(session, service_id="your_service_id") predict_result = predictor_instance.predict(data=data_path, data_type=data_type) print(predict_result)

示例代码 在保存Manifest文件之前需要先创建包含Manifest信息的对象，包括Sample样本信息及其标签信息Annotation，然后将若干个样本组成Manifest。保存的时候调用save接口，将session信息传入，即可保存到指定路径。 from modelarts.dataset.format.manifest.annotation import Annotation from modelarts.dataset.format.manifest import Manifest from modelarts.dataset.format.manifest.sample import Sample from modelarts.session import Session size = 0 sample_list = [] for i in range(19): size = size + 1 source = "s3://obs-path/examples/image-classification/data/image_" + str(i) + ".jpg" usage = "TRAIN" inference_loc = "s3://obs-path/examples/image-classification/data/image_" + str(i) + ".txt" annotations_list = [] for j in range(1): annotation_type = "modelarts/image_classification" if 0 == i % 2: annotation_name = "Bees" else: annotation_name = "Rabbits" annotation_creation_time = "2019-02-20 08:23:06" annotation_format = "manifest" annotation_property = {"color": "black"} annotation_confidence = 0.8 annotated_by = "human" annotations_list.append( Annotation(name=annotation_name, type=annotation_type, confidence=annotation_confidence, creation_time=annotation_creation_time, annotated_by=annotated_by, annotation_format=annotation_format, annotation_property=annotation_property)) sample_list.append( Sample(source=source, usage=usage, annotations=annotations_list, inference_loc=inference_loc)) manifest_info = Manifest(samples=sample_list, size=size) path = "obs://your-obs-bucket/manifest/V001.manifest" session = Session() manifest_info.save(path, session=session, save_mode="a")

参数说明 表1 get_job_list请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法请参见Session鉴权。 status 否 Integer 作业状态的查询，默认为所有状态。例如查看创建失败的作业，可选值为3、5、6、13。详细作业状态列表请参见作业状态参考。 per_page 否 Integer 指定每一页展示作业的总量，默认为“10”，可选的范围为[1，1000]。 page 否 Integer 指定要查询页的索引，默认为“1”。 sortBy/sort_by 否 String 当使用AK/SK认证方式时，参数名为“sortBy”；当使用帐户认证方式时，参数名为“sort_by”。指定查询的排序方式，默认是作业名称“job_name”，目前支持的排序还有作业描述“job_desc”，作业状态“status”，运行时长“duration”，引擎类型“engine_type”以及创建时间 “create_time”。 order 否 String 可选值有： “asc”为递增排序。 “desc”为递减排序,默认为“desc”。 search_content 否 String 指定要查询的文字信息，例如训练作业名字，默认为空，字符串的长度为[0，100]。 表2 get_job_list返回参数说明 参数 参数类型 描述 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 job_total_count Integer 查询到的用户创建作业总数。 job_count_limit Integer 用户还可以创建训练作业的数量。 is_success Boolean 接口调用是否成功。 quotas Integer 训练作业的最大运行数量。 jobs JSON Array 训练作业的属性列表，具体请参见表3。 表3 jobs属性列表 参数 参数类型 描述 job_id Long 训练作业的ID。 job_name String 训练作业的名称。 version_id Long 训练作业的版本ID。 status Byte 训练作业的运行状态，详细作业状态列表请参见作业状态参考。 create_time Long 训练作业的创建时间，时间戳格式。 duration Long 训练作业的运行时长，单位为毫秒。 job_desc String 训练作业的具体描述。 version_count Long 训练作业的版本数。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() job_list_info = Estimator.get_job_list(modelarts_session=session, status=8, per_page=10, page=1, order="asc", search_content="job") print(job_list_info)

参数说明 表1 get_visualization_job_list请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法见Session鉴权。 status 否 String 可视化作业的运行状态，详细作业状态列表请查看作业状态参考。 per_page 否 Integer 指定每一页展示作业的总量，默认为“10”，“per_page”可选的范围为[1，100]。 page 否 Integer 指定要查询页的索引，默认为“1”。 sortBy/sort_by 否 String 当使用AK/SK认证方式时，参数名为sortBy；当使用用户名密码认证方式时，参数名为sort_by。指定查询的排序方式，默认是作业名称“job_name”，目前支持的排序还有作业描述“job_desc”，作业状态“status”，运行时长“duration”以及创建时间 “create_time”，日志存储目录“log_dir”。 order 否 String 可选值。 “asc”为递增排序，默认为“asc”。 “desc”为递减排序。 search_content 否 String 指定要查询的文字信息，例如可视化作业名字，默认为空，字符串的长度为[0，100]。 表2 get_visualization_job_list返回参数说明 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 job_total_count Integer 查询的可视化作业总数。 job_count_limit Integer 用户还可以创建可视化作业的数量。 jobs JSON Array 可视化作业的属性列表，具体请参见表3。 表3 jobs属性列表 参数 参数类型 描述 job_id Integer 可视化作业ID。 job_name String 可视化作业的名称。 status Integer 可视化作业的运行状态，详细作业状态列表请参见作业状态参考。 create_time Long 可视化作业的创建时间。 duration Long 可视化作业的运行时长，单位为毫秒。 job_desc String 可视化作业的具体描述。 service_url String 可视化作业的endpoint。 train_url String 可视化作业的日志存储路径。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import VisualizationJob session = Session() job_list = VisualizationJob.get_visualization_job_list(modelarts_session=session, status=8, per_page=10, page=1, sort_by="create_time", order="asc", search_content="job") print(job_list)

参数说明 表1 get_model_info返回参数说明 参数 参数类型 描述 model_id String 模型ID。 model_name String 模型名称。 model_version String 模型版本。 tenant String 租户。 project String 项目。 owner String 用户。 create_at Long 模型创建时间，距'1970.1.1 0:0:0 UTC'的毫秒数。 source_location String 模型所在的OBS路径。 source_job_id String 来源训练作业的ID。 source_job_version String 来源训练作业的版本。 source_type String 模型来源的类型。 当模型为自动学习部署过来时，取值为“auto”。 当模型是用户通过训练作业或OBS模型文件部署时，此值为空。 model_type String 模型类型，取值为：TensorFlow/MXNet/Spark_MLlib/Scikit_Learn/XGBoost/MindSpore/Image/PyTorch。 model_size Long 模型大小，单位为字节数。 model_status String 模型状态，取值为：publishing/published/failed。 description String 模型描述信息。 execution_code String 执行代码存放的OBS地址，名称固定为“customize_service.py”。 schema_doc String 模型schema文档的下载地址。 image_address String 模型的执行镜像地址，镜像未构建之前（即当前模型从未发布成服务），显示为空。 input_params params结构数组 模型的输入参数集，默认为空 output_params params结构数组 模型的输出参数集，默认为空 dependencies dependency结构数组 运行代码及模型需安装的包。 model_metrics String 模型评测参数，仅当source_job_id和source_job_version有值且对应的训练作业有评测结果时会返回该结果。 apis String 模型所有的apis入参出参信息。 表2 params结构 参数 参数类型 描述 url String api代表的url路径。 param_name String 参数名，不超过64个字符。 param_type String 参数类型，取值为：int/string/float/timestamp/date/file。 min Number 当param_type为int或float时创建模型时，有配置min则返回，默认为空。 max Number 当param_type为int或float时创建模型时，有配置max则返回，默认为空。 param_desc String 参数描述，不超过100个字符，默认为空。 表3 dependency结构 参数 参数类型 描述 installer String 安装器名称。 packages package结构数组 依赖包集合。 表4 package结构 参数 参数类型 描述 package_name String 依赖包名称。 package_version String 依赖包版本。 restraint String 版本过滤条件，取值为： EXACT：等于给定版本 ATLEAST：不小于给定版本 ATMOST：不大于给定版本 表5 metric参数说明 参数 是否必选 参数类型 描述 f1 是 Double 平均数。 recall 是 Double 召回率。 precision 是 Double 精确率。 accuracy 是 Double 准确率。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式1：根据导入模型生成的模型对象进行模型详情查询 1 2 3 4 5 6 7 from modelarts.session import Session from modelarts.model import Model session = Session() model_instance = Model(session, model_id="your_model_id") model_info = model_instance.get_model_info() print(model_info) 方式2：根据查询模型对象列表返回的模型对象进行模型详情查询 1 2 3 4 5 6 7 8 from modelarts.session import Session from modelarts.model import Model session = Session() model_object_list = Model.get_model_object_list(session) model_instance = model_object_list[0] model_info = model_instance.get_model_info() print(model_info)

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() algo_info = Estimator.get_train_instance_types(modelarts_session=session) print(algo_info)

参数说明 表1 create_visualization_job请求参数 参数 是否必选 参数类型 描述 job_name 否 String 可视化作业名称。限制为1-20位只含数字，字母，下划线，中划线的名称。 job_desc 否 String 对可视化作业的描述，默认为空，字符串的长度限制为[0, 256]。 train_url 是 String OBS路径地址。可视化文件路径，提供给可视化作业读取显示的可视化文件，通常位于训练作业的训练输出位置，在训练代码中使用“tf.summary”或“tensorboardx.SummaryWriter”等模块生成，文件名通常以“events.out.tfevents”开头。 表2 create_visualization_job成功响应说明 参数 类型 描述 VisualizationJob Object 可视化作业对象。该对象包含visualization_id、create_time、job_name、status属性，及对可视化作业的查询、更新、停止、重启和删除等操作。 表3 VisualizationJob属性说明 参数 参数类型 描述 create_time Long 可视化作业的创建时间。 job_name String 可视化作业的名称。 status Byte 可视化训练作业的运行状态，详细作业状态列表请参见作业状态参考。 job_id String 可视化作业ID。 is_success Boolean 接口调用是否成功。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import VisualizationJob session = Session() job = VisualizationJob(modelarts_session=session) job_visualization_instance = job.create_visualization_job(train_url='/bucket/train/', job_name='visualization_job', job_desc='my visualization job')

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式一：根据指定的job_id更新 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() estimator = Estimator(modelarts_session=session, job_id="182626") job_description = estimator.update_job_description(description='update description') 方式二：根据创建训练作业生成的训练作业对象更新 1 job_description = job_instance.update_job_description(description='update description') 方式三：根据查询训练作业版本列表返回的指定训练作业版本对象更新 1 job_description = job_version_instance_list[0].update_job_description(description='update description')

参数说明 表1 Estimator请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法请参见Session鉴权。 job_id 是 String 训练作业的ID。job_id可通过创建训练作业生成的训练作业对象查询，如“job_instance.job_id”。或可通过查询训练作业列表的响应获取。 表2 update_job_description请求参数说明 参数 是否必选 参数类型 描述 description 是 String 需要更改的训练作业的描述信息。 表3 update_job_description返回参数说明 参数 参数类型 描述 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 is_success Boolean 接口调用是否成功。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 场景1：查询当前用户所有服务对象 1 2 3 4 5 6 from modelarts.session import Session from modelarts.model import Predictor session = Session() predictor_list_object_resp = Predictor.get_service_object_list(session) print(predictor_list_object_resp) 场景2：按照检索条件查询当前用户服务对象 1 2 3 4 5 6 from modelarts.session import Session from modelarts.model import Predictor session = Session() predictor_object_list = Predictor.get_service_object_list(session, service_name="digit", order="asc", offset="0", infer_type="real-time") print(predictor_object_list)

参数说明 查询服务列表，返回list，list大小等于当前用户所有已经部署的服务个数，list中每个元素都是Predictor对象，对象属性同本章初始化服务。 查询服务列表返回说明：service_list_resp = [service_instance1, service_instance2, service_instance3 ...]，列表中元素“service_instance”对象即为服务管理章节描述的可调用服务接口。 支持按照检索参数查询服务列表，返回满足检索条件的服务list，检索参数如表1所示。 在查询列表时，返回list的同时，默认会打印模型列表的详细信息，如表2和表3所示。 表1 查询检索参数说明 参数 是否必选 参数类型 描述 session 是 Object 会话对象，初始化方法见Session鉴权。 is_show 否 Boolean 是否打印出服务对象信息，默认为“True”。 service_id 否 String 服务ID，默认不过滤服务ID。 service_name 否 String 服务名称，默认不过滤服务名。 infer_type 否 String 推理方式，取值为：real-time/batch/edge，默认不过滤推理方式。 offset 否 Integer 分页列表的起始页，默认为“0”。 limit 否 Integer 指定每一页返回的最大条目数，默认为“1000”。 sort_by 否 String 指定排序字段，可选“publish_at”、“service_name”，默认可选“publish_at”。 order 否 String 排序方式，可选“asc”或“desc”，代表递增排序及递减排序，默认为：“desc”。 model_id 否 String 模型ID，默认不过滤模型ID。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式一： 根据指定的config_name删除 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() estimator = Estimator(modelarts_session=session, config_name="my_job_config") status = estimator.delete_job_configs() 方式二： 根据创建训练作业参数生成的训练作业版本对象删除 1 status = job_config_instance.delete_job_configs() 方式三： 根据查询训练作业参数对象列表返回的指定训练作业版本对象删除 1 status = job_config_instance_list[0].delete_job_configs()

参数说明 表1 Estimator请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法见Session鉴权。 config_name 是 String 训练作业参数名称。 表2 delete_job_configs返回参数说明 参数 参数类型 描述 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 is_success Boolean 接口调用是否成功。

参数说明 表1 VisualizationJob请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法见Session鉴权。 visualization_id 是 String 可视化作业ID。 表2 get_visualization_job_info返回参数说明 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 job_name String 可视化作业的名称。 service_url String 可视化作业的endpoint。 is_success Boolean 接口调用是否成功。 duration Long 可视化训练作业的运行时间。 create_time Long 可视化训练作业的创建时间。 train_url String 可视化训练作业输出文件OBS路径。 job_id Long 可视化训练作业的ID。 job_desc String 可视化训练作业的描述信息。 resource_id String 可视化训练作业的资源ID。 status Integer 可视化作业的运行状态，详细作业状态列表请参见作业状态参考。