vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/modelarts_03_0045.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

676 lines
60 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001943866685"></a><a name="EN-US_TOPIC_0000001943866685"></a>
<h1 class="topictitle1">Creating a Training Job</h1>
<div id="body1536843917325"><div class="section" id="EN-US_TOPIC_0000001943866685__section694510305355"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001943866685__p18590161081120">This API is used to create a training job.</p>
<p id="EN-US_TOPIC_0000001943866685__p98522361359">Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in <a href="modelarts_03_0046.html">Querying a Training Job List</a> and <a href="modelarts_03_0047.html">Querying the Details About a Training Job Version</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001943866685__section20261580353"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001943866685__p10699185617527">POST /v1/{project_id}/training-jobs</p>
</div>
<div class="p" id="EN-US_TOPIC_0000001943866685__p337811539117"><a href="#EN-US_TOPIC_0000001943866685__table143351836151117">Table 1</a> describes the required parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943866685__table143351836151117"></a><a name="table143351836151117"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943866685__table143351836151117" width="100%" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943866685__row1533563613114"><th align="left" class="cellrowborder" valign="top" width="17.585858585858585%" id="mcps1.3.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001943866685__p15335183631114">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.636363636363637%" id="mcps1.3.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001943866685__p10335136191112">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.101010101010102%" id="mcps1.3.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001943866685__p1533514365119">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.67676767676768%" id="mcps1.3.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001943866685__p1933523631113">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001943866685__row17335936121112"><td class="cellrowborder" valign="top" width="17.585858585858585%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p4335736161115">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.636363636363637%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p33356361118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.101010101010102%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p73351936121116">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.67676767676768%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p12335736141110">Project ID. For details about how to obtain a project ID, 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_0000001943866685__section722833995517"><h4 class="sectiontitle">Request Body</h4><div class="p" id="EN-US_TOPIC_0000001943866685__p12664142510271"><a href="#EN-US_TOPIC_0000001943866685__table6270801111211">Table 2</a> describes the request parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943866685__table6270801111211"></a><a name="table6270801111211"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943866685__table6270801111211" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943866685__row29941823111211"><th align="left" class="cellrowborder" valign="top" width="17.47%" id="mcps1.3.4.2.2.2.5.1.1"><p id="EN-US_TOPIC_0000001943866685__p40715701111242">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.559999999999999%" id="mcps1.3.4.2.2.2.5.1.2"><p id="EN-US_TOPIC_0000001943866685__p9637448111242">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.68%" id="mcps1.3.4.2.2.2.5.1.3"><p id="EN-US_TOPIC_0000001943866685__p42435861111242">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.290000000000006%" id="mcps1.3.4.2.2.2.5.1.4"><p id="EN-US_TOPIC_0000001943866685__p14752706111242">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001943866685__row41237117111211"><td class="cellrowborder" valign="top" width="17.47%" headers="mcps1.3.4.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p21523933111242">job_name</p>
</td>
<td class="cellrowborder" valign="top" width="15.559999999999999%" headers="mcps1.3.4.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p65717019111242">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.68%" headers="mcps1.3.4.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p21478362111242">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.290000000000006%" headers="mcps1.3.4.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p62025794111242">Training job name. The value must contain 1 to 64 characters consisting of only digits, letters, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row47335462111211"><td class="cellrowborder" valign="top" width="17.47%" headers="mcps1.3.4.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p52538571111242">job_desc</p>
</td>
<td class="cellrowborder" valign="top" width="15.559999999999999%" headers="mcps1.3.4.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p27765887111242">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.68%" headers="mcps1.3.4.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p34444375111242">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.290000000000006%" headers="mcps1.3.4.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p38531004111242">Description of a training job. The value must contain 0 to 256 characters. By default, this parameter is left blank.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row42350277111211"><td class="cellrowborder" valign="top" width="17.47%" headers="mcps1.3.4.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p37596993111242">config</p>
</td>
<td class="cellrowborder" valign="top" width="15.559999999999999%" headers="mcps1.3.4.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p25457572111242">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.68%" headers="mcps1.3.4.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p48797423111242">Object</p>
</td>
<td class="cellrowborder" valign="top" width="54.290000000000006%" headers="mcps1.3.4.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p60277195111242">Parameters for creating a training job For details, see <a href="#EN-US_TOPIC_0000001943866685__table24411850104213">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row18347183011116"><td class="cellrowborder" valign="top" width="17.47%" headers="mcps1.3.4.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p143471230219">workspace_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.559999999999999%" headers="mcps1.3.4.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p7347530518">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.68%" headers="mcps1.3.4.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1334720302117">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.290000000000006%" headers="mcps1.3.4.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p73471301217">Workspace where a job resides. Default value: <strong id="EN-US_TOPIC_0000001943866685__b15598103813584">0</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943866685__table24411850104213"></a><a name="table24411850104213"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943866685__table24411850104213" width="100%" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0000001943866685__b89358944114">config</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943866685__row24621050184211"><th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.4.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001943866685__p846695014420">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.060606060606059%" id="mcps1.3.4.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000001943866685__p2472250174216">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.666666666666666%" id="mcps1.3.4.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000001943866685__p4475105094212">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.08080808080807%" id="mcps1.3.4.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000001943866685__p347885011427">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001943866685__row11479165020428"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p548345016424">worker_server_num</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p1648616503421">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p8489350124215">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p7493195034215">Number of workers in a training job. Obtain the maximum value from the <strong id="EN-US_TOPIC_0000001943866685__b19498132121818">max_num</strong> value returned by the API in <a href="modelarts_03_0072.html">Querying Job Resource Specifications</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row24971850184213"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p115007506428">app_url</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p950317501429">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1750655034220">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p750985094216">Code directory of a training job, for example, <span class="filepath" id="EN-US_TOPIC_0000001943866685__filepath65451351105914"><b>/usr/app/</b></span>. This parameter must be used together with <strong id="EN-US_TOPIC_0000001943866685__b1651781415413">boot_file_url</strong>. After setting <strong id="EN-US_TOPIC_0000001943866685__b15517714195413">model_id</strong>, you do not need to set <strong id="EN-US_TOPIC_0000001943866685__b1151851413544">app_url</strong> or <strong id="EN-US_TOPIC_0000001943866685__b751861485417">boot_file_url</strong>, and <strong id="EN-US_TOPIC_0000001943866685__b1051910142545">engine_id</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row165164501428"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p35209501423">boot_file_url</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p552245012421">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1352695094216">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p1052817508427">Boot file of a training job, which needs to be stored in the code directory. Example value: <span class="filepath" id="EN-US_TOPIC_0000001943866685__filepath953055064213"><b>/usr/app/boot.py</b></span> This parameter must be used together with <strong id="EN-US_TOPIC_0000001943866685__b466271516542">app_url</strong>. After setting <strong id="EN-US_TOPIC_0000001943866685__b966201555415">model_id</strong>, you do not need to set <strong id="EN-US_TOPIC_0000001943866685__b2663161519541">app_url</strong> or <strong id="EN-US_TOPIC_0000001943866685__b146649156549">boot_file_url</strong>, and <strong id="EN-US_TOPIC_0000001943866685__b466512155543">engine_id</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row195333503423"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p953625011422">parameter</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p691852818119">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1254318503423">Array&lt;Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p0556216">Running parameters of a training job. It is a collection of label-value pairs. Values can be customized. <strong id="EN-US_TOPIC_0000001943866685__b6770836192614">label</strong> is a parameter name and <strong id="EN-US_TOPIC_0000001943866685__b13238396261">value</strong> is the parameter value. For details, see the sample request. This parameter is a container environment variable when a training job uses a custom image. For details, see <a href="#EN-US_TOPIC_0000001943866685__table1267642234716">Table 8</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row6549145024219"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p95545506421">data_url</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p655755054219">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1156015505422">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p956445054210">OBS URL of the dataset required by a training job. By default, this parameter is left blank. For example, <span class="filepath" id="EN-US_TOPIC_0000001943866685__filepath1456635018428"><b>/usr/data/</b></span>. This parameter cannot be used together with <strong id="EN-US_TOPIC_0000001943866685__b17888101895419">data_source</strong> or <strong id="EN-US_TOPIC_0000001943866685__b10889151813544">dataset_id</strong> and <strong id="EN-US_TOPIC_0000001943866685__b14889111811544">dataset_version_id</strong>. However, one of the parameters must exist.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row1557018505421"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p1857315014211">dataset_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p6578165015427">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p185801150184211">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p9583950184210">Dataset ID of a training job. This parameter must be used together with <strong id="EN-US_TOPIC_0000001943866685__b1896875145818">dataset_version_id</strong>, but cannot be used together with <strong id="EN-US_TOPIC_0000001943866685__b424901115912">data_url</strong> or <strong id="EN-US_TOPIC_0000001943866685__b2022117464172">data_source</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row758516502428"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p18589165044211">dataset_version_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p16592155011420">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p45954508425">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p205997508422">Dataset version ID of a training job. This parameter must be used together with <strong id="EN-US_TOPIC_0000001943866685__b11986180411">dataset_id</strong>, but cannot be used together with <strong id="EN-US_TOPIC_0000001943866685__b109861101617">data_url</strong> or <strong id="EN-US_TOPIC_0000001943866685__b127125620171">data_source</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row184417105810"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p1084415185810">data_source</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p9844121105816">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1710342391811">Array&lt;Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p884414112581">Dataset of a training job. This parameter cannot be used together with <strong id="EN-US_TOPIC_0000001943866685__b1218418401716">data_url</strong> or <strong id="EN-US_TOPIC_0000001943866685__b141842417174">dataset_id</strong> and <strong id="EN-US_TOPIC_0000001943866685__b818414414176">dataset_version_id</strong>. For details, see <a href="#EN-US_TOPIC_0000001943866685__table250595919011">Table 4</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row861516503426"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p1561955014420">spec_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p7623250164211">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p8627175017420">Long</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p7631195024211">ID of the resource specifications selected for a training job. Obtain the ID by calling the API described in <a href="modelarts_03_0072.html">Querying Job Resource Specifications</a>. When creating a public pool job, ensure that <strong id="EN-US_TOPIC_0000001943866685__b20889144618283">spec_id</strong> is mandatory and cannot be used with <strong id="EN-US_TOPIC_0000001943866685__b154781918202917">pool_id</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row177301235174910"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p14730173517491">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p373016357494">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1473016359496">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p1873018356494">ID of a dedicated resource pool. To obtain the ID, do as follows: Log in to the ModelArts management console, choose <strong id="EN-US_TOPIC_0000001943866685__b19601755172912">Dedicated Resource Pools</strong> in the navigation pane on the left, and view the resource pool ID in the dedicated resource pool list. When creating a dedicated pool job, ensure that <strong id="EN-US_TOPIC_0000001943866685__b04610993013">pool_id</strong> is mandatory and cannot be used with <strong id="EN-US_TOPIC_0000001943866685__b64613920308">spec_id</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row1463518500426"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p863845013426">engine_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p1364385014215">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p36461950144210">Long</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p565095012422">ID of the engine selected for a training job. The default value is <strong id="EN-US_TOPIC_0000001943866685__b179521201897">1</strong>. After setting <strong id="EN-US_TOPIC_0000001943866685__b1769194917275">model_id</strong>, you do not need to set <strong id="EN-US_TOPIC_0000001943866685__b369234918270">app_url</strong> or <strong id="EN-US_TOPIC_0000001943866685__b069214499278">boot_file_url</strong>, and <strong id="EN-US_TOPIC_0000001943866685__b6693144922712">engine_id</strong>. Obtain the ID by calling the API described in <a href="modelarts_03_0073.html">Querying Job Engine Specifications</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row146729508427"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p20674175024219">train_url</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p1080617560241">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p9679185016423">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p76822506429">OBS URL of the output file of a training job. By default, this parameter is left blank. Example value: <span class="filepath" id="EN-US_TOPIC_0000001943866685__filepath685102617317"><b>/usr/train/</b></span></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row17687185064211"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p106881050154220">log_url</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p17806757142413">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1369555013425">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p9699950194211">OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: <span class="filepath" id="EN-US_TOPIC_0000001943866685__filepath37401535181810"><b>/usr/log/</b></span></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row145541841164317"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p255514164311">user_image_url</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p5555144113435">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p5555841114318">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p755554118434">SWR URL of a custom image used by a training job. Example value: <span class="filepath" id="EN-US_TOPIC_0000001943866685__filepath17220185725310"><b>100.125.5.235:20202/jobmng/custom-cpu-base:1.0</b></span></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row1864183416461"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p46411034174620">user_command</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p11641434154610">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1364113434619">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p17641113410465">Boot command used to start the container of a custom image of a training job. The format is <span class="filepath" id="EN-US_TOPIC_0000001943866685__filepath199791067542"><b>bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}</b></span>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row13919194332513"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p1692114439251">create_version</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p15921194352517">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1792184311254">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p0808416202912">Whether a version is created when a training job is created</p>
<ul id="EN-US_TOPIC_0000001943866685__ul16131171918296"><li id="EN-US_TOPIC_0000001943866685__li11686145622915"><strong id="EN-US_TOPIC_0000001943866685__b125741425191511">true</strong>: Default value. A version is created when a training job is created.</li><li id="EN-US_TOPIC_0000001943866685__li1813111912296"><strong id="EN-US_TOPIC_0000001943866685__b169101223161">false</strong>: A version is not created when a training job is created.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row946462010302"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p546532073018">volumes</p>
</td>
<td class="cellrowborder" valign="top" width="14.060606060606059%" headers="mcps1.3.4.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p1146532073020">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.666666666666666%" headers="mcps1.3.4.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1946610201303">JSON Array</p>
</td>
<td class="cellrowborder" valign="top" width="52.08080808080807%" headers="mcps1.3.4.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p7466132012305">Storage volume that can be used by a training job. For details, see <a href="#EN-US_TOPIC_0000001943866685__table6403153714711">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943866685__table250595919011"></a><a name="table250595919011"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943866685__table250595919011" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0000001943866685__b16631161201916">data_source</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943866685__row55072591012"><th align="left" class="cellrowborder" valign="top" width="18.360000000000003%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0000001943866685__p1527511378117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.620000000000001%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0000001943866685__p1628153716110">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.370000000000001%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0000001943866685__p22831437411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.65%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0000001943866685__p328510371619">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001943866685__row2507159009"><td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p1680105517118">dataset_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.620000000000001%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p2804555115">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.370000000000001%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1180619554119">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.65%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p18097554112">Dataset ID of a training job. This parameter must be used together with <strong id="EN-US_TOPIC_0000001943866685__b121082034191610">dataset_version_id</strong>, but cannot be used together with <strong id="EN-US_TOPIC_0000001943866685__b15109143415167">data_url</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row205071598010"><td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p118131955110">dataset_version</p>
</td>
<td class="cellrowborder" valign="top" width="15.620000000000001%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p148201755118">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.370000000000001%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1282320551611">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.65%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p0823205511117">Dataset version ID of a training job. This parameter must be used together with <strong id="EN-US_TOPIC_0000001943866685__b492715389168">dataset_id</strong>, but cannot be used together with <strong id="EN-US_TOPIC_0000001943866685__b209271338141612">data_url</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row589115610214"><td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p16892761827">type</p>
</td>
<td class="cellrowborder" valign="top" width="15.620000000000001%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p1892116628">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.370000000000001%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p188923615217">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.65%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p88921866216">Dataset type. The value can be <span class="parmvalue" id="EN-US_TOPIC_0000001943866685__parmvalue11483217131514"><b>obs</b></span> or <span class="parmvalue" id="EN-US_TOPIC_0000001943866685__parmvalue1594222310157"><b>dataset</b></span>. <strong id="EN-US_TOPIC_0000001943866685__b9661147191618">obs</strong> and <strong id="EN-US_TOPIC_0000001943866685__b7864115016165">dataset</strong> cannot be used at the same time.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row151161127191914"><td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p13117227131918">data_url</p>
</td>
<td class="cellrowborder" valign="top" width="15.620000000000001%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p131171127181920">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.370000000000001%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p011752719191">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.65%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p141171327171918">OBS bucket path. This parameter cannot be used together with <strong id="EN-US_TOPIC_0000001943866685__b164435634315">dataset_id</strong> or <strong id="EN-US_TOPIC_0000001943866685__b1364425654310">dataset_version</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943866685__table6403153714711"></a><a name="table6403153714711"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943866685__table6403153714711" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="EN-US_TOPIC_0000001943866685__b1076810550163">volumes</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943866685__row1940419374476"><th align="left" class="cellrowborder" valign="top" width="18.38%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0000001943866685__p540623710472">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.6%" id="mcps1.3.4.4.2.5.1.2"><p id="EN-US_TOPIC_0000001943866685__p240683714713">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.370000000000001%" id="mcps1.3.4.4.2.5.1.3"><p id="EN-US_TOPIC_0000001943866685__p9406337134712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.65%" id="mcps1.3.4.4.2.5.1.4"><p id="EN-US_TOPIC_0000001943866685__p1340611372471">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001943866685__row340618374473"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p19407203794711">nfs</p>
</td>
<td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p4407203794719">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.370000000000001%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p0407133754714">Object</p>
</td>
<td class="cellrowborder" valign="top" width="52.65%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p124605178532">Storage volume of the shared file system type. Only the training jobs running in a resource pool with the shared file system network connected support such storage volumes. For details, see <a href="#EN-US_TOPIC_0000001943866685__table19871043113315">Table 6</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row184071537184711"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p144071737144717">host_path</p>
</td>
<td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p8407133718478">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.370000000000001%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p19407113717475">Object</p>
</td>
<td class="cellrowborder" valign="top" width="52.65%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p16407837144712">Storage volume of the host file system type. Only training jobs running in a dedicated resource pool support such storage volumes. For details, see <a href="#EN-US_TOPIC_0000001943866685__table4873028185611">Table 7</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943866685__table19871043113315"></a><a name="table19871043113315"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943866685__table19871043113315" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="EN-US_TOPIC_0000001943866685__b671916852218">nfs</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943866685__row98718439339"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.4.5.2.5.1.1"><p id="EN-US_TOPIC_0000001943866685__p788143103316">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.73%" id="mcps1.3.4.5.2.5.1.2"><p id="EN-US_TOPIC_0000001943866685__p0881743193316">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.4%" id="mcps1.3.4.5.2.5.1.3"><p id="EN-US_TOPIC_0000001943866685__p128864353314">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.53%" id="mcps1.3.4.5.2.5.1.4"><p id="EN-US_TOPIC_0000001943866685__p688154314331">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001943866685__row19881543203313"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p19882436334">id</p>
</td>
<td class="cellrowborder" valign="top" width="15.73%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p148844363318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.4%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p38894315334">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.53%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p198884310331">ID of an SFS Turbo file system</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row16881433332"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p17242113943514">src_path</p>
</td>
<td class="cellrowborder" valign="top" width="15.73%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p168814343315">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.4%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p9884436332">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.53%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p16254151103616">Address of an SFS Turbo file system</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row788174343319"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p78884323316">dest_path</p>
</td>
<td class="cellrowborder" valign="top" width="15.73%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p148864323320">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.4%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p108914373317">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.53%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p148984312331">Local path to a training job</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row9892432337"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p28910436339">read_only</p>
</td>
<td class="cellrowborder" valign="top" width="15.73%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p1089743143320">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.4%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p128984323313">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="52.53%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p148915436330">Whether <strong id="EN-US_TOPIC_0000001943866685__b434540242">dest_path</strong> is read-only. The default value is <strong id="EN-US_TOPIC_0000001943866685__b1634273172420">false</strong>.</p>
<ul id="EN-US_TOPIC_0000001943866685__ul13960112394512"><li id="EN-US_TOPIC_0000001943866685__li149601623174517"><span class="parmname" id="EN-US_TOPIC_0000001943866685__parmname815973219243"><b>true</b></span>: read-only permission</li><li id="EN-US_TOPIC_0000001943866685__li289893174511"><span class="parmname" id="EN-US_TOPIC_0000001943866685__parmname19119147132512"><b>false</b></span>: read/write permission. This is the default value.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943866685__table4873028185611"></a><a name="table4873028185611"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943866685__table4873028185611" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="EN-US_TOPIC_0000001943866685__b145381331132515">host_path</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943866685__row487472818567"><th align="left" class="cellrowborder" valign="top" width="18.360000000000003%" id="mcps1.3.4.6.2.5.1.1"><p id="EN-US_TOPIC_0000001943866685__p158741728185619">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.6%" id="mcps1.3.4.6.2.5.1.2"><p id="EN-US_TOPIC_0000001943866685__p14874728135617">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.389999999999999%" id="mcps1.3.4.6.2.5.1.3"><p id="EN-US_TOPIC_0000001943866685__p1387442815610">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.65%" id="mcps1.3.4.6.2.5.1.4"><p id="EN-US_TOPIC_0000001943866685__p1987472819565">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001943866685__row108747289562"><td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p168758285564">src_path</p>
</td>
<td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p14875128125616">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.389999999999999%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1387512811566">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.65%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p28751628185614">Local path to a host</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row5875192815616"><td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p587552845611">dest_path</p>
</td>
<td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p987542819568">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.389999999999999%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1787572895619">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.65%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p16859190125918">Local path to a training job</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row4875162816567"><td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p178751928195615">read_only</p>
</td>
<td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p1987510281564">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.389999999999999%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p7875428205613">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="52.65%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p687562815569">Whether <strong id="EN-US_TOPIC_0000001943866685__b17560983264">dest_path</strong> is read-only. The default value is <strong id="EN-US_TOPIC_0000001943866685__b156113810266">false</strong>.</p>
<ul id="EN-US_TOPIC_0000001943866685__ul58751828105618"><li id="EN-US_TOPIC_0000001943866685__li1875162814561"><span class="parmname" id="EN-US_TOPIC_0000001943866685__parmname27011014264"><b>true</b></span>: read-only permission</li><li id="EN-US_TOPIC_0000001943866685__li187522815566"><span class="parmname" id="EN-US_TOPIC_0000001943866685__parmname7455101112615"><b>false</b></span>: read/write permission. This is the default value.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943866685__table1267642234716"></a><a name="table1267642234716"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943866685__table1267642234716" frame="border" border="1" rules="all"><caption><b>Table 8 </b><strong id="EN-US_TOPIC_0000001943866685__b101961027121914">parameter</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943866685__row5677422164714"><th align="left" class="cellrowborder" valign="top" width="18.258174182581744%" id="mcps1.3.4.7.2.5.1.1"><p id="EN-US_TOPIC_0000001943866685__p7296205262817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.828417158284172%" id="mcps1.3.4.7.2.5.1.2"><p id="EN-US_TOPIC_0000001943866685__p5194191034416">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.428657134286572%" id="mcps1.3.4.7.2.5.1.3"><p id="EN-US_TOPIC_0000001943866685__p196771122154718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.48475152484752%" id="mcps1.3.4.7.2.5.1.4"><p id="EN-US_TOPIC_0000001943866685__p5677022194719">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001943866685__row2677192224717"><td class="cellrowborder" valign="top" width="18.258174182581744%" headers="mcps1.3.4.7.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p14677192217478">label</p>
</td>
<td class="cellrowborder" valign="top" width="15.828417158284172%" headers="mcps1.3.4.7.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p17194710144418">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.428657134286572%" headers="mcps1.3.4.7.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p16677112218473">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.48475152484752%" headers="mcps1.3.4.7.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p10677142210478">Parameter name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row5528181488"><td class="cellrowborder" valign="top" width="18.258174182581744%" headers="mcps1.3.4.7.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866685__p05295804810">value</p>
</td>
<td class="cellrowborder" valign="top" width="15.828417158284172%" headers="mcps1.3.4.7.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866685__p0194410164417">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.428657134286572%" headers="mcps1.3.4.7.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866685__p135299824812">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.48475152484752%" headers="mcps1.3.4.7.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866685__p1652913874819">Parameter value</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001943866685__section143152617293"><h4 class="sectiontitle">Response Body</h4><p id="EN-US_TOPIC_0000001943866685__p0409245294"><a href="#EN-US_TOPIC_0000001943866685__table1260716526159">Table 9</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943866685__table1260716526159"></a><a name="table1260716526159"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943866685__table1260716526159" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943866685__row1607115231519"><th align="left" class="cellrowborder" valign="top" width="18.47%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000001943866685__p4607552141512">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.63%" id="mcps1.3.5.3.2.4.1.2"><p id="EN-US_TOPIC_0000001943866685__p15608165211151">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67.9%" id="mcps1.3.5.3.2.4.1.3"><p id="EN-US_TOPIC_0000001943866685__p10608952181512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001943866685__row1960813529151"><td class="cellrowborder" valign="top" width="18.47%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943866685__p36081352131517">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="13.63%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943866685__p760855251517">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1660875221510">Whether the request is successful</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row1260825221512"><td class="cellrowborder" valign="top" width="18.47%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943866685__p7608152101517">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="13.63%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943866685__p1560915521153">String</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943866685__p20609205217152">Error message of a failed API call.</p>
<p id="EN-US_TOPIC_0000001943866685__p16609195210152">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row14609155216153"><td class="cellrowborder" valign="top" width="18.47%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943866685__p860955281512">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="13.63%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943866685__p1609452141512">String</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943866685__p13609155251519">Error code of a failed API call. For details, see <a href="modelarts_03_0095.html">Error Codes</a>.</p>
<p id="EN-US_TOPIC_0000001943866685__p960995215158">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row360935291517"><td class="cellrowborder" valign="top" width="18.47%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943866685__p1460910528153">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.63%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943866685__p15609175221516">Long</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943866685__p1661018521158">ID of a training job</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row17610135214152"><td class="cellrowborder" valign="top" width="18.47%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943866685__p6610252131510">job_name</p>
</td>
<td class="cellrowborder" valign="top" width="13.63%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943866685__p1261035271514">String</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943866685__p6610185213154">Name of a training job</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row2610252181516"><td class="cellrowborder" valign="top" width="18.47%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943866685__p1561065218157">status</p>
</td>
<td class="cellrowborder" valign="top" width="13.63%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943866685__p1561075221516">Int</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943866685__p126103521155">Status of a training job. For details about the job statuses, see <a href="modelarts_03_0074.html">Job Statuses</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row66101752111513"><td class="cellrowborder" valign="top" width="18.47%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943866685__p161016521159">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="13.63%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943866685__p161015215151">Long</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943866685__p19610125214157">Timestamp when a training job is created</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row9611175291517"><td class="cellrowborder" valign="top" width="18.47%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943866685__p461195231519">version_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.63%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943866685__p10611195218156">Long</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943866685__p661135221516">Version ID of a training job</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row206111952161519"><td class="cellrowborder" valign="top" width="18.47%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943866685__p19611135212152">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.63%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943866685__p961185211154">String</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943866685__p16111452131512">Charged resource ID of a training job</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866685__row8611135215156"><td class="cellrowborder" valign="top" width="18.47%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943866685__p96119524159">version_name</p>
</td>
<td class="cellrowborder" valign="top" width="13.63%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943866685__p1261185211519">String</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943866685__p461245212155">Version name of a training job</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001943866685__section106281655171917"><h4 class="sectiontitle">Sample Request</h4><ul id="EN-US_TOPIC_0000001943866685__ul51111433152010"><li id="EN-US_TOPIC_0000001943866685__li171118332205">The following shows how to create training job <span class="parmvalue" id="EN-US_TOPIC_0000001943866685__parmvalue1862110487596"><b>TestModelArtsJob</b></span> with <span class="parmvalue" id="EN-US_TOPIC_0000001943866685__parmvalue6621174865918"><b>This is a ModelArts job</b></span> as its description.<pre class="screen" id="EN-US_TOPIC_0000001943866685__screen1983630219">POST https://endpoint/v1/{project_id}/training-jobs
{
"job_name": "TestModelArtsJob",
"job_desc": "This is a ModelArts job",
"workspace_id": "af261af2218841ec960b01ab3cf1a5fa",
"config": {
"worker_server_num": 1,
"app_url": "/usr/app/",
"boot_file_url": "/usr/app/boot.py",
"parameter": [
{
"label": "learning_rate",
"value": "0.01"
},
{
"label": "batch_size",
"value": "32"
}
],
"dataset_id": "38277e62-9e59-48f4-8d89-c8cf41622c24",
"dataset_version_id": "2ff0d6ba-c480-45ae-be41-09a8369bfc90",
"spec_id": 1,
"engine_id": 1,
"train_url": "/usr/train/",
"log_url": "/usr/log/",
"model_id": 1,
"pool_id": "testpool"
}
}</pre>
</li><li id="EN-US_TOPIC_0000001943866685__li1882665418201">The following shows how to create training job <span class="parmvalue" id="EN-US_TOPIC_0000001943866685__parmvalue9515018218"><b>TestModelArtsJob2</b></span> using a custom image.<pre class="screen" id="EN-US_TOPIC_0000001943866685__screen952522818218">POST https://endpoint/v1/{project_id}/training-jobs
{
"job_name": "TestModelArtsJob2",
"job_desc": "This is a ModelArts job",
"workspace_id": "af261af2218841ec960b01ab3cf1a5fa",
"config": {
"worker_server_num": 1,
"data_url": "/usr/data/",
"app_url": "/usr/app/",
"boot_file_url": "/usr/app/boot.py",
"parameter": [
{
"label": "CUSTOM_PARAM1",
"value": "1"
}
],
"spec_id": 1,
"user_command": "bash -x /home/work/run_train.sh python /home/work/user-job-dir/app/mnist/mnist_softmax.py --data_url /home/work/user-job-dir/app/mnist_data",
"user_image_url": "100.125.5.235:20202/jobmng/custom-cpu-base:1.0",
"train_url": "/usr/train/",
"log_url": "/usr/log/",
"model_id": 1,
"pool_id": "testpool",
"engine_id": 1
}
}</pre>
</li><li id="EN-US_TOPIC_0000001943866685__li1365831622119">The following shows how to create training job <span class="parmvalue" id="EN-US_TOPIC_0000001943866685__parmvalue6387521162213"><b>TestModelArtsJob3</b></span> using disk storage.<pre class="screen" id="EN-US_TOPIC_0000001943866685__screen033115152119">POST https://endpoint/v1/{project_id}/training-jobs
{
"job_name": "TestModelArtsJob3",
"job_desc": "This is a ModelArts job",
"workspace_id": "af261af2218841ec960b01ab3cf1a5fa",
"config": {
"worker_server_num": 1,
"app_url": "/usr/app/",
"boot_file_url": "/usr/app/boot.py",
"parameter": [
{
"label": "learning_rate",
"value": "0.01"
},
{
"label": "batch_size",
"value": "32"
}
],
"dataset_id": "38277e62-9e59-48f4-8d89-c8cf41622c24",
"dataset_version_id": "2ff0d6ba-c480-45ae-be41-09a8369bfc90",
"spec_id": 1,
"engine_id": 1,
"train_url": "/usr/train/",
"log_url": "/usr/log/",
"model_id": 1,
"pool_id": "testpool",
"volumes": [
{
"nfs": {
"id": "43b37236-9afa-4855-8174-32254b9562e7",
"src_path": "192.168.8.150:/",
"dest_path": "/home/work/nas",
"read_only": false
}
},
{
"host_path": {
"src_path": "/root/work",
"dest_path": "/home/mind",
"read_only": false
}
}
]
}
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001943866685__section2441164182220"><h4 class="sectiontitle">Sample Response</h4><ul id="EN-US_TOPIC_0000001943866685__ul34175171223"><li id="EN-US_TOPIC_0000001943866685__li1452723202216">Successful response<pre class="screen" id="EN-US_TOPIC_0000001943866685__screen10527123212222">{
"is_success": true,
"job_id": "10",
"job_name": "TestModelArtsJob",
"status": "1",
"create_time": "1524189990635",
"version_id": "10",
"version_name": "V0001",
"resource_id": "jobafd08896"
}</pre>
</li><li id="EN-US_TOPIC_0000001943866685__li15281329224">Failed response<pre class="screen" id="EN-US_TOPIC_0000001943866685__screen10528183212212">{
"is_success": false,
"error_message": "Job name:TestModelArtsJob is existed",
"error_code": "ModelArts.0103"
}</pre>
</li></ul>
</div>
<p id="EN-US_TOPIC_0000001943866685__p31277134211"></p>
<div class="section" id="EN-US_TOPIC_0000001943866685__section16948739"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000001943866685__p1731954913014">For details about the status code, see <a href="modelarts_03_0094.html">Status Code</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="modelarts_03_0044.html">Training Jobs</a></div>
</div>
</div>
View Git Blame Copy Permalink