GetHpoTrial - 获取一个HPO实验里一个指定Trial的信息_人工智能平台 PAI(PAI)-阿里云帮助中心

获取一个HPO实验里一个指定Trial的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
paiautoml:GetHpoTrial	get	全部资源 ``	无	无

请求语法

GET /api/automl/v1/hpo/experiment/{ExperimentId}/trial/{TrialId} HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ExperimentId	string	是	实验 id。	abcde
TrialId	string	是	trial id	mf99W4

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	POP 请求 id	3F190916-B3E5-5D1E-AD0C-35C0DF105F51
Code	string	内部错误码。只在响应出错时被设置。	INVALID_INPUT_PARAMS
Message	string	响应错误信息。只在响应出错时被设置。	Missing 'user_id' in request.
AccessDeniedDetail	object	访问被拒绝详细信息。
	string	访问被拒绝详细信息。	{ "AuthPrincipalType": "sub", "PolicyType": "AccountLevelIdentityBasedPolicy", "NoPermissionType": "NoPermission" }
TrialId	string	trial 的 id	mf99W4
ExperimentId	string	HPO 实验 id	abcde
Model	string	这个 Trial 所对应的后台任务生成的模型的存储位置。	model_table_name_foo
Hyperparam	string	trial 配置的超参(hyper parameter)值	{"${centerCount}": 5, "${distanceType}": "cosine"}
ParameterId	integer	trail 所对应的后台任务给这个 trial 分配的一个 id	0
Status	string	Trial 状态	FINISHED, FAILED, USER_CANCELED
MetricName	string	metric 名称。未填充，不在使用中	空字符串
Metric	string	trial 计算 metric 的结果数组。包括一个或多个计算过程中产生的临时值，和一个最终值。	[{"default":0.087745,"val_loss=([0-9\\\\.]+)":0.087745}, {"default":1.085841,"val_loss=([0-9\\\\.]+)":0.085841}, {"default":0.087745,"type":"FINAL","val_loss=([0-9\\\\.]+)":0.087745}]
JobMeta	string	trial 所对应的后台任务的 meta 信息。json string 格式。	{"nni_trial_id": "asdf", "nni_exp_id": "abcde", "nni_trial_sequence_id": 2}
FinalMetric	string	trial 成功结束后，后台任务计算出的最终的 metric 值。来自 metric 数组里的 FINAL 类型的 metric 项里的 default key 所对应的值。	{"default":0.087745,"type":"FINAL","val_loss=([0-9\\\\.]+)":0.087745}
GmtCreateTime	string	Trial 创建时间 UTC time。	2024-01-02 12:34:56
GmtModifiedTime	string	Trial 最后更新时间 UTC time	2024-01-02 21:32:56

示例

正常返回示例

JSON格式

{
  "RequestId": "3F190916-B3E5-5D1E-AD0C-35C0DF105F51",
  "Code": "INVALID_INPUT_PARAMS",
  "Message": "Missing 'user_id' in request.",
  "AccessDeniedDetail": {
    "key": {
      "AuthPrincipalType": "sub",
      "PolicyType": "AccountLevelIdentityBasedPolicy",
      "NoPermissionType": "NoPermission"
    }
  },
  "TrialId": "mf99W4",
  "ExperimentId": "abcde",
  "Model": "model_table_name_foo",
  "Hyperparam": {
    "${centerCount}": 5,
    "${distanceType}": "cosine"
  },
  "ParameterId": 0,
  "Status": "FINISHED, FAILED, USER_CANCELED",
  "MetricName": "空字符串",
  "Metric": [
    {
      "default": 0.087745,
      "val_loss=([0-9\\\\.]+)": 0.087745
    },
    {
      "default": 1.085841,
      "val_loss=([0-9\\\\.]+)": 0.085841
    },
    {
      "default": 0.087745,
      "type": "FINAL",
      "val_loss=([0-9\\\\.]+)": 0.087745
    }
  ],
  "JobMeta": {
    "nni_trial_id": "asdf",
    "nni_exp_id": "abcde",
    "nni_trial_sequence_id": 2
  },
  "FinalMetric": {
    "default": 0.087745,
    "type": "FINAL",
    "val_loss=([0-9\\\\.]+)": 0.087745
  },
  "GmtCreateTime": "2024-01-02 12:34:56",
  "GmtModifiedTime": "2024-01-02 21:32:56"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-10-21	OpenAPI 返回结构发生变更	查看变更详情