vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/modelarts_03_0056.html
Beibei 525370b67d
ModelArts GA API 06052022 from R&D (#14) 
ModelArts GA API 06052022 from R&D

R&D has provided a right version of ModelArts GA API (06052022)

Reviewed-by: Artem Goncharov <Artem.goncharov@gmail.com>
2022-05-23 16:26:34 +00:00

338 lines
32 KiB
HTML
Raw Blame History

<a name="modelarts_03_0056"></a><a name="modelarts_03_0056"></a>
<h1 class="topictitle1">Querying a Built-in Algorithm</h1>
<div id="body8662426"><div class="section" id="modelarts_03_0056__en-us_topic_0131380352_section47690400"><h4 class="sectiontitle">Function</h4><p class="MsoNormal" id="modelarts_03_0056__en-us_topic_0131380352_p55150024">This API is used to query the details about a built-in model.</p>
</div>
<div class="section" id="modelarts_03_0056__en-us_topic_0131380352_section26560420"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0056__en-us_topic_0131380352_p89495123389">GET /v1/{project_id}/built-in-algorithms</p>
<div class="p" id="modelarts_03_0056__en-us_topic_0131380352_p6185112512103"><a href="#modelarts_03_0056__en-us_topic_0131380352_table37435132101942">Table 1</a> describes the required parameters.
<div class="tablenoborder"><a name="modelarts_03_0056__en-us_topic_0131380352_table37435132101942"></a><a name="en-us_topic_0131380352_table37435132101942"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0056__en-us_topic_0131380352_table37435132101942" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0056__en-us_topic_0131380352_row5597399101942"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.2.3.2.2.5.1.1"><p id="modelarts_03_0056__en-us_topic_0131380352_p40537535101958">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.3.2.2.5.1.2"><p id="modelarts_03_0056__en-us_topic_0131380352_p62314923101958">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.3.2.2.5.1.3"><p id="modelarts_03_0056__en-us_topic_0131380352_p14344036101958">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.2.3.2.2.5.1.4"><p id="modelarts_03_0056__en-us_topic_0131380352_p21016273101958">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0056__en-us_topic_0131380352_row59439080101942"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p46165225101958">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p48395748101958">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p27741491101958">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0056__en-us_topic_0131380352_p32468287101958">Project ID. For details about how to obtain the project ID, see <a href="modelarts_03_0147.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="modelarts_03_0056__en-us_topic_0131380352_section32384111317"><h4 class="sectiontitle">Request Body</h4><p id="modelarts_03_0056__en-us_topic_0131380352_p4925186132"><a href="#modelarts_03_0056__en-us_topic_0131380352_table16279151181311">Table 2</a> describes the request parameters.</p>
</div>
<div class="tablenoborder"><a name="modelarts_03_0056__en-us_topic_0131380352_table16279151181311"></a><a name="en-us_topic_0131380352_table16279151181311"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0056__en-us_topic_0131380352_table16279151181311" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="modelarts_03_0056__en-us_topic_0131380352_row1327710191314"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.5.1.1"><p id="modelarts_03_0056__en-us_topic_0131380352_p727714112137">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.5.1.2"><p id="modelarts_03_0056__en-us_topic_0131380352_p1027710111313">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.4.2.5.1.3"><p id="modelarts_03_0056__en-us_topic_0131380352_p1327741131317">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.4.2.5.1.4"><p id="modelarts_03_0056__en-us_topic_0131380352_p152776119137">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0056__en-us_topic_0131380352_row7277121161310"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.5.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p82771819131">per_page</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.5.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p162775121314">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.5.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p32773112136">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.5.1.4 "><p id="modelarts_03_0056__en-us_topic_0131380352_p172771116134">Number of job parameters displayed on each page. The value range is [1, 100]. Default value: <span class="parmvalue" id="modelarts_03_0056__en-us_topic_0131380352_parmvalue5856744132111"><b>10</b></span></p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row42771615138"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.5.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p132771111134">page</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.5.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p827716115136">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.5.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p1027761141316">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.5.1.4 "><p id="modelarts_03_0056__en-us_topic_0131380352_p127741151312">Index of the page to be queried. Default value: <strong id="modelarts_03_0056__en-us_topic_0131380352_b11674161215346">1</strong></p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row4278101101311"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.5.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p10277141141311">sortBy</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.5.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p1427814141311">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.5.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p14278151191310">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.5.1.4 "><p id="modelarts_03_0056__en-us_topic_0131380352_p527816117133">Sorting mode of the query. The value can be <span class="parmname" id="modelarts_03_0056__en-us_topic_0131380352_parmname14473837192217"><b>engine</b></span>, <span class="parmname" id="modelarts_03_0056__en-us_topic_0131380352_parmname4731942102210"><b>model_name</b></span>, <span class="parmname" id="modelarts_03_0056__en-us_topic_0131380352_parmname20372446122214"><b>model_precision</b></span>, <span class="parmname" id="modelarts_03_0056__en-us_topic_0131380352_parmname136611150152210"><b>model_usage</b></span>, <span class="parmname" id="modelarts_03_0056__en-us_topic_0131380352_parmname11280135512211"><b>model_precision</b></span>, <span class="parmname" id="modelarts_03_0056__en-us_topic_0131380352_parmname5565135912227"><b>model_size</b></span>, <span class="parmname" id="modelarts_03_0056__en-us_topic_0131380352_parmname1025715612236"><b>create_time</b></span>, or <span class="parmname" id="modelarts_03_0056__en-us_topic_0131380352_parmname19283123752313"><b>parameter</b></span>. Default value: <span class="parmname" id="modelarts_03_0056__en-us_topic_0131380352_parmname1689734119237"><b>engine</b></span></p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row2027813113137"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.5.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p6278161141312">order</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.5.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p1227811115139">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.5.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p52781514135">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.5.1.4 "><p id="modelarts_03_0056__en-us_topic_0131380352_p7278181191320">Sorting order. The options are as follows:</p>
<ul id="modelarts_03_0056__en-us_topic_0131380352_ul192781817136"><li id="modelarts_03_0056__en-us_topic_0131380352_li1727815113136"><span class="parmvalue" id="modelarts_03_0056__en-us_topic_0131380352_parmvalue1337624612363"><b>asc</b></span>: ascending order</li><li id="modelarts_03_0056__en-us_topic_0131380352_li62783118137"><span class="parmvalue" id="modelarts_03_0056__en-us_topic_0131380352_parmvalue31501752163614"><b>desc</b></span>: descending order. The default value is <span class="parmvalue" id="modelarts_03_0056__en-us_topic_0131380352_parmvalue638330133716"><b>desc</b></span>.</li></ul>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row527812101320"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.5.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p192789151320">search_content</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.5.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p16278612133">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.5.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p13278316135">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.5.1.4 "><p id="modelarts_03_0056__en-us_topic_0131380352_p42781619134">Search content, for example, a parameter name. By default, this parameter is left blank.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="modelarts_03_0056__en-us_topic_0131380352_section3910402"><h4 class="sectiontitle">Response Body</h4><div class="p" id="modelarts_03_0056__en-us_topic_0131380352_p17973122516212"><a href="#modelarts_03_0056__en-us_topic_0131380352_table10251721151647">Table 3</a> describes the response parameters.
<div class="tablenoborder"><a name="modelarts_03_0056__en-us_topic_0131380352_table10251721151647"></a><a name="en-us_topic_0131380352_table10251721151647"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0056__en-us_topic_0131380352_table10251721151647" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0056__en-us_topic_0131380352_row15309029151647"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.5.2.2.2.4.1.1"><p id="modelarts_03_0056__en-us_topic_0131380352_p65700341151710">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.5.2.2.2.4.1.2"><p id="modelarts_03_0056__en-us_topic_0131380352_p19705789151710">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.5.2.2.2.4.1.3"><p id="modelarts_03_0056__en-us_topic_0131380352_p52665086151710">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0056__en-us_topic_0131380352_row154635598214"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.2.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p2530905217407">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.2.2.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p2536505617407">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.2.2.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p4130369517407">Whether the request is successful</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row1448237123714"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.2.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p345014371371">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.2.2.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p10450193773712">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.2.2.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p3522846113715">Error message of a failed API call.</p>
<p id="modelarts_03_0056__en-us_topic_0131380352_p105221346153718">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row25921437151647"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.2.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p33480290151710">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.2.2.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p16871445151710">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.2.2.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p24409838151710">Error code of a failed API call. For details, see <a href="modelarts_03_0095.html">Error Codes</a>. This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row42648418151647"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.2.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p28920610151710">model_total_count</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.2.2.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p31366462151710">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.2.2.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p57655513151710">Number of models</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row43296194151733"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.2.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p66301595151759">models</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.2.2.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p5112767151759">Array&lt;Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.2.2.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p11481022151759">Model parameter list. For details, see <a href="#modelarts_03_0056__en-us_topic_0131380352_table29182771151827">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="modelarts_03_0056__en-us_topic_0131380352_table29182771151827"></a><a name="en-us_topic_0131380352_table29182771151827"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0056__en-us_topic_0131380352_table29182771151827" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="modelarts_03_0056__en-us_topic_0131380352_b460614182363">models</strong> structure data</caption><thead align="left"><tr id="modelarts_03_0056__en-us_topic_0131380352_row30191760151827"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.5.3.2.4.1.1"><p id="modelarts_03_0056__en-us_topic_0131380352_p38401212151847">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.5.3.2.4.1.2"><p id="modelarts_03_0056__en-us_topic_0131380352_p23490491151847">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.5.3.2.4.1.3"><p id="modelarts_03_0056__en-us_topic_0131380352_p23681614151847">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0056__en-us_topic_0131380352_row59472028151827"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p18053202151847">model_id</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p53023251151847">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p67024904151847">Model ID</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row1456552151827"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p5902184151847">model_name</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p8314928151847">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p2420552151847">Model name</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row8901889151827"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p19752093151847">model_usage</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p56415701151847">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p43706384151558">Model usage. The options are as follows:</p>
<ul id="modelarts_03_0056__en-us_topic_0131380352_ul57813138151558"><li id="modelarts_03_0056__en-us_topic_0131380352_li50556195151558">1: image classification</li><li id="modelarts_03_0056__en-us_topic_0131380352_li52352572151558">2: object class and location</li><li id="modelarts_03_0056__en-us_topic_0131380352_li1411102151558">3: image semantic segmentation</li><li id="modelarts_03_0056__en-us_topic_0131380352_li12699922151558">4: natural language processing</li><li id="modelarts_03_0056__en-us_topic_0131380352_li17308185619616">5: image embedding</li></ul>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row15905135214215"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p18905125254211">model_precision</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p0905145244211">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p17907649151558">Model precision</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row64665316427"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p1546205334216">model_size</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p14461531429">Long</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p16649455151558">Model size, in bytes</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row11751753184216"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p12175053194217">model_train_dataset</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p11751053154214">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p1833874974518">Model training dataset</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row19483145334215"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p1948419533426">model_dataset_format</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p748405324217">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p5484453174217">Dataset format required by a model</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row958695315427"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p16587185318423">model_description_url</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p175871453174215">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p4587125317424">URL of the model description</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row13889115354218"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p18890115313423">parameter</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p138901853184216">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p118906531424">Running parameters of a model. This parameter is a container environment variable when a training job uses a custom image. For details, see the sample request.</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row980117459434"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p2801845144314">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p7390204171914">Long</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p58011545154311">Time when a model is created</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row159421045194317"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p18942545104311">engine_id</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p159423452431">Long</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p9698163711447">Engine ID of a model</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row89713524435"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p2971155211431">engine_name</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p79711652194314">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p1817232716441">Engine name of a model</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row311725315431"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p13118165316437">engine_version</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p1390196144413">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p191181153144315">Engine version of a model</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0056__en-us_topic_0131380352_table15296852152820" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="modelarts_03_0056__en-us_topic_0131380352_b14611930191119">parameter</strong> parameters</caption><thead align="left"><tr id="modelarts_03_0056__en-us_topic_0131380352_row18296165213285"><th align="left" class="cellrowborder" valign="top" width="18.367346938775512%" id="mcps1.3.5.4.2.4.1.1"><p id="modelarts_03_0056__en-us_topic_0131380352_p7296205262817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.26530612244898%" id="mcps1.3.5.4.2.4.1.2"><p id="modelarts_03_0056__en-us_topic_0131380352_p429610521280">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="68.36734693877553%" id="mcps1.3.5.4.2.4.1.3"><p id="modelarts_03_0056__en-us_topic_0131380352_p15296135214284">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0056__en-us_topic_0131380352_row1529719520285"><td class="cellrowborder" valign="top" width="18.367346938775512%" headers="mcps1.3.5.4.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p11297175211289">label</p>
</td>
<td class="cellrowborder" valign="top" width="13.26530612244898%" headers="mcps1.3.5.4.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p0297165215289">String</p>
</td>
<td class="cellrowborder" valign="top" width="68.36734693877553%" headers="mcps1.3.5.4.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p4297165242813">Parameter name</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row8297165218284"><td class="cellrowborder" valign="top" width="18.367346938775512%" headers="mcps1.3.5.4.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p0297205210284">value</p>
</td>
<td class="cellrowborder" valign="top" width="13.26530612244898%" headers="mcps1.3.5.4.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p42976523282">String</p>
</td>
<td class="cellrowborder" valign="top" width="68.36734693877553%" headers="mcps1.3.5.4.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p162971852192819">Parameter value</p>
</td>
</tr>
<tr id="modelarts_03_0056__en-us_topic_0131380352_row844619113013"><td class="cellrowborder" valign="top" width="18.367346938775512%" headers="mcps1.3.5.4.2.4.1.1 "><p id="modelarts_03_0056__en-us_topic_0131380352_p11447193302">required</p>
</td>
<td class="cellrowborder" valign="top" width="13.26530612244898%" headers="mcps1.3.5.4.2.4.1.2 "><p id="modelarts_03_0056__en-us_topic_0131380352_p04473973017">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="68.36734693877553%" headers="mcps1.3.5.4.2.4.1.3 "><p id="modelarts_03_0056__en-us_topic_0131380352_p10447129133020">Whether a parameter is mandatory</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="modelarts_03_0056__en-us_topic_0131380352_section1481732518200"><h4 class="sectiontitle">Samples</h4><p id="modelarts_03_0056__en-us_topic_0131380352_p5492621112417">The following shows how to query the algorithm whose name contains <span class="parmvalue" id="modelarts_03_0056__en-us_topic_0131380352_parmvalue8509125153715"><b>configname</b></span>.</p>
<ul id="modelarts_03_0056__en-us_topic_0131380352_ul58265313"><li id="modelarts_03_0056__en-us_topic_0131380352_li54625770">Sample request<pre class="screen" id="modelarts_03_0056__en-us_topic_0131380352_screen62509017406">GET https://endpoint//v1/{project_id}/built-in-algorithms?per_page=10&amp;page=1&amp;sortBy=engine&amp;order=asc&amp;search_content=model</pre>
</li></ul>
</div>
<ul id="modelarts_03_0056__en-us_topic_0131380352_ul144854392200"><li id="modelarts_03_0056__en-us_topic_0131380352_li9577900">Successful sample response<pre class="screen" id="modelarts_03_0056__en-us_topic_0131380352_screen255641294013">{
"models": [
{
"model_id": 4,
"model_name": "ResNet_v2_50",
"model_usage": 1,
"model_precision": "75.55%(top1), 92.6%(top5)",
"model_size": 102503801,
"model_train_dataset": "ImageNet, 1,000 classes for image classification",
"model_dataset_format": "shape: [H&gt;=32, W&gt;=32, C&gt;=1]; type: int8",
"model_description_url": "https://github.com/apache/incubator-mxnet/blob/master/example/image-classification/symbols/resnet.py",
"parameter": "[{\"label\":\"batch_size\",\"value\":\"4\",\"placeholder_cn\":\"Total number of training images updated each time\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"lr\",\"value\":\"0.0001\",\"placeholder_cn\":\"Learning rate\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"save_frequency\",\"value\":\"1\",\"placeholder_cn\":\"Interval for saving the model, indicating that the model is saved every N epochs\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"num_classes\",\"value\":\"\",\"placeholder_cn\":\"Total number of image classes in training\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"num_epoch\",\"value\":\"10\",\"placeholder_cn\":\"Number of training epochs\",\"placeholder_en\":\"\",\"required\":true}]",
"create_time": 1522218780025,
"engine_id": 501,
"engine_name": "MXNet",
"engine_version": "MXNet-1.2.1-python2.7"
},
{
"model_id": 5,
"model_name": "Faster_RCNN_ResNet_v2_101",
"model_usage": 2,
"model_precision": "80.05%(mAP)",
"model_size": 190936449,
"model_train_dataset": "PASCAL VOC2007, 20 classes for object detection",
"model_dataset_format": "shape: [H, W, C==3]; type: int8",
"model_description_url": "https://github.com/apache/incubator-mxnet/tree/master/example/rcnn",
"parameter": "[{\"label\":\"lr\",\"value\":\"0.0001\",\"placeholder_cn\":\"Learning rate\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"eval_frequence\",\"value\":\"1\",\"placeholder_cn\":\"Frequency for validating the model. By default, validation is performed every epoch.\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"mom\",\"value\":\"0.9\",\"placeholder_cn\":\"Momentum of the training network\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"wd\",\"value\":\"0.0005\",\"placeholder_cn\":\"Weight decay coefficient\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"num_classes\",\"value\":\"\",\"placeholder_cn\":\"Total number of image classes in training. The value must plus 1 because there is a background class.\",\"placeholder_en\":\"\",\"required\":true}]",
"create_time": 1525313224596,
"engine_id": 501,
"engine_name": "MXNet",
"engine_version": "MXNet-1.2.1-python2.7"
}
],
"model_total_count": 41,
"is_success": true
}</pre>
</li><li id="modelarts_03_0056__en-us_topic_0131380352_li12700649161818">Failed sample response<pre class="screen" id="modelarts_03_0056__en-us_topic_0131380352_screen193620535408">{
"is_success": false,
"error_message": "Error string",
"error_code": "ModelArts.0105"
}</pre>
</li></ul>
<div class="section" id="modelarts_03_0056__en-us_topic_0131380352_section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0056__en-us_topic_0131380352_p1731954913014">For details about the status code, see <a href="modelarts_03_0094.html">Status Code</a>.</p>
</div>
<div class="section" id="modelarts_03_0056__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0056__p1572811255123">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="modelarts_03_0044.html">Training Jobs</a></div>
</div>
</div>
View Git Blame Copy Permalink