更新时间:2022-09-22 GMT+08:00
分享

查询模型详情

功能介绍

查询模型详情,根据模型ID查询模型的详细信息。

URI

GET /v1/{project_id}/models/{model_id}

参数说明如表1所示。
表1 参数说明

参数

是否必选

参数类型

说明

project_id

String

用户项目ID。获取方法请参见获取项目ID和名称

model_id

String

模型ID。

请求消息

无请求参数。

响应消息

响应参数如表2所示。
表2 参数说明

参数

参数类型

说明

model_id

String

模型ID。

model_name

String

模型名称。

model_version

String

模型版本。

create_at

Long

模型创建时间,距'1970.1.1 0:0:0 UTC'的毫秒数。

tenant

String

模型归属租户。

project

String

模型归属项目。

owner

String

模型归属用户。

source_location

String

模型所在的OBS路径或SWR镜像地址。

source_copy

String

镜像复制开关,仅当“model_type”“Image”时有效。

取值范围:

  • true:表示复制镜像模式,无法极速创建AI应用,SWR源目录中的镜像更改或删除不影响服务部署。
  • false:表示不复制镜像模式,可极速创建AI应用,更改或删除SWR源目录中的镜像会影响服务部署。

不设置值时,默认为复制镜像模式。

source_job_id

String

来源训练作业的ID。

source_job_version

String

来源训练作业的版本。

model_type

String

模型类型,取值为TensorFlow/MXNet/Spark_MLlib/Scikit_Learn/XGBoost/MindSpore/Image/PyTorch。

model_size

Long

模型大小,单位为字节数。

model_status

String

模型状态。

runtime

String

模型运行时环境。

description

String

模型描述信息。

execution_code

String

执行代码存放的OBS地址,名称固定为“customize_service.py”

image_address

String

模型打包后的镜像地址。

input_params

params结构数组

模型的输入参数集,params结构如表3所示。

output_params

params结构数组

模型的输出参数集,params结构如表3所示。

dependencies

dependency结构数组

运行代码及模型需安装的包,dependency结构如表4所示。

model_metrics

String

模型精度信息。

apis

String

模型所有的apis入参出参信息(从模型预览中获取)。

model_source

String

模型来源。

  • auto:自动学习
  • algos:预置算法
  • custom:自定义

tunable

boolean

标识模型是否支持二次调优。

  • true:支持
  • false:不支持

market_flag

boolean

标识模型是否来自市场。

  • true:来自市场
  • false:不来自市场

publishable_flag

boolean

标识模型是否可发布至市场。

  • true:可以发布至市场
  • false:不可以发布至市场

model_docs

GuideDoc结构数组

模型文档列表。GuideDoc结构如表7所示。

model_algorithm

String

模型算法类型,如“predict_analysis”“object_detection”“image_classification”

model_labels

String数组

模型标签数组。

labels_map

Object

模型标签Map,key固定为labels,value为模型标签数组。

workspace_id

String

服务所属的工作空间ID,默认为“0”,代表默认工作空间。

install_type

String数组

支持部署服务类型。

config

String

模型配置参数。

health

Object

模型健康检查配置,见表8

schema_doc

String

模型schema文档的下载地址。

source_type

String

模型来源的类型,仅当模型为自动学习部署过来时有值,取值为auto。

specification

Object

模型最小规格配置,见表9

表3 params结构

参数

参数类型

说明

url

String

API代表的URL路径。

method

String

请求方法,如post。

protocol

String

请求协议,如http。

param_name

String

参数名,不超过64个字符。

param_type

String

参数类型,取值为int/string/float/timestamp/date/file。

min

Number

当param_type为int或float时可选填,默认为空。

max

Number

当param_type为int或float时可选填,默认为空。

param_desc

String

参数描述,不超过100个字符,默认为空。

表4 dependency结构

参数

参数类型

说明

installer

String

安装器名称。

packages

package结构数组

依赖包集合,package结构如表5所示。

表5 package结构

参数

参数类型

说明

package_name

String

依赖包名称。

package_version

String

依赖包版本。

restraint

String

版本限制条件,取值为EXACT/ATLEAST/ATMOST。

表6 metric参数说明

参数

参数类型

说明

f1

Double

平均数。

recall

Double

召回率。

precision

Double

精确率。

accuracy

Double

准确率。

表7 GuideDoc参数说明

参数

参数类型

说明

doc_name

String

文档名称。

doc_url

String

文档http(s)链接。

表8 Health参数说明

参数

参数类型

说明

url

String

健康检查接口路径。

protocol

String

健康检查接口请求协议,当前仅支持http。

initial_delay_seconds

String

实例启动后,延迟initial_delay_seconds秒再执行健康检查。

timeout_seconds

String

健康检查超时时间。

表9 Specification参数说明

参数

参数类型

说明

min_cpu

String

最小cpu。

min_gpu

String

最小gpu。

min_memory

String

最小内存。

min_ascend

String

最小Ascend。

请求示例

如下以根据模型ID查询模型详情为例,返回模型详细信息。

GET    https://endpoint/v1/{project_id}/models/{model_id}

响应示例

{
"model_id": "10eb0091-887f-4839-9929-cbc884f1e20e",
"model_name": "mnist",
"model_version": "1.0.0",
"runtime": "python2.7",
"tenant": "6d28e85aa78b4e1a9b4bd83501bcd4a1",
"project": "d04c10db1f264cfeb1966deff1a3527c",
"owner": "6d28e85aa78b4e1a9b4bd83501bcd4a1",
"source_location": "https://models.obs.cn-north-4.myhuaweicloud.com/mnist",
"model_type": "TensorFlow",
"model_size": 5633481,
"model_status": "published",











"execution_code": "https://testmodel.obs.cn-north-4.myhuaweicloud.com/customize_service.py",
"image_address": "100.125.5.235:20202/models/10eb0091-887f-4839-9929-cbc884f1e20e:1.0.0",
"input_params": [{           
     "url": "/",           
     "method": "post",           
     "protocol": "http",           
     "param_name": "data",           
     "param_type": "object",           
     "param_desc": "{\"type\":\"object\",\"properties\":{\"req_data\":{\"items\":[{\"type\":\"object\",\"properties\":{}}],\"type\":\"array\"}}}"       }],
"output_params": [{           
     "url": "/",           
     "method": "post",           
     "protocol": "http",           
     "param_name": "data",           
     "param_type": "object",           
     "param_desc": "{\"type\":\"object\",\"properties\":{\"resp_data\":{\"type\":\"array\",\"items\":[{\"type\":\"object\",\"properties\":{}}]}}}"       }],
"dependencies": [{
    "installer": "pip",
    
    "packages": [{
        "package_name": "pkg1",
        "package_version": "1.0.1",
        "restraint": "ATLEAST"
    }]
}],
"model_metrics":"{\"f1\":0.52381,\"recall\":0.666667,\"precision\":0.466667,\"accuracy\":0.625}",
"apis": "[{\"protocol\":\"http\",\"method\":\"post\",\"url\":\"/\",\"input_params\":{\"type\":\"object\",\"properties\":{\"data\":{\"type\":\"object\",\"properties\":{\"req_data\":{\"items\":[{\"type\":\"object\",\"properties\":{}}],\"type\":\"array\"}}}}},\"output_params\":{\"type\":\"object\",\"properties\":{\"data\":{\"type\":\"object\",\"properties\":{\"resp_data\":{\"type\":\"array\",\"items\":[{\"type\":\"object\",\"properties\":{}}]}}}}}}]",
"model_labels":[],
"labels_map":{"labels":[]},
"workspace_id": "0",
"install_type": ["realtime", "batch", "edge"],
"specification":{},
"config":"{\"model_algorithm\": \"image_classification\", \"model_source\": \"auto\", \"tunable\": false, \"downloadable_flag\": true, \"algorithm\": \"resnet_v2_50,mobilenet_v1\", \"metrics\": {\"f1\": 0.912078373015873, \"recall\": 0.9125, \"precision\": 0.9340277777777778, \"accuracy\": 0.263250724969475}, \"model_type\": \"TensorFlow\", \"runtime\": \"tf1.13-python3.6-cpu\", \"apis\": [{\"protocol\": \"https\", \"url\": \"/\", \"method\": \"post\", \"request\": {\"data\": {\"type\": \"object\", \"properties\": {\"images\": {\"type\": \"file\"}}}, \"Content-type\": \"multipart/form-data\"}, \"response\": {\"data\": {\"type\": \"object\", \"required\": [\"predicted_label\", \"scores\"], \"properties\": {\"predicted_label\": {\"type\": \"string\"}, \"scores\": {\"type\": \"array\", \"items\": {\"type\": \"array\", \"minItems\": 2, \"maxItems\": 2, \"items\": [{\"type\": \"string\"}, {\"type\": \"number\"}]}}}}, \"Content-type\": \"multipart/form-data\"}}], \"dependencies\": [{\"installer\": \"pip\", \"packages\": [{\"package_name\": \"numpy\", \"package_version\": \"1.17.0\", \"restraint\": \"EXACT\"}, {\"package_name\": \"h5py\", \"package_version\": \"2.8.0\", \"restraint\": \"EXACT\"}, {\"package_name\": \"Pillow\", \"package_version\": \"5.2.0\", \"restraint\": \"EXACT\"}, {\"package_name\": \"scipy\", \"package_version\": \"1.2.1\", \"restraint\": \"EXACT\"}, {\"package_name\": \"resampy\", \"package_version\": \"0.2.1\", \"restraint\": \"EXACT\"}, {\"package_name\": \"scikit-learn\", \"package_version\": \"0.19.1\", \"restraint\": \"EXACT\"}]}]}"
}

状态码

状态码请参见表1

分享:

    相关文档

    相关产品

close