查询训练作业指定任务的运行指标
功能介绍
查询训练作业指定任务的运行指标接口用于获取ModelArts平台上指定训练作业任务的运行指标。
该接口适用于以下场景:当用户需要查看特定训练任务的性能指标时,可以通过此接口获取运行指标。使用该接口的前提条件是用户已知训练作业ID和任务ID,并具有查看运行指标的权限。查询操作完成后,平台将返回包含任务的性能指标信息。若训练作业ID或任务ID不存在、任务未生成指标或用户无权限操作,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/training-jobs/{training_job_id}/metrics/{task_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:1 - 64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
training_job_id |
是 |
String |
参数解释:训练作业ID。 约束限制:获取方法请参见查询训练作业列表。 取值范围:不涉及。 默认取值:不涉及。 |
task_id |
是 |
String |
参数解释:训练作业的任务名称。可从训练作业详情中的status.tasks字段中获取。 约束限制:单节点默认为"worker-0",多节点则为"worker-0"、"worker-1",依次类推。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
请求示例
如下以查询uuid为2cd88daa-31a4-40a8-a58f-d186b0e93e4f的训练作业对应worker-0运行指标为例
GET https://endpoint/v2/{project_id}/training-jobs/2cd88daa-31a4-40a8-a58f-d186b0e93e4f/metrics/worker-0
响应示例
状态码:200
ok
{ "metrics" : [ { "metric" : "cpuUsage", "value" : [ -1, -1, 2.43, 4.524, 6.714, 12.422, 9.214, 5.36, 7.5, 10.088, 8.975, 11.423, 11.548, 14.563, 16.833 ] }, { "metric" : "memUsage", "value" : [ -1, -1, 0.04, 0.521, 1.652, 4.252, 6.433, 7.384, 7.982, 8.718, 9.365, 9.881, 10.192, 9.994, 9.005 ] }, { "metric" : "gpuUtil", "value" : [ -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 ] }, { "metric" : "gpuMemUsage", "value" : [ -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 ] }, { "metric" : "npuUtil", "value" : [ -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 ] }, { "metric" : "npuMemUsage", "value" : [ -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 ] } ] }
状态码
状态码 |
描述 |
---|---|
200 |
ok |
错误码
请参见错误码。