获取一个HPO实验的信息，包括状态、配置、以及所属trials的状态等数据。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| paiautoml:GetHpoExperiment | get | *HpoExperiment acs:paiautoml:{#regionId}:{#accountId}:hpoexperiment/{#HpoExperimentId} |
| 无 |
请求语法
GET /api/automl/v1/hpo/experiment/{ExperimentId} HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ExperimentId | string | 否 | HPO 实验 id | sX5O9Q8 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "3F190916-B3E5-5D1E-AD0C-35C0DF105F51",
"Code": "INVALID_INPUT_PARAMS",
"Message": "Missing 'user_id' in request.",
"AccessDeniedDetail": {
"AuthPrincipalType": "sub",
"PolicyType": "AccountLevelIdentityBasedPolicy",
"NoPermissionType": "NoPermission"
},
"ExperimentId": "sX5O9Q8",
"Creator": 123456789,
"SearchSpace": {
"${centerCount}": {
"_type": "choice",
"_value": [
2,
3,
4,
5
]
},
"${distanceType}": {
"_type": "choice",
"_value": [
"euclidean",
"cosine",
"cityblock"
]
}
},
"Name": "my_hpo_exp_1",
"Status": "INVALID_USER_OR_EXP, SUCCESS, or EXECUTION_FAILURE",
"JobType": 1,
"ConfigIni": "[odps_config]\naccess_id=foo\naccess_key=bar\nend_point=http://service.odps.aliyun.com/api\nlog_view_host=http://logview.odps.aliyun.com\nproject_name=my_project",
"ConfigYml": "assessor:\n classArgs:\n optimize_mode: maximize\n start_step: 1\n name: PAIAssessor\ndebug: true\nexperimentName: maxcompute_kmeans_monitor\nexperimentWorkingDirectory: ../expdir\nlogLevel: debug\nmaxTrialNumber: 10\nsearchSpaceFile: search_space.json\ntrainingService:\n platform: local\ntrialCommand: python3 -m hpo_tools.core.utils.run --config=./config.ini\ntrialConcurrency: 2\ntuner:\n classArgs:\n optimize_mode: maximize\n name: TPE",
"GmtCreateTime": "2024-01-01 08:30:11",
"GmtModifiedTime": "2024-01-01 08:30:11",
"WorkspaceId": 12345,
"Accessibility": "PRIVATE",
"Description": "我的实验",
"TrialCount": 3,
"TrialStatus": {
"key": "{‘FINISHED':1, 'RUNNING':2}"
},
"HpoExperimentConfiguration": {
"output_config": {
"model_path": "bi_ps_${exp_id}_${trial_id}"
},
"platform_config": {
"cmd": [
"PAI -name ps_smart\n -project foo",
"PAI -name prediction\n -project foo",
"PAI -name evaluate -project foo",
"INSERT OVERWRITE TABLE my_table;"
],
"name": "MaxCompute"
},
"metric_config": {
"metric_dict": {
"recall": 0.5,
"auc": 0.25,
"precision": 0.25
},
"metric_source": [
"select * from my_metrics where pt='${exp_id}_${trial_id}';"
],
"metric_type": "table",
"final_mode": "best"
},
"odps_config": {
"project_name": "my_project",
"role_arn": "acs:ram::123456789:role/aliyunserviceroleforfoo",
"region": "cn-shanghai",
"end_point": "http://service.cn.maxcompute.aliyun-inc.com/api",
"log_view_host": "http://logview.odps.aliyun.com"
},
"yml_config": {
"max_trial_number": 5,
"assessor": {
"name": "PAIAssessor",
"class_args": {
"earlystop": true,
"start_step": 5,
"optimize_mode": "maximize"
}
},
"experiment_name": "my_exp",
"tuner": {
"name": "TPE",
"class_args": {
"optimize_mode": "maximize"
}
},
"trial_concurrency": 2
},
"search_space": {
"${max_depth}": {
"_type": "choice",
"_value": [
1,
3,
5
]
},
"${tree_count}": {
"_value": [
50,
100,
150
],
"_type": "choice"
}
}
},
"Deleted": true,
"Tags": [
{
"Key": "group",
"Value": "group_name"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-21 | OpenAPI 返回结构发生变更 | 查看变更详情 |