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

367 lines
34 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002341058494"></a><a name="EN-US_TOPIC_0000002341058494"></a>
<h1 class="topictitle1">Creating a Training Job Configuration</h1>
<div id="body1536915643272"><div class="section" id="EN-US_TOPIC_0000002341058494__section55876439"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002341058494__p27912218">This API is used to create a training job configuration.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002341058494__section33125904"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002341058494__p18689865012">POST /v1/{project_id}/training-job-configs</p>
<div class="p" id="EN-US_TOPIC_0000002341058494__p19800672308"><a href="#EN-US_TOPIC_0000002341058494__table20736351173356">Table 1</a> describes the required parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058494__table20736351173356"></a><a name="table20736351173356"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058494__table20736351173356" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002341058494__row5314023173356"><th align="left" class="cellrowborder" valign="top" width="17.11%" id="mcps1.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000002341058494__p10746977173422">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.03%" id="mcps1.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000002341058494__p65198818173422">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000002341058494__p46612907173422">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.86%" id="mcps1.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000002341058494__p23681614151847">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058494__row18124941173356"><td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p48322763173422">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.03%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p21829702173422">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p23375442173422">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.86%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p14362646173422">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>
<div class="section" id="EN-US_TOPIC_0000002341058494__section29697687"><h4 class="sectiontitle">Request Body</h4><div class="p" id="EN-US_TOPIC_0000002341058494__p911145901910"><a href="#EN-US_TOPIC_0000002341058494__table25599433145051">Table 2</a> describes the request parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058494__table25599433145051"></a><a name="table25599433145051"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058494__table25599433145051" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002341058494__row54491131145051"><th align="left" class="cellrowborder" valign="top" width="18.37%" id="mcps1.3.3.2.2.2.5.1.1"><p id="EN-US_TOPIC_0000002341058494__p4299884314526">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.58%" id="mcps1.3.3.2.2.2.5.1.2"><p id="EN-US_TOPIC_0000002341058494__p6035426014526">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.46%" id="mcps1.3.3.2.2.2.5.1.3"><p id="EN-US_TOPIC_0000002341058494__p5685692614526">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.59%" id="mcps1.3.3.2.2.2.5.1.4"><p id="EN-US_TOPIC_0000002341058494__p13138181213913">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058494__row21252246145051"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p49118314526">config_name</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p3978586714526">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p142979114526">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p4870427614526">Name of a training job configuration. The value must contain 1 to 64 characters consisting of only digits, letters, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row22008750145051"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p482870714526">config_desc</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p5558099214526">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p576652214526">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p6443512814526">Description of a training job configuration. The value must contain 0 to 256 characters. By default, this parameter is left blank.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row20880720145051"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p6411276414526">worker_server_num</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p2575141314526">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p548967814526">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p4201073514526">Number of workers in a training job. Obtain the maximum value from <a href="modelarts_03_0072.html">Querying Job Resource Specifications</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row44111646145051"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p1354730314526">app_url</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p2358974014526">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p3172080214526">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p1924817614526">Code directory of a training job, for example, <span class="filepath" id="EN-US_TOPIC_0000002341058494__filepath1653333513156"><b>/usr/app/</b></span>. This parameter must be used together with <strong id="EN-US_TOPIC_0000002341058494__b184581813466">boot_file_url</strong>. After setting <strong id="EN-US_TOPIC_0000002341058494__b925625334615">model_id</strong>, you do not need to set <strong id="EN-US_TOPIC_0000002341058494__b12294175624610">app_url</strong> or <strong id="EN-US_TOPIC_0000002341058494__b4713258134611">boot_file_url</strong>, and <strong id="EN-US_TOPIC_0000002341058494__b146835044718">engine_id</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row1674388145051"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p616844714526">boot_file_url</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p2988216114526">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p453599214526">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p3187110014526">Boot file of a training job, which needs to be stored in the code directory, for example, <span class="filepath" id="EN-US_TOPIC_0000002341058494__filepath142402040101517"><b>/usr/app/boot.py</b></span>. This parameter must be used together with <strong id="EN-US_TOPIC_0000002341058494__b479815455154">app_url</strong>. After setting <strong id="EN-US_TOPIC_0000002341058494__b14805134510153">model_id</strong>, you do not need to set <strong id="EN-US_TOPIC_0000002341058494__b19805144511519">app_url</strong> or <strong id="EN-US_TOPIC_0000002341058494__b15805134510156">boot_file_url</strong>, and <strong id="EN-US_TOPIC_0000002341058494__b68050451157">engine_id</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row48409411411"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p484111418412">model_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p1784114411343">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p98418414419">Long</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p15841241743">Model ID of a training job. After setting <strong id="EN-US_TOPIC_0000002341058494__b18792171571616">model_id</strong>, you do not need to set <strong id="EN-US_TOPIC_0000002341058494__b1179318154164">app_url</strong> or <strong id="EN-US_TOPIC_0000002341058494__b1979311156165">boot_file_url</strong>, and <strong id="EN-US_TOPIC_0000002341058494__b47938156165">engine_id</strong>. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row60427098145235"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p19496561145315">parameter</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p655755054219">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p1895915226334">Array&lt;Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p66408641145315">Running parameters of a training job. It is a collection of label-value pairs. 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_0000002341058494__table1267642234716">Table 4</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row59887426145245"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p35428076145315">spec_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p51101945145315">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p45616870145315">Long</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p3978971145315">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>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row45623221562"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p95513273618">data_url</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p1156216221614">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p1756232215619">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p9793183711618">OBS URL of the dataset required by a training job, for example, <span class="filepath" id="EN-US_TOPIC_0000002341058494__filepath3821341142713"><b>/usr/data/</b></span>.</p>
<p id="EN-US_TOPIC_0000002341058494__p1299994574519">This parameter cannot be used together with <strong id="EN-US_TOPIC_0000002341058494__b872714363565">data_source</strong> or <strong id="EN-US_TOPIC_0000002341058494__b1472723635612">dataset_id</strong> and <strong id="EN-US_TOPIC_0000002341058494__b167281736175613">dataset_version_id</strong>. However, one of the parameters must exist.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row1170519221613"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p1570516225614">dataset_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p8129101010710">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p170792220616">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p207071422967">Dataset ID of a training job. This parameter must be used together with <strong id="EN-US_TOPIC_0000002341058494__b14185242135613">dataset_version_id</strong>, but cannot be used together with <strong id="EN-US_TOPIC_0000002341058494__b419054218568">data_url</strong> or <strong id="EN-US_TOPIC_0000002341058494__b1019014212567">data_source</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row194921553366"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p34924531265">dataset_version_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p7690192720">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p2049235314616">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p44929535618">Dataset version ID of a training job. This parameter must be used together with <strong id="EN-US_TOPIC_0000002341058494__b1531417500561">dataset_id</strong>, but cannot be used together with <strong id="EN-US_TOPIC_0000002341058494__b1831911500562">data_url</strong> or <strong id="EN-US_TOPIC_0000002341058494__b1932020507560">data_source</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row177795578011"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p1084415185810">data_source</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p9844121105816">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p18441318589">JSON Array</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p884414112581">Dataset of a training job. This parameter cannot be used together with <strong id="EN-US_TOPIC_0000002341058494__b41641537568">data_url</strong> or <strong id="EN-US_TOPIC_0000002341058494__b13165453195613">dataset_id</strong> and <strong id="EN-US_TOPIC_0000002341058494__b161651953125613">dataset_version_id</strong>. For details, see <a href="#EN-US_TOPIC_0000002341058494__table11121353175910">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row60427545145250"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p685055145315">engine_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p55489534145315">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p65467302145315">Long</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p1251230145315">ID of the engine selected for a training job. The default value is <span class="parmname" id="EN-US_TOPIC_0000002341058494__parmname9566144714270"><b>1</b></span>. After setting <strong id="EN-US_TOPIC_0000002341058494__b2098321573516">model_id</strong>, you do not need to set <strong id="EN-US_TOPIC_0000002341058494__b166421418183517">app_url</strong> or <strong id="EN-US_TOPIC_0000002341058494__b4309192123519">boot_file_url</strong>, and <strong id="EN-US_TOPIC_0000002341058494__b16381223103515">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_0000002341058494__row121912580518"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p22195582052">train_url</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p1946152016713">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p10219195817515">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p13770114215819">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_0000002341058494__filepath664414252811"><b>/usr/train/</b></span></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row7847108135116"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p106881050154220">log_url</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p069365094212">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p1369555013425">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__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_0000002341058494__filepath123131668285"><b>/usr/train/</b></span></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row5622131511415"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p255514164311">user_image_url</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p5555144113435">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p5555841114318">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p755554118434">SWR URL of a custom image used by a training job. Example value: <span class="filepath" id="EN-US_TOPIC_0000002341058494__filepath19188121315287"><b>100.125.5.235:20202/jobmng/custom-cpu-base:1.0</b></span></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row2542818181411"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p46411034174620">user_command</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p11641434154610">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.46%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p1364113434619">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__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_0000002341058494__filepath11938131619287"><b>bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}</b></span>. The boot script <strong id="EN-US_TOPIC_0000002341058494__b7763723174620">run_train.sh</strong> must be invoked to initialize variables, such as the AK/SK. The <strong id="EN-US_TOPIC_0000002341058494__b13102246182310">run_train.sh</strong> script is followed by <strong id="EN-US_TOPIC_0000002341058494__b169823571238">python</strong> to ensure that the Python files can be executed in the initialized variable environment. <strong id="EN-US_TOPIC_0000002341058494__b15363617132410">run_train.sh</strong> is used to start Python.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058494__table11121353175910"></a><a name="table11121353175910"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058494__table11121353175910" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0000002341058494__b1133729181315">data_source</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002341058494__row91130534596"><th align="left" class="cellrowborder" valign="top" width="17.43%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002341058494__p1527511378117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.57%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000002341058494__p1628153716110">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.940000000000001%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000002341058494__p22831437411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.06%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000002341058494__p328510371619">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058494__row5113185319593"><td class="cellrowborder" valign="top" width="17.43%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p1680105517118">dataset_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.57%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p2804555115">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.940000000000001%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p1180619554119">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.06%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p18097554112">Dataset ID of a training job. This parameter must be used together with <strong id="EN-US_TOPIC_0000002341058494__b19337149185711">dataset_version_id</strong>, but cannot be used together with <strong id="EN-US_TOPIC_0000002341058494__b13427965715">data_url</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row81131536592"><td class="cellrowborder" valign="top" width="17.43%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p118131955110">dataset_version</p>
</td>
<td class="cellrowborder" valign="top" width="14.57%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p148201755118">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.940000000000001%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p1282320551611">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.06%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p0823205511117">Dataset version ID of a training job. This parameter must be used together with <strong id="EN-US_TOPIC_0000002341058494__b1035419124574">dataset_id</strong>, but cannot be used together with <strong id="EN-US_TOPIC_0000002341058494__b12355161213574">data_url</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row41132531595"><td class="cellrowborder" valign="top" width="17.43%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p16892761827">type</p>
</td>
<td class="cellrowborder" valign="top" width="14.57%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p1892116628">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.940000000000001%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p188923615217">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.06%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p88921866216">Dataset type. The value can be <span class="parmvalue" id="EN-US_TOPIC_0000002341058494__parmvalue1961010232283"><b>obs</b></span> or <span class="parmvalue" id="EN-US_TOPIC_0000002341058494__parmvalue461552319284"><b>dataset</b></span>. obs and dataset cannot be used at the same time.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row1128016438220"><td class="cellrowborder" valign="top" width="17.43%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p13117227131918">data_url</p>
</td>
<td class="cellrowborder" valign="top" width="14.57%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p131171127181920">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.940000000000001%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p011752719191">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.06%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p141171327171918">OBS bucket path. This parameter cannot be used together with <strong id="EN-US_TOPIC_0000002341058494__b84348231572">dataset_id</strong> or <strong id="EN-US_TOPIC_0000002341058494__b17435152305716">dataset_version</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058494__table1267642234716"></a><a name="table1267642234716"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058494__table1267642234716" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0000002341058494__b5882201216424">parameter</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002341058494__row5677422164714"><th align="left" class="cellrowborder" valign="top" width="17.36826317368263%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000002341058494__p7296205262817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.808519148085193%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0000002341058494__p11324245104718">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.898810118988102%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0000002341058494__p196771122154718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.92440755924408%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0000002341058494__p5677022194719">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058494__row2677192224717"><td class="cellrowborder" valign="top" width="17.36826317368263%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p14677192217478">label</p>
</td>
<td class="cellrowborder" valign="top" width="14.808519148085193%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p932424514472">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.898810118988102%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p16677112218473">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.92440755924408%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p10677142210478">Parameter name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row5528181488"><td class="cellrowborder" valign="top" width="17.36826317368263%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058494__p05295804810">value</p>
</td>
<td class="cellrowborder" valign="top" width="14.808519148085193%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058494__p103249451478">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.898810118988102%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058494__p135299824812">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.92440755924408%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058494__p1652913874819">Parameter value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002341058494__section65952596"><h4 class="sectiontitle">Response Body</h4><div class="p" id="EN-US_TOPIC_0000002341058494__p1010672813414"><a href="#EN-US_TOPIC_0000002341058494__table66235177145332">Table 5</a> describes the response parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058494__table66235177145332"></a><a name="table66235177145332"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058494__table66235177145332" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002341058494__row66295949145332"><th align="left" class="cellrowborder" valign="top" width="17.419999999999998%" id="mcps1.3.4.2.2.2.4.1.1"><p id="EN-US_TOPIC_0000002341058494__p2889638414545">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.25%" id="mcps1.3.4.2.2.2.4.1.2"><p id="EN-US_TOPIC_0000002341058494__p663607214545">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="69.33%" id="mcps1.3.4.2.2.2.4.1.3"><p id="EN-US_TOPIC_0000002341058494__p1926718156397">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058494__row114483719340"><td class="cellrowborder" valign="top" width="17.419999999999998%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058494__p2530905217407">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="13.25%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058494__p2536505617407">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="69.33%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058494__p4130369517407">Whether the request is successful</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row1619911616101"><td class="cellrowborder" valign="top" width="17.419999999999998%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058494__p131999616103">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="13.25%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058494__p21993631015">String</p>
</td>
<td class="cellrowborder" valign="top" width="69.33%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058494__p17613181619105">Error message of a failed API call.</p>
<p id="EN-US_TOPIC_0000002341058494__p1561551611020">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058494__row3469265145332"><td class="cellrowborder" valign="top" width="17.419999999999998%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058494__p4612298614545">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="13.25%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058494__p1904430514545">String</p>
</td>
<td class="cellrowborder" valign="top" width="69.33%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058494__p6619373314545">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_0000002341058494__p6009218614545">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002341058494__section049897173115"><h4 class="sectiontitle">Sample Request</h4><div class="p" id="EN-US_TOPIC_0000002341058494__p9746604581">The following shows how to create a training job configuration whose name is <span class="parmvalue" id="EN-US_TOPIC_0000002341058494__parmvalue185891227647"><b>testConfig</b></span> and description is <span class="parmvalue" id="EN-US_TOPIC_0000002341058494__parmvalue65892027943"><b>This is config</b></span>.<pre class="screen" id="EN-US_TOPIC_0000002341058494__screen18316185622617">POST https://endpoint/v1/{project_id}/training-job-configs
{
"config_name": "testConfig",
"config_desc": "This is 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"
}
],
"spec_id": 1,
"dataset_id": "38277e62-9e59-48f4-8d89-c8cf41622c24",
"dataset_version_id": "2ff0d6ba-c480-45ae-be41-09a8369bfc90",
"engine_id": 1,
"train_url": "/usr/train/",
"log_url": "/usr/log/",
"model_id": 1
}</pre>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002341058494__section1839881614588"><h4 class="sectiontitle">Sample Response</h4><ul id="EN-US_TOPIC_0000002341058494__ul6941102916585"><li id="EN-US_TOPIC_0000002341058494__li594162911585">Successful response<pre class="screen" id="EN-US_TOPIC_0000002341058494__screen19941429155818">{
"is_success": true
}</pre>
</li><li id="EN-US_TOPIC_0000002341058494__li7941112916585">Failed response<pre class="screen" id="EN-US_TOPIC_0000002341058494__screen199411629155812">{
"is_success": false,
"error_message": "Error string",
"error_code": "ModelArts.0105"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000002341058494__section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000002341058494__p123531511131617">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_0057.html">Training Job Parameter Configuration</a></div>
</div>
</div>
View Git Blame Copy Permalink