vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/ShowTrainingJobEngines.html
Lai, Weijian 68e5cd0687 ModelArts API 23.3.0 Version. 
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>
2024-06-18 11:02:37 +00:00

238 lines
16 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001910008144"></a><a name="EN-US_TOPIC_0000001910008144"></a>
<h1 class="topictitle1">Obtaining the Preset AI Frameworks Supported by a Training Job</h1>
<div id="body0000001588698529"><div class="section" id="EN-US_TOPIC_0000001910008144__section10790545163713"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001910008144__p379011451373">This API is used to obtain the preset AI frameworks supported by a training job.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001910008144__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001910008144__p4791245173715">GET /v2/{project_id}/training-job-engines</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008144__table979274513710" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001910008144__row19791145103712"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001910008144__p379254553715">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000001910008144__p1779217459374">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000001910008144__p207922456371">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000001910008144__p0792114512373">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008144__row137921645163716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001910008144__p187939456373">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001910008144__p6793845103713">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001910008144__p1779310454377">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001910008144__p57931645163714">Project ID. For details, see <a href="modelarts_03_0147.html">Obtaining a Project ID and Name</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001910008144__section12793154520372"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000001910008144__p17932455378">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001910008144__section2793245183718"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000001910008144__p6793164543712"><strong id="EN-US_TOPIC_0000001910008144__b12793174520377">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008144__response_ListEngines" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001910008144__row979416451377"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001910008144__p1579454511372">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000001910008144__p879434573719">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000001910008144__p1979534515378">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008144__row1879464583715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008144__p1795124593715">total</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008144__p16795154513713">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008144__p8795124514377">Total number of training job engines.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008144__row079484593712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008144__p14795545173720">items</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008144__p879513459372">Array of <a href="#EN-US_TOPIC_0000001910008144__response_items">items</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008144__p117951445123710">List of engine specifications.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001910008144__response_items"></a><a name="response_items"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008144__response_items" frame="border" border="1" rules="all"><caption><b>Table 3 </b>items</caption><thead align="left"><tr id="EN-US_TOPIC_0000001910008144__row1779618451377"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000001910008144__p1779713451371">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0000001910008144__p16797345123718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0000001910008144__p20797164519372">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008144__row187964452374"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008144__p179724517371">engine_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008144__p879717455373">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008144__p17971459373">Engine ID, for example, <strong id="EN-US_TOPIC_0000001910008144__b107971145113718">caffe-1.0.0-python2.7</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008144__row179644514379"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008144__p9797114563715">engine_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008144__p13797134533711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008144__p207983452377">Engine name, for example, <strong id="EN-US_TOPIC_0000001910008144__b18798204543714">Caffe</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008144__row13796945173713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008144__p17798104543712">engine_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008144__p079874517377">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008144__p1479810458377">Engine version. Engines with the same name have multiple versions, for example, <strong id="EN-US_TOPIC_0000001910008144__b379894593716">Caffe-1.0.0-python2.7</strong> of Python 2.7.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008144__row1479644523716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008144__p079818456377">v1_compatible</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008144__p7798194510374">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008144__p37981645153713">Whether the v1 compatibility mode is used.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008144__row279612458377"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008144__p117981845173717">run_user</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008144__p0798154513713">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008144__p979914453372">User UID started by default by the engine.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008144__row1379674513717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008144__p67991945193718">image_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008144__p15799144533711"><a href="#EN-US_TOPIC_0000001910008144__response_image_info">image_info</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008144__p1779924553719">Engine information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001910008144__response_image_info"></a><a name="response_image_info"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008144__response_image_info" frame="border" border="1" rules="all"><caption><b>Table 4 </b>image_info</caption><thead align="left"><tr id="EN-US_TOPIC_0000001910008144__row9801164523715"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="EN-US_TOPIC_0000001910008144__p1480294513715">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="EN-US_TOPIC_0000001910008144__p480244512371">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="EN-US_TOPIC_0000001910008144__p5802545143712">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008144__row1780114563715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008144__p138021545123716">cpu_image_url</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008144__p3802114514375">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008144__p98031045193710">Image with the matched CPU specifications.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008144__row1780194513710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008144__p17803144573718">gpu_image_url</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008144__p3803114512379">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008144__p080334563717">Image with the matched GPU flavors</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008144__row98011845183720"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008144__p14803154513373">image_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008144__p15803134523715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008144__p1580304553719">Image version.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001910008144__section18803104533716"><h4 class="sectiontitle">Example Requests</h4><p id="EN-US_TOPIC_0000001910008144__p1180312451378">The following shows how to query all public engine specifications of a training job in (only part of the specifications are displayed because there are too many engines).</p>
<pre class="screen" id="EN-US_TOPIC_0000001910008144__screen15804174573718">GET https://endpoint/v2/{project_id}/training-job-engines</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001910008144__section1380464513713"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000001910008144__p380484516377"><strong id="EN-US_TOPIC_0000001910008144__b9804104593711">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000001910008144__p198041945153710">ok</p>
<pre class="screen" id="EN-US_TOPIC_0000001910008144__screen1780514543711">{
"total" : 20,
"items" : [ {
"engine_id" : "caffe-1.0.0-python2.7",
"engine_name" : "Caffe",
"engine_version" : "caffe-1.0.0-python2.7",
"v1_compatible" : true,
"run_user" : "",
"image_info" : {
"cpu_image_url" : "modelarts-job-dev-image/caffe1-cpu-cp27:1.0.0",
"gpu_image_url" : "modelarts-job-dev-image/caffe1-gpu-cuda8-cp27:1.0.0",
"image_version" : "3.1.0"
}
}, {
"engine_id" : "horovod-cp36-tf-1.16.2",
"engine_name" : "Horovod",
"engine_version" : "0.16.2-TF-1.13.1-python3.6",
"v1_compatible" : true,
"run_user" : "",
"image_info" : {
"cpu_image_url" : "modelarts-job-dev-image/tensorflow-gpu-cuda10-cp36-horovod0162:1.13.1",
"gpu_image_url" : "modelarts-job-dev-image/tensorflow-gpu-cuda10-cp36-horovod0162:1.13.1",
"image_version" : "3.2.1"
}
}, {
"engine_id" : "horovod_0.20.0-tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64",
"engine_name" : "Horovod",
"engine_version" : "horovod_0.20.0-tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64",
"v1_compatible" : false,
"run_user" : "1102",
"image_info" : {
"cpu_image_url" : "aip/horovod_tensorflow:train",
"gpu_image_url" : "aip/horovod_tensorflow:train",
"image_version" : "horovod_0.20.0-tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64-20210912152543-1e0838d"
}
}, "......", {
"engine_id" : "tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64",
"engine_name" : "TensorFlow",
"engine_version" : "tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64",
"v1_compatible" : false,
"run_user" : "1102",
"image_info" : {
"cpu_image_url" : "aip/tensorflow_2_1:train",
"gpu_image_url" : "aip/tensorflow_2_1:train",
"image_version" : "tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64-20210912152543-1e0838d"
}
}, {
"engine_id" : "xgboost-sklearn-python3.6",
"engine_name" : "XGBoost-Sklearn",
"engine_version" : "XGBoost-0.80-Sklearn-0.18.1-python3.6",
"v1_compatible" : true,
"run_user" : "",
"image_info" : {
"cpu_image_url" : "modelarts-job-dev-image/python-train-py36:secure",
"gpu_image_url" : "",
"image_version" : "2.0.10-20211101113705"
}
} ]
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001910008144__section480910451371"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008144__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001910008144__row1080934514379"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="EN-US_TOPIC_0000001910008144__p148101451370">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="EN-US_TOPIC_0000001910008144__p1481064510373">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008144__row780914533710"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001910008144__p78102045193713">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001910008144__p16810154512372">ok</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001910008144__section48101455371"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000001910008144__p28101451378">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="algorithms.html">Training Management</a></div>
</div>
</div>
View Git Blame Copy Permalink