vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/ShowTrainingJobEngines.html
Wuwan, Qi f81ead2467 ModelArts API 24.3.0 20241128 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
2024-11-29 09:04:54 +00:00

238 lines
16 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002042806772"></a><a name="EN-US_TOPIC_0000002042806772"></a>
<h1 class="topictitle1">Obtaining the Preset AI Frameworks Supported by a Training Job</h1>
<div id="body83170315197"><div class="section" id="EN-US_TOPIC_0000002042806772__section1431773121913"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002042806772__p531763181918">This API is used to obtain the preset AI frameworks supported by a training job.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002042806772__section53181316195"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002042806772__p93195351914">GET /v2/{project_id}/training-job-engines</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002042806772__table1032017312190" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002042806772__row123195371915"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000002042806772__p203204317199">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_0000002042806772__p13321173111916">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_0000002042806772__p8321430195">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_0000002042806772__p5321133151918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002042806772__row23206311912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002042806772__p1332253201911">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_0000002042806772__p5322634190">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002042806772__p1532210331917">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002042806772__p632312381919">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_0000002042806772__section1332319317199"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002042806772__p2032393111917">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002042806772__section13236318190"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002042806772__p732417361910"><strong id="EN-US_TOPIC_0000002042806772__b1632420381916">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002042806772__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_0000002042806772__row132493151919"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000002042806772__p3325103141914">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_0000002042806772__p123260331917">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_0000002042806772__p123262319193">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002042806772__row193254381910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002042806772__p14326173201912">total</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002042806772__p332718341914">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002042806772__p173271835193">Total number of training job engines.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002042806772__row12325133121910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002042806772__p1332711319194">items</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002042806772__p43281034195">Array of <a href="#EN-US_TOPIC_0000002042806772__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_0000002042806772__p12328113111915">List of engine specifications.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002042806772__response_items"></a><a name="response_items"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002042806772__response_items" frame="border" border="1" rules="all"><caption><b>Table 3 </b>items</caption><thead align="left"><tr id="EN-US_TOPIC_0000002042806772__row16329153121917"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000002042806772__p183310315197">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_0000002042806772__p03317371915">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_0000002042806772__p153311632196">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002042806772__row932914317199"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002042806772__p93329331913">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_0000002042806772__p633203151916">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002042806772__p233313371916">Engine ID, for example, <strong id="EN-US_TOPIC_0000002042806772__b183331936196">caffe-1.0.0-python2.7</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002042806772__row73292371911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002042806772__p11333173181914">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_0000002042806772__p12334837193">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002042806772__p1633418314193">Engine name, for example, <strong id="EN-US_TOPIC_0000002042806772__b17335239193">Caffe</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002042806772__row53302361917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002042806772__p1033503101910">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_0000002042806772__p133351031194">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002042806772__p11336431190">Engine version. Engines with the same name have multiple versions, for example, <strong id="EN-US_TOPIC_0000002042806772__b2033619361911">Caffe-1.0.0-python2.7</strong> of Python 2.7.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002042806772__row0330133201913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002042806772__p1033612313191">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_0000002042806772__p1233613171918">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002042806772__p23375331918">Whether the v1 compatibility mode is used.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002042806772__row143306314199"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002042806772__p173371933194">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_0000002042806772__p1733712318194">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002042806772__p433811312190">User UID started by default by the engine.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002042806772__row83307314199"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002042806772__p833813318190">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_0000002042806772__p7338143151913"><a href="#EN-US_TOPIC_0000002042806772__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_0000002042806772__p11339237197">Engine information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002042806772__response_image_info"></a><a name="response_image_info"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002042806772__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_0000002042806772__row83401339193"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="EN-US_TOPIC_0000002042806772__p334173141911">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_0000002042806772__p234116315199">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_0000002042806772__p143411321911">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002042806772__row153404341912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002042806772__p934214371915">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_0000002042806772__p734215318195">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002042806772__p434218331913">Image with the matched CPU specifications.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002042806772__row113401830193"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002042806772__p7343173161915">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_0000002042806772__p834363191912">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002042806772__p1334313317195">Image with the matched GPU flavors</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002042806772__row43407391911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002042806772__p5344113111912">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_0000002042806772__p03457313193">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002042806772__p234573191913">Image version.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002042806772__section1734513371911"><h4 class="sectiontitle">Example Requests</h4><p id="EN-US_TOPIC_0000002042806772__p1534617312196">The following shows how to query all public engine specifications of a training job (only part of the specifications are displayed because there are too many engines).</p>
<pre class="screen" id="EN-US_TOPIC_0000002042806772__screen33465318197">GET https://endpoint/v2/{project_id}/training-job-engines</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002042806772__section53473311191"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002042806772__p1634715311910"><strong id="EN-US_TOPIC_0000002042806772__b1834713101915">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002042806772__p1934753161911">ok</p>
<pre class="screen" id="EN-US_TOPIC_0000002042806772__screen134914391914">{
"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_0000002042806772__section1736210318192"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002042806772__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002042806772__row73631631198"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="EN-US_TOPIC_0000002042806772__p15364173191914">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_0000002042806772__p63646341913">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002042806772__row836313314193"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002042806772__p173641334193">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002042806772__p736510361913">ok</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002042806772__section1236573141912"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002042806772__p1136518301912">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