Obtaining Information About the YAML Template of an Auto Search Job

Function

This API is used to obtain the YAML configuration template details of an auto search job.

This API is used when you need to create or modify an auto search job. You can use this API to obtain the YAML template details to view and configure job parameters. Before using this API, ensure that you have the required permission to view the auto search job template. The response message body of the API contains the YAML template details. If you do not have the permission to perform operations, the API will return an error message.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v2/{project_id}/training-jobs/autosearch/yaml-templates

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: N/A Range: The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
yaml_templates	Array of YamlTemplate objects	Definition: Directories and file names of all YAML files.

**Table 3** YamlTemplate
Parameter	Type	Description
algorithm_type_en	String	Definition: AutoSearch algorithm type, in English. Range: N/A
algorithm_type_zh	String	Definition: AutoSearch algorithm type, in Chinese.. Range: N/A
algorithm_names	Array of strings	Definition: All algorithm names of the algorithm type.

Example Requests

The following shows how to query information about the YAML configuration template of an auto search job.

GET https://{endpoint}/v2/{project_id}/training-jobs/autosearch/yaml-templates

Example Responses

Status code: 200

{
  "yaml_templates" : [ {
    "algorithm_type_en" : "hpo",
    "algorithm_type_zh" : "algorithm_type_zh to translate",
    "algorithm_names" : [ "Anneal", "Bayes", "DragonFly", "FixNorm", "GridSearch", "TPE" ]
  }, {
    "algorithm_type_en" : "nas",
    "algorithm_type_zh" : "algorithm_type_zh to translate",
    "algorithm_names" : [ "AutoBSS", "AutoEvo", "AutoTopo", "MBNAS" ]
  }, {
    "algorithm_type_en" : "augment",
    "algorithm_type_zh" : "algorithm_type_zh to translate",
    "algorithm_names" : [ "AdvAutoAugment", "AutoAugment" ]
  }, {
    "algorithm_type_en" : "compression",
    "algorithm_type_zh" : "algorithm_type_zh to translate",
    "algorithm_names" : [ "AutoCompress" ]
  } ]
}