7.4.1 创建可视化作业
示例代码
在ModelArts notebook平台中，Session鉴权无需输入鉴权参数。其它平台的Session 鉴权请参见Session鉴权。
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')
参数说明
表7-66 create_visualization_job 请求参数
参数 是否必选 参数类型 描述
job_name 否 String 可视化作业名称。限制为1-20位只含数 字，字母，下划线，中划线的名称。
job_desc 否 String 对可视化作业的描述，默认为空，字符 串的长度限制为[0, 256]。
train_url 是 String OBS路径地址。可视化文件路径，提供给 可视化作业读取显示的可视化文件，通 常位于训练作业的训练输出位置，在训 练代码中使用“tf.summary”或
“tensorboardx.SummaryWriter”等模 块生成，文件名通常以
“events.out.tfevents”开头。
表7-67 create_visualization_job 成功响应说明
参数 类型 描述
VisualizationJob Object 可视化作业对象。该对象包含 visualization_id、create_time、
job_name、status属性，及对可视化作业 的查询、更新、停止、重启和删除等操 作。
表7-68 VisualizationJob 属性说明
参数 参数类型 描述
create_time Long 可视化作业的创建时间。
job_name String 可视化作业的名称。
参数 参数类型 描述
status Byte 可视化训练作业的运行状态，详细
作业状态列表请参见作业状态参
考。
job_id String 可视化作业ID。
is_success Boolean 接口调用是否成功。
7.4.2 查询可视化作业对象列表
示例代码
在ModelArts notebook平台中，Session鉴权无需输入鉴权参数。其它平台的Session 鉴权请参见Session鉴权。
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)
参数说明
表7-69 get_visualization_job_object_list 请求参数说明
参数 是否必
选
参数类型 描述
modelarts_sessi
on 是 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”。
表7-70 get_visualization_job_object_list 成功响应后返回可视化作业对象列表，其中 列表中的每个元素参数说明如下：
参数 类型 描述
VisualizationJob Object 可视化作业对象。该对象包含 visualization_id、create_time、
job_name、status属性，及对可视化作业 的查询、更新、停止、重启和删除等操 作。
表7-71 VisualizationJob 属性说明
参数 参数类型 描述
create_time Long 可视化作业的创建时间。
job_name String 可视化作业的名称。
status Byte 可视化训练作业的运行状态，详细作业状
态列表请参见作业状态参考。
job_id String 可视化作业ID。
is_success Boolean 接口调用是否成功。
7.4.3 查询可视化作业列表
示例代码
在ModelArts notebook平台中，Session鉴权无需输入鉴权参数。其它平台的Session 鉴权请参见Session鉴权。
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)
参数说明
表7-72 get_visualization_job_list 请求参数说明
参数 是否必
选
参数类型 描述
modelarts_sessi
on 是 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]。
表7-73 get_visualization_job_list 返回参数说明
参数 参数类型 描述
error_code String 调用失败时的错误码，具体请参见错误
码。
调用成功时无此字段。
error_msg String 调用失败时的错误信息。
调用成功时无此字段。
job_total_count Integer 查询的可视化作业总数。
参数 参数类型 描述
job_count_limit Integer 用户还可以创建可视化作业的数量。
jobs JSON Array 可视化作业的属性列表，具体请参见表 7-74。
表7-74 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 可视化作业的日志存储路径。
7.4.4 查询可视化作业详情
示例代码
在ModelArts notebook平台中，Session鉴权无需输入鉴权参数。其它平台的Session 鉴权请参见Session鉴权。
● 方式一： 根据指定的visualization_id查询
from modelarts.session import Session
from modelarts.estimator import VisualizationJob session = Session()
job = VisualizationJob(modelarts_session=session, visualization_id='8992') job_info = job.get_visualization_job_info()
print(job_info)
● 方式二： 根据创建可视化作业生成的可视化作业对象查询
job_info = job_visualization_instance.get_visualization_job_info() print(job_info)
● 方式三： 根据查询可视化作业对象列表返回的指定可视化作业对象查询
job_info = job_visualization_instance_list[0].get_visualization_job_info() print(job_info)
参数说明
表7-75 VisualizationJob 请求参数说明
参数 是否
必选 参数类型 描述 modelarts_sessi
on 是 Object 会话对象，初始化方法见Session鉴权。
visualization_id 是 String 可视化作业ID。
表7-76 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 可视化作业的运行状态，详细作业状态列表 请参见作业状态参考。
7.4.5 更新可视化作业描述
示例代码
在ModelArts notebook平台中，Session鉴权无需输入鉴权参数。其它平台的Session 鉴权请参见Session鉴权。
● 方式一： 根据指定的visualization_id更新
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')
● 方式二： 根据创建可视化作业生成的可视化作业对象更新
job_description = job_visualization_instance.update_visualization_job(job_desc='update visualization job')
● 方式三： 根据查询可视化作业对象列表返回的指定可视化作业对象更新
job_description = job_visualization_instance_list[0].update_visualization_job(job_desc='update visualization job')
参数说明
表7-77 VisualizationJob 请求参数说明
参数 是否
必选
参数类型 描述
modelarts_sessi
on 是 Object 会话对象，初始化方法见Session鉴权。
visualization_id 是 String 可视化作业ID。
表7-78 update_visualization_job 请求参数说明
参数 是否
必选
参数类 型
描述
job_desc 是 String 对可视化作业的描述，字符串的长度限制为 [0，256]。
表7-79 update_visualization_job 返回参数说明
参数 参数类型 描述
error_msg String 调用失败时的错误信息。
调用成功时无此字段。
error_code String 调用失败时的错误码，具体请参见错误码。
调用成功时无此字段。
is_success Boolean 接口调用是否成功。
7.4.6 停止可视化作业
示例代码
在ModelArts notebook平台中，Session鉴权无需输入鉴权参数。其它平台的Session 鉴权请参见Session鉴权。
● 方式一： 根据指定的visualization_id停止
from modelarts.session import Session
from modelarts.estimator import VisualizationJob session = Session()
job = VisualizationJob(modelarts_session=session, visualization_id='8992') status = job.stop_visualization_job()
● 方式二： 根据创建可视化作业生成的可视化作业对象停止
status = job_visualization_instance.stop_visualization_job()
● 方式三： 根据查询可视化作业对象列表返回的指定可视化作业对象停止
status = job_visualization_instance_list[0].stop_visualization_job()
参数说明
表7-80 VisualizationJob 请求参数说明
参数 是否
必选
参数类型 描述
modelarts_sessi
on 是 Object 会话对象，初始化方法见Session鉴权。
visualization_id 是 String 可视化作业ID。
表7-81 stop_visualization_job 返回参数说明
参数 参数类型 描述
error_code String 调用失败时的错误码，具体请参见错误码。
调用成功时无此字段。
error_msg String 调用失败时的错误信息。
调用成功时无此字段。
is_success Boolean 接口调用是否成功。
7.4.7 重启可视化作业
示例代码
在ModelArts notebook平台中，Session鉴权无需输入鉴权参数。其它平台的Session 鉴权请参见Session鉴权。
● 方式一： 根据指定的visualization_id重启
from modelarts.session import Session
from modelarts.estimator import VisualizationJob session = Session()
job = VisualizationJob(modelarts_session=session, visualization_id='8992') resp = job.restart_visualization_job()
● 方式二： 根据创建可视化作业生成的可视化作业对象重启
status = job_visualization_instance.restart_visualization_job()
● 方式三： 根据查询可视化作业对象列表返回的指定可视化作业对象重启
status = job_visualization_instance_list[0].restart_visualization_job()
参数说明
表7-82 VisualizationJob 请求参数说明
参数 是否
必选
参数类型 描述
modelarts_sessi
on 是 Object 会话对象，初始化方法见Session鉴权。
visualization_id 是 String 可视化作业ID。
表7-83 restart_visualization_job 返回参数说明
参数 参数类型 描述
error_code String 调用失败时的错误码，具体请参见错误码。
调用成功时无此字段。
error_msg String 调用失败时的错误信息。
调用成功时无此字段。
is_success Boolean 接口调用是否成功。
7.4.8 删除可视化作业
示例代码
在ModelArts notebook平台中，Session鉴权无需输入鉴权参数。其它平台的Session 鉴权请参见Session鉴权。
● 方式一： 根据指定的visualization_id删除
from modelarts.session import Session
from modelarts.estimator import VisualizationJob session = Session()
job = VisualizationJob(modelarts_session=session, visualization_id='8992') status = job.delete_visualization_job()
● 方式二： 根据创建可视化作业生成的可视化作业对象删除
status = job_visualization_instance.delete_visualization_job()
● 方式三： 根据查询可视化作业对象列表返回的指定可视化作业对象删除
status = job_visualization_instance_list[0].delete_visualization_job()
参数说明
表7-84 VisualizationJob 请求参数说明
参数 是否
必选
参数类型 描述
modelarts_sessi
on 是 Object 会话对象，初始化方法见Session鉴权。
visualization_id 是 String 可视化作业ID。
表7-85 delete_visualization_job 返回参数说明
参数 参数类型 描述
error_code String 调用失败时的错误码，具体请参见错误码。
调用成功时无此字段。
error_msg String 调用失败时的错误信息。
调用成功时无此字段。
is_success Boolean 接口调用是否成功。