yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
sgode-patch-1
doc-exports/docs/modelarts/api-ref/ShowTrainingJobEngines.html
Wuwan, Qi 4ee10e3166 ModelArts API 24.9.0 20250414 
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>
2025-05-09 10:22:58 +00:00

238 lines
17 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000002233726986"></a><a name="EN-US_TOPIC_0000002233726986"></a>
<h1 class="topictitle1">Obtaining the Preset AI Frameworks Supported by a Training Job</h1>
<div id="body32001227"><div class="section" id="EN-US_TOPIC_0000002233726986__section43542384384"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002233726986__p16354838103810">This API is used to obtain the preset AI frameworks supported by a training job.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726986__section18354153813820"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002233726986__p8354143883819">GET /v2/{project_id}/training-job-engines</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726986__table12355738153814" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726986__row53551338173816"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000002233726986__p235523863817">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_0000002233726986__p15355153813382">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_0000002233726986__p1335553815381">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_0000002233726986__p19355183823815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726986__row1735563873811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726986__p183561838113811">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_0000002233726986__p143560389383">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726986__p73563383384">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726986__p13356193853817">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_0000002233726986__section133569387387"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002233726986__p835693811387">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726986__section035693843817"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002233726986__p2356143812381"><strong id="EN-US_TOPIC_0000002233726986__b03565383381">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726986__en-us_topic_0000002091201381_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_0000002233726986__row035763818384"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000002233726986__p53571638193816">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000002233726986__p103571338183811">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000002233726986__p5358153810386">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726986__row10357103817388"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726986__p63581438123812">total</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726986__p2358738143813">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726986__p1335812385382">Total number of training job engines.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726986__row1357183820382"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726986__p1535814381389">items</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726986__p1435820387382">Array of <a href="#EN-US_TOPIC_0000002233726986__en-us_topic_0000002091201381_response_items">items</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726986__p635811381389">List of engine specifications.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726986__en-us_topic_0000002091201381_response_items"></a><a name="en-us_topic_0000002091201381_response_items"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726986__en-us_topic_0000002091201381_response_items" frame="border" border="1" rules="all"><caption><b>Table 3 </b>items</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726986__row735919383381"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000002233726986__p235911388382">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0000002233726986__p8359238103819">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0000002233726986__p12359103810386">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726986__row835916389384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726986__p1335943816386">engine_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726986__p10360143818384">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726986__p1236016388387">Engine ID, for example, <strong id="EN-US_TOPIC_0000002233726986__b83609386386">caffe-1.0.0-python2.7</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726986__row1235923833817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726986__p12360143811381">engine_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726986__p1536033803813">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726986__p136010388389">Engine name, for example, <strong id="EN-US_TOPIC_0000002233726986__b16360638123818">Caffe</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726986__row18359153818384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726986__p18360123893813">engine_version</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726986__p18360183815388">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726986__p136010381385">Engine version. Engines with the same name have multiple versions, for example, <strong id="EN-US_TOPIC_0000002233726986__b736043820386">Caffe-1.0.0-python2.7</strong> of Python 2.7.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726986__row7359163843819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726986__p636033873819">v1_compatible</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726986__p23609384381">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726986__p736093819384">Whether the v1 compatibility mode is used.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726986__row173591438153820"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726986__p19361103863815">run_user</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726986__p1036133833810">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726986__p1336117382385">User UID started by default by the engine.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726986__row1359163843812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726986__p18361123819385">image_info</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726986__p103611138123813"><a href="#EN-US_TOPIC_0000002233726986__en-us_topic_0000002091201381_response_image_info">image_info</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726986__p18361143816384">Engine information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726986__en-us_topic_0000002091201381_response_image_info"></a><a name="en-us_topic_0000002091201381_response_image_info"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726986__en-us_topic_0000002091201381_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_0000002233726986__row113611738143818"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="EN-US_TOPIC_0000002233726986__p536243811387">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="EN-US_TOPIC_0000002233726986__p113627386383">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="EN-US_TOPIC_0000002233726986__p13362538113810">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726986__row1361183811383"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726986__p123621638143818">cpu_image_url</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726986__p136216383383">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726986__p183626389386">Image with the matched CPU specifications.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726986__row1736110385385"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726986__p1836273814385">gpu_image_url</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726986__p1436253873818">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726986__p1936293811388">Image with the matched GPU flavors</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726986__row113611038143810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726986__p0362038143814">image_version</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726986__p53633389384">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726986__p14363153843813">Image version.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726986__section19363153833815"><h4 class="sectiontitle">Example Requests</h4><p id="EN-US_TOPIC_0000002233726986__p5363438113817">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_0000002233726986__screen193634381381">GET https://endpoint/v2/{project_id}/training-job-engines</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726986__section14363183814387"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002233726986__p0363123819389"><strong id="EN-US_TOPIC_0000002233726986__b436313817382">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002233726986__p1936343818388">ok</p>
<pre class="screen" id="EN-US_TOPIC_0000002233726986__screen736423813810">{
"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_0000002233726986__section53671238153818"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726986__en-us_topic_0000002091201381_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002233726986__row133683387389"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="EN-US_TOPIC_0000002233726986__p1368113833811">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_0000002233726986__p11368183810385">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726986__row63689389385"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726986__p136819387384">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726986__p173681438153812">ok</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726986__section2368143823811"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002233726986__p83689388388">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