获取自动化搜索作业yaml模板的内容
功能介绍
获取自动化搜索作业yaml模板的内容接口用于获取自动化搜索作业的yaml配置文件的具体内容。
该接口适用于以下场景:当用户需要创建或修改自动化搜索作业时,可以通过此接口获取yaml模板的具体内容,以便进行详细的配置和调整。使用该接口的前提条件是用户具有查看自动化搜索作业模板的权限。接口响应消息体中包含yaml模板的具体内容。若用户无权限操作,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/training-jobs/autosearch/yaml-templates/{algorithm_type}/{algorithm_name}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
algorithm_type |
是 |
String |
参数解释:搜索算法类型。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
algorithm_name |
是 |
String |
参数解释:搜索算法名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
project_id |
是 |
String |
参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:1 - 64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
file_name |
String |
参数解释:yaml文件名称。 取值范围:不涉及。 |
|
content |
String |
参数解释:yaml文件内容。 取值范围:不涉及。 |
请求示例
如下查询algorithm_type为hpo且algorithm_name为Bayes的yaml配置文件内容。
GET https://endpoint/v2/{project_id}/training-jobs/autosearch/yaml-templates/hpo/Bayes
响应示例
状态码:200
ok
{
"file_name" : "Bayes.yaml",
"content" : "general:\n instance_per_trial: 1\n gpu_per_instance: 1\n cpu_per_instance: 1\n\nsearch_space:\n - params: # only support continuous params\n - type: continuous_param\n name : lr\n start: 0.001\n stop: 0.1\n\nsearch_algorithm:\n type: bayes_opt_search\n max_concurrent: 4\n reward_attr: accuracy\n num_samples: 8\n kind : ucb\n save_model_count : 3\n mode: max\n\nscheduler:\n type: FIFOScheduler"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
ok |
错误码
请参见错误码。