yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
03e77f3e5b0080047fdcb72efdfd3333dd3bcf92
doc-exports/docs/modelarts/api-ref/ShowTrainingJobEngines.html
Wuwan, Qi 78d5ebfce8 ModelArts API 25.3.0 20250710 
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-07-28 12:24:54 +00:00

238 lines
16 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002341058446"></a><a name="EN-US_TOPIC_0000002341058446"></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_0000002341058446__section1087123119414"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002341058446__p68715315413">This API is used to obtain the preset AI frameworks supported by a training job.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002341058446__section98719319419"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002341058446__p1687216311947">GET /v2/{project_id}/training-job-engines</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058446__table18739312040" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002341058446__row98721831448"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000002341058446__p15873231244">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_0000002341058446__p12873113120415">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_0000002341058446__p28737311044">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_0000002341058446__p1987310313413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058446__row98729311348"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058446__p38731731148">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_0000002341058446__p17873331541">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058446__p108741311846">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058446__p19874231745">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_0000002341058446__section1687493114412"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002341058446__p1387411311642">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002341058446__section3874183110414"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002341058446__p128749311411"><strong id="EN-US_TOPIC_0000002341058446__b087419315413">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058446__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_0000002341058446__row58741831640"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000002341058446__p198753311447">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_0000002341058446__p187513311842">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_0000002341058446__p16875331946">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058446__row68743311445"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058446__p987520317418">total</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058446__p8875133111417">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058446__p188756311946">Total number of training job engines.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058446__row15875153110418"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058446__p0875133117418">items</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058446__p188766311749">Array of <a href="#EN-US_TOPIC_0000002341058446__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_0000002341058446__p1587633114411">List of engine specifications.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058446__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_0000002341058446__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_0000002341058446__row14876731843"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000002341058446__p287763117414">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_0000002341058446__p15877203115415">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_0000002341058446__p6877133111412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058446__row48761331147"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058446__p0877133117417">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_0000002341058446__p1287716312040">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058446__p2877153118410">Engine ID, for example, <strong id="EN-US_TOPIC_0000002341058446__b387720313412">caffe-1.0.0-python2.7</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058446__row68765311841"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058446__p6877331048">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_0000002341058446__p987715319414">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058446__p48781531841">Engine name, for example, <strong id="EN-US_TOPIC_0000002341058446__b178780314416">Caffe</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058446__row787618315411"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058446__p48780313412">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_0000002341058446__p1087893118412">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058446__p187810311749">Engine version. Engines with the same name have multiple versions, for example, <strong id="EN-US_TOPIC_0000002341058446__b118788314411">Caffe-1.0.0-python2.7</strong> of Python 2.7.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058446__row168762318414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058446__p108782311649">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_0000002341058446__p198786311349">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058446__p687819311640">Whether the v1 compatibility mode is used.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058446__row17876193113414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058446__p887813311418">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_0000002341058446__p188788311410">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058446__p687816315410">User UID started by default by the engine.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058446__row88760310413"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058446__p187923110414">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_0000002341058446__p187913113410"><a href="#EN-US_TOPIC_0000002341058446__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_0000002341058446__p28791531841">Engine information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058446__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_0000002341058446__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_0000002341058446__row28793311349"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="EN-US_TOPIC_0000002341058446__p1088012311748">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_0000002341058446__p1288063118410">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_0000002341058446__p388014316410">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058446__row1887915319410"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058446__p58801631844">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_0000002341058446__p128801431848">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058446__p388012311848">Image with the matched CPU specifications.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058446__row687916312041"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058446__p8880231146">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_0000002341058446__p128801931545">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058446__p488011311645">Image with the matched GPU flavors</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058446__row148791531341"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058446__p1488073111419">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_0000002341058446__p98816311442">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058446__p1888118311142">Image version.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002341058446__section2881203110417"><h4 class="sectiontitle">Example Requests</h4><p id="EN-US_TOPIC_0000002341058446__p178811931342">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_0000002341058446__screen108811311414">GET https://endpoint/v2/{project_id}/training-job-engines</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002341058446__section198811318420"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002341058446__p14881183112415"><strong id="EN-US_TOPIC_0000002341058446__b1488112311644">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002341058446__p1588111317418">ok</p>
<pre class="screen" id="EN-US_TOPIC_0000002341058446__screen15882163115412">{
"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_0000002341058446__section688517312415"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058446__en-us_topic_0000002091201381_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002341058446__row18853311742"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="EN-US_TOPIC_0000002341058446__p38861131446">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_0000002341058446__p19886153113417">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058446__row98861311145"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002341058446__p0886193115418">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002341058446__p1288613315418">ok</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002341058446__section0886231646"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002341058446__p1388663117418">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