forked from docs/doc-exports
Lai, Weijian
2f0818cf3d
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Lai, Weijian <laiweijian4@huawei.com> Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>
130 lines
9.5 KiB
HTML
130 lines
9.5 KiB
HTML
<a name="ShowAutoSearchYamlTemplatesInfo"></a><a name="ShowAutoSearchYamlTemplatesInfo"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Information About the YAML Template of an Auto Search Job</h1>
|
|
<div id="body0000001349347621"><div class="section" id="ShowAutoSearchYamlTemplatesInfo__section175811451367"><h4 class="sectiontitle">Function</h4><p id="ShowAutoSearchYamlTemplatesInfo__p9582551760">This API is used to obtain information about the YAML template of an auto search job.</p>
|
|
</div>
|
|
<div class="section" id="ShowAutoSearchYamlTemplatesInfo__section16584155113615"><h4 class="sectiontitle">URI</h4><p id="ShowAutoSearchYamlTemplatesInfo__p558412511465">GET /v2/{project_id}/training-jobs/autosearch/yaml-templates</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowAutoSearchYamlTemplatesInfo__table2058645110613" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowAutoSearchYamlTemplatesInfo__row85851651566"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowAutoSearchYamlTemplatesInfo__p25875511561">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowAutoSearchYamlTemplatesInfo__p185879511366">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowAutoSearchYamlTemplatesInfo__p458817511561">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowAutoSearchYamlTemplatesInfo__p1158810511162">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowAutoSearchYamlTemplatesInfo__row9585175114613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowAutoSearchYamlTemplatesInfo__p358916511867">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowAutoSearchYamlTemplatesInfo__p15590165113613">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowAutoSearchYamlTemplatesInfo__p459013511268">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowAutoSearchYamlTemplatesInfo__p17591651967">Project ID. For details, see <a href="modelarts_03_0147.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowAutoSearchYamlTemplatesInfo__section11592751863"><h4 class="sectiontitle">Request Parameters</h4><p id="ShowAutoSearchYamlTemplatesInfo__p659295114617">None</p>
|
|
</div>
|
|
<div class="section" id="ShowAutoSearchYamlTemplatesInfo__section1759395112616"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowAutoSearchYamlTemplatesInfo__p65933511068"><strong id="ShowAutoSearchYamlTemplatesInfo__b259318511463">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowAutoSearchYamlTemplatesInfo__response_AutoSearchYamlTemplatesInfo" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="ShowAutoSearchYamlTemplatesInfo__row959719519611"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowAutoSearchYamlTemplatesInfo__p959805113611">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowAutoSearchYamlTemplatesInfo__p135997511569">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowAutoSearchYamlTemplatesInfo__p205999511464">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowAutoSearchYamlTemplatesInfo__row759712514610"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowAutoSearchYamlTemplatesInfo__p1960065110617">yaml_templates</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowAutoSearchYamlTemplatesInfo__p116008512617">Array of <a href="#ShowAutoSearchYamlTemplatesInfo__response_YamlTemplate">YamlTemplate</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowAutoSearchYamlTemplatesInfo__p1260110517616">Directories and file names of all YAML files.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ShowAutoSearchYamlTemplatesInfo__response_YamlTemplate"></a><a name="response_YamlTemplate"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowAutoSearchYamlTemplatesInfo__response_YamlTemplate" frame="border" border="1" rules="all"><caption><b>Table 3 </b>YamlTemplate</caption><thead align="left"><tr id="ShowAutoSearchYamlTemplatesInfo__row196024514616"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowAutoSearchYamlTemplatesInfo__p106035518610">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowAutoSearchYamlTemplatesInfo__p15604115117615">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowAutoSearchYamlTemplatesInfo__p10604125112612">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowAutoSearchYamlTemplatesInfo__row36026510611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowAutoSearchYamlTemplatesInfo__p17605851965">algorithm_type_en</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowAutoSearchYamlTemplatesInfo__p86052519619">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowAutoSearchYamlTemplatesInfo__p46060511361">AutoSearch algorithm type, which is described in English.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAutoSearchYamlTemplatesInfo__row86022051461"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowAutoSearchYamlTemplatesInfo__p660813511969">algorithm_names</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowAutoSearchYamlTemplatesInfo__p76093519616">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowAutoSearchYamlTemplatesInfo__p7610195119610">Names of all algorithms of this type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowAutoSearchYamlTemplatesInfo__section1461011515619"><h4 class="sectiontitle">Example Requests</h4><p id="ShowAutoSearchYamlTemplatesInfo__p11611151966">The following shows how to query information about the YAML configuration template of an auto search job.</p>
|
|
<pre class="screen" id="ShowAutoSearchYamlTemplatesInfo__screen1561110511865">GET https://endpoint/v2/{project_id}/training-jobs/autosearch/yaml-templates</pre>
|
|
</div>
|
|
<div class="section" id="ShowAutoSearchYamlTemplatesInfo__section1761218514612"><h4 class="sectiontitle">Example Responses</h4><p id="ShowAutoSearchYamlTemplatesInfo__p196132511166"><strong id="ShowAutoSearchYamlTemplatesInfo__b661305110612">Status code: 200</strong></p>
|
|
<p id="ShowAutoSearchYamlTemplatesInfo__p66131551065">ok</p>
|
|
<pre class="screen" id="ShowAutoSearchYamlTemplatesInfo__screen5615351061">{
|
|
"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" ]
|
|
} ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ShowAutoSearchYamlTemplatesInfo__section3623125113620"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowAutoSearchYamlTemplatesInfo__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowAutoSearchYamlTemplatesInfo__row10623155111610"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowAutoSearchYamlTemplatesInfo__p196249513618">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowAutoSearchYamlTemplatesInfo__p3625155120610">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowAutoSearchYamlTemplatesInfo__row1962313511765"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowAutoSearchYamlTemplatesInfo__p16263511169">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowAutoSearchYamlTemplatesInfo__p3626851664">ok</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowAutoSearchYamlTemplatesInfo__section46271511065"><h4 class="sectiontitle">Error Codes</h4><p id="ShowAutoSearchYamlTemplatesInfo__p3628351564">See <a href="modelarts_03_0095.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="trainingJobs.html">Training Job Management</a></div>
|
|
</div>
|
|
</div>
|
|
|