Obtaining Information About the YAML Template of an Auto Search Job¶

Function¶

This API is used to obtain information about the YAML template of an auto search job.

URI¶

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

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID and Name.

Request Parameters¶

None

Response Parameters¶

Status code: 200

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

**Table 3** YamlTemplate¶
Parameter	Type	Description
algorithm_type_en	String	AutoSearch algorithm type, which is described in English.
algorithm_type_zh	String	AutoSearch algorithm type
algorithm_names	Array of strings	Names of all algorithms of this 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" ]
  } ]
}

Status Codes¶

Status Code	Description
200	ok

Error Codes¶

See Error Codes.

last updated: 2025-02-14 13:31 UTC - commit: b9dfcea0f4de207ab46ae186e9fafba6d70e5908