vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/ListTrainingJobEngines.html
Lai, Weijian 2f0818cf3d ModelArts API 22.3.0 version-20240311 
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-04-05 09:35:42 +00:00

238 lines
16 KiB
HTML
Raw Blame History

<a name="ListTrainingJobEngines"></a><a name="ListTrainingJobEngines"></a>
<h1 class="topictitle1">Querying the AI Engine List Supported by a Training Job</h1>
<div id="body0000001296468468"><div class="section" id="ListTrainingJobEngines__section1880195113480"><h4 class="sectiontitle">Function</h4><p id="ListTrainingJobEngines__p1180145119484">This API is used to query the list of AI engines supported by a training job.</p>
</div>
<div class="section" id="ListTrainingJobEngines__section98021651114812"><h4 class="sectiontitle">URI</h4><p id="ListTrainingJobEngines__p280219513487">GET /v2/{project_id}/training-job-engines</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListTrainingJobEngines__table138031451164817" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListTrainingJobEngines__row980385104812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListTrainingJobEngines__p188041751144811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListTrainingJobEngines__p5804451144813">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListTrainingJobEngines__p178042510484">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListTrainingJobEngines__p14804155164815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListTrainingJobEngines__row16803165116489"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListTrainingJobEngines__p78051351174810">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListTrainingJobEngines__p10805751134815">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListTrainingJobEngines__p980615516484">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListTrainingJobEngines__p1580710513489">Project ID. For details, see <a href="modelarts_03_0147.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListTrainingJobEngines__section1080717510483"><h4 class="sectiontitle">Request Parameters</h4><p id="ListTrainingJobEngines__p78087513487">None</p>
</div>
<div class="section" id="ListTrainingJobEngines__section19808115119485"><h4 class="sectiontitle">Response Parameters</h4><p id="ListTrainingJobEngines__p1180915111487"><strong id="ListTrainingJobEngines__b17809551184814">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListTrainingJobEngines__response_ListEngines" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="ListTrainingJobEngines__row08091551184815"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListTrainingJobEngines__p881017510481">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListTrainingJobEngines__p2810205184813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListTrainingJobEngines__p11811115134819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListTrainingJobEngines__row138091751134813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListTrainingJobEngines__p58112051104818">total</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListTrainingJobEngines__p1381185112488">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListTrainingJobEngines__p0811351104812">Total number of training job engines.</p>
</td>
</tr>
<tr id="ListTrainingJobEngines__row18809125117481"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListTrainingJobEngines__p1281212518482">items</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListTrainingJobEngines__p282110518488">Array of <a href="#ListTrainingJobEngines__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="ListTrainingJobEngines__p15821105110489">List of engine specifications.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListTrainingJobEngines__response_items"></a><a name="response_items"></a><table cellpadding="4" cellspacing="0" summary="" id="ListTrainingJobEngines__response_items" frame="border" border="1" rules="all"><caption><b>Table 3 </b>items</caption><thead align="left"><tr id="ListTrainingJobEngines__row48221751174812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListTrainingJobEngines__p16823175174811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListTrainingJobEngines__p1982375115489">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListTrainingJobEngines__p1082405124816">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListTrainingJobEngines__row782265104814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListTrainingJobEngines__p2824451144811">engine_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListTrainingJobEngines__p582425114814">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListTrainingJobEngines__p2082435154815">Engine ID, for example, <strong id="ListTrainingJobEngines__b19825145114482">caffe-1.0.0-python2.7</strong>.</p>
</td>
</tr>
<tr id="ListTrainingJobEngines__row2822135184817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListTrainingJobEngines__p10825155114812">engine_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListTrainingJobEngines__p1582595174814">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListTrainingJobEngines__p1582555184814">Engine name, for example, <strong id="ListTrainingJobEngines__b88251951204814">Caffe</strong>.</p>
</td>
</tr>
<tr id="ListTrainingJobEngines__row1982219514481"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListTrainingJobEngines__p1826115164816">engine_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListTrainingJobEngines__p1182695144817">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListTrainingJobEngines__p1282665154817">Engine version. Engines with the same name have multiple versions, for example, <strong id="ListTrainingJobEngines__b08261151154814">Caffe-1.0.0-python2.7</strong> of Python 2.7.</p>
</td>
</tr>
<tr id="ListTrainingJobEngines__row148229519489"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListTrainingJobEngines__p11826951164820">v1_compatible</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListTrainingJobEngines__p2082714515483">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListTrainingJobEngines__p1882795113480">Whether the v1 compatibility mode is used.</p>
</td>
</tr>
<tr id="ListTrainingJobEngines__row682225164816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListTrainingJobEngines__p188275512483">run_user</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListTrainingJobEngines__p98271651154816">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListTrainingJobEngines__p1882745110484">User UID started by default by the engine.</p>
</td>
</tr>
<tr id="ListTrainingJobEngines__row18823185104813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListTrainingJobEngines__p4828135112489">image_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListTrainingJobEngines__p20828145113487"><a href="#ListTrainingJobEngines__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="ListTrainingJobEngines__p9828551124813">Engine information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListTrainingJobEngines__response_image_info"></a><a name="response_image_info"></a><table cellpadding="4" cellspacing="0" summary="" id="ListTrainingJobEngines__response_image_info" frame="border" border="1" rules="all"><caption><b>Table 4 </b>image_info</caption><thead align="left"><tr id="ListTrainingJobEngines__row68291051204812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListTrainingJobEngines__p178308512488">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListTrainingJobEngines__p383005113485">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListTrainingJobEngines__p1483035114487">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListTrainingJobEngines__row282912517487"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListTrainingJobEngines__p108301651124811">cpu_image_url</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListTrainingJobEngines__p19831175124814">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListTrainingJobEngines__p98311851144817">Image with the matched CPU specifications.</p>
</td>
</tr>
<tr id="ListTrainingJobEngines__row382912510482"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListTrainingJobEngines__p208319514486">gpu_image_url</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListTrainingJobEngines__p18311451194811">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListTrainingJobEngines__p0832251184818">Image with the matched GPU or Ascend specifications.</p>
</td>
</tr>
<tr id="ListTrainingJobEngines__row48296517488"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListTrainingJobEngines__p1183225116483">image_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListTrainingJobEngines__p15832125115481">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListTrainingJobEngines__p78321251144819">Image version.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListTrainingJobEngines__section38321351124811"><h4 class="sectiontitle">Example Requests</h4><p id="ListTrainingJobEngines__p108331251124817">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="ListTrainingJobEngines__screen5833351104813">GET https://endpoint/v2/{project_id}/training-job-engines</pre>
</div>
<div class="section" id="ListTrainingJobEngines__section198331651114811"><h4 class="sectiontitle">Example Responses</h4><p id="ListTrainingJobEngines__p188341551184813"><strong id="ListTrainingJobEngines__b2834851194811">Status code: 200</strong></p>
<p id="ListTrainingJobEngines__p19834185114814">ok</p>
<pre class="screen" id="ListTrainingJobEngines__screen1683611513484">{
"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="ListTrainingJobEngines__section685295114815"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListTrainingJobEngines__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListTrainingJobEngines__row685345117481"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListTrainingJobEngines__p185485115487">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListTrainingJobEngines__p12854145118481">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListTrainingJobEngines__row6853145111487"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListTrainingJobEngines__p1085420510488">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListTrainingJobEngines__p1085525120480">ok</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListTrainingJobEngines__section198551951184816"><h4 class="sectiontitle">Error Codes</h4><p id="ListTrainingJobEngines__p138551851174812">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="resources.html">Resource and Engine Specifications</a></div>
</div>
</div>
View Git Blame Copy Permalink