youjiageng1/doc-exports
1
0
Fork 0
forked from laiweijian4/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/modelarts_03_0060.html
Beibei 525370b67d
ModelArts GA API 06052022 from R&D (#14) 
ModelArts GA API 06052022 from R&D

R&D has provided a right version of ModelArts GA API (06052022)

Reviewed-by: Artem Goncharov <Artem.goncharov@gmail.com>
2022-05-23 16:26:34 +00:00

368 lines
36 KiB
HTML
Raw Blame History

<a name="modelarts_03_0060"></a><a name="modelarts_03_0060"></a>
<h1 class="topictitle1">Modifying a Training Job Configuration</h1>
<div id="body8662426"><div class="section" id="modelarts_03_0060__en-us_topic_0131292964_section36009104"><h4 class="sectiontitle">Function</h4><p id="modelarts_03_0060__en-us_topic_0131292964_p11491544">This API is used to modify a training job configuration.</p>
</div>
<div class="section" id="modelarts_03_0060__en-us_topic_0131292964_section55646480"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0060__en-us_topic_0131292964_p490851875512">PUT /v1/{project_id}/training-job-configs/{config_name}</p>
<div class="p" id="modelarts_03_0060__en-us_topic_0131292964_p11395125891"><a href="#modelarts_03_0060__en-us_topic_0131292964_table5935107791848">Table 1</a> describes the required parameters.
<div class="tablenoborder"><a name="modelarts_03_0060__en-us_topic_0131292964_table5935107791848"></a><a name="en-us_topic_0131292964_table5935107791848"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0060__en-us_topic_0131292964_table5935107791848" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0060__en-us_topic_0131292964_row4393448591848"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.2.5.1.1"><p id="modelarts_03_0060__en-us_topic_0131292964_p1756688391916">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.3.2.2.5.1.2"><p id="modelarts_03_0060__en-us_topic_0131292964_p1363142591916">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.2.3.2.2.5.1.3"><p id="modelarts_03_0060__en-us_topic_0131292964_p3040368091916">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.3.2.2.5.1.4"><p id="modelarts_03_0060__en-us_topic_0131292964_p23681614151847">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0060__en-us_topic_0131292964_row128743791848"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p2850081691916">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p2686476991916">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p2856268291916">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p3187594091916">Project ID. For details about how to obtain the project ID, see <a href="modelarts_03_0147.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row6211206791848"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p2682756291916">config_name</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p2554888591916">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p5619380991916">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p5540467791916">Name of a training job configuration</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="modelarts_03_0060__en-us_topic_0131292964_section31056272"><h4 class="sectiontitle">Request Body</h4><div class="p" id="modelarts_03_0060__en-us_topic_0131292964_p766802591012"><a href="#modelarts_03_0060__en-us_topic_0131292964_table5503766015447">Table 2</a> describes the request parameters.
<div class="tablenoborder"><a name="modelarts_03_0060__en-us_topic_0131292964_table5503766015447"></a><a name="en-us_topic_0131292964_table5503766015447"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0060__en-us_topic_0131292964_table5503766015447" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0060__en-us_topic_0131292964_row534239415447"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.2.5.1.1"><p id="modelarts_03_0060__en-us_topic_0131292964_p5956760615537">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.2.2.5.1.2"><p id="modelarts_03_0060__en-us_topic_0131292964_p6024675115537">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.2.2.5.1.3"><p id="modelarts_03_0060__en-us_topic_0131292964_p4814862415537">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48%" id="mcps1.3.3.2.2.2.5.1.4"><p id="modelarts_03_0060__en-us_topic_0131292964_p997834133911">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0060__en-us_topic_0131292964_row6661846515447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p4695045815537">config_desc</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p14372115965310">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1227185615537">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p5449625715537">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="modelarts_03_0060__en-us_topic_0131292964_row359914115447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p6643336815537">worker_server_num</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1239371215537">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p6436659215537">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p4631147315537">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="modelarts_03_0060__en-us_topic_0131292964_row5834071415447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p3916728515537">app_url</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1843354615537">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1672228015537">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1232741415537">Code directory of a training job, for example, <span class="filepath" id="modelarts_03_0060__en-us_topic_0131292964_filepath1428144974516"><b>/usr/app/</b></span>. This parameter must be used together with <strong id="modelarts_03_0060__en-us_topic_0131292964_b1411851815474">boot_file_url</strong>. After setting <strong id="modelarts_03_0060__en-us_topic_0131292964_b911991824713">model_id</strong>, you do not need to set <strong id="modelarts_03_0060__en-us_topic_0131292964_b8119151816478">app_url</strong> or <strong id="modelarts_03_0060__en-us_topic_0131292964_b711971844713">boot_file_url</strong>, and <strong id="modelarts_03_0060__en-us_topic_0131292964_b9119201834714">engine_id</strong>.</p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row2284608515447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p6120595215537">boot_file_url</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p5873507015537">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p5992023315537">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p3187110014526">Boot file of a training job, which needs to be stored in the code directory, for example, <span class="filepath" id="modelarts_03_0060__en-us_topic_0131292964_filepath176512530450"><b>/usr/app/boot.py</b></span>. This parameter must be used together with <strong id="modelarts_03_0060__en-us_topic_0131292964_b1239110224471">app_url</strong>. After setting <strong id="modelarts_03_0060__en-us_topic_0131292964_b1039642284715">model_id</strong>, you do not need to set <strong id="modelarts_03_0060__en-us_topic_0131292964_b8396722144717">app_url</strong> or <strong id="modelarts_03_0060__en-us_topic_0131292964_b1239622254716">boot_file_url</strong>, and <strong id="modelarts_03_0060__en-us_topic_0131292964_b33978226473">engine_id</strong>.</p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row877435616253"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p37741256102514">model_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p117741565251">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p157741256132517">Long</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p15841241743">Model ID of a training job. After setting <strong id="modelarts_03_0060__en-us_topic_0131292964_b17141358164516">model_id</strong>, you do not need to set <strong id="modelarts_03_0060__en-us_topic_0131292964_b121411158154515">app_url</strong> or <strong id="modelarts_03_0060__en-us_topic_0131292964_b0141195816452">boot_file_url</strong>, and <strong id="modelarts_03_0060__en-us_topic_0131292964_b11142155824519">engine_id</strong>.</p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row1402908715549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p205419715619">parameter</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p655755054219">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p5581875315619">Array&lt;Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p2502511115619">Running parameters of a training job. It is a collection of label-value pairs. This parameter is a container environment variable when a training job uses a custom image. For details, see <a href="#modelarts_03_0060__en-us_topic_0131292964_table1267642234716">Table 4</a>.</p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row4634107115559"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1107928315619">spec_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p2500672615619">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1227893415619">Long</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p5506957815619">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="modelarts_03_0060__en-us_topic_0131292964_row1358114194273"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1439022102713">data_url</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p14581141902720">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p165817190270">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p9793183711618">OBS URL of the dataset required by a training job, for example, <span class="filepath" id="modelarts_03_0060__en-us_topic_0131292964_filepath1089517184467"><b>/usr/data/</b></span>.</p>
<p id="modelarts_03_0060__en-us_topic_0131292964_p1299994574519">This parameter cannot be used together with <strong id="modelarts_03_0060__en-us_topic_0131292964_b4562034195710">data_source</strong> or <strong id="modelarts_03_0060__en-us_topic_0131292964_b12613342574">dataset_id</strong> and <strong id="modelarts_03_0060__en-us_topic_0131292964_b1261113425719">dataset_version_id</strong>. However, one of the parameters must exist.</p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row1576243122819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p127631537289">dataset_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p37452284284">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p576316318288">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p876311362817">Dataset ID of a training job. This parameter must be used together with <strong id="modelarts_03_0060__en-us_topic_0131292964_b1612517378574">dataset_version_id</strong>, but cannot be used together with <strong id="modelarts_03_0060__en-us_topic_0131292964_b18130133795713">data_url</strong> or <strong id="modelarts_03_0060__en-us_topic_0131292964_b6130137165720">data_source</strong>.</p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row4916853289"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p199162057286">dataset_version_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p17799165015559">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p991715582812">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p44929535618">Dataset version ID of a training job. This parameter must be used together with <strong id="modelarts_03_0060__en-us_topic_0131292964_b66351843145717">dataset_id</strong>, but cannot be used together with <strong id="modelarts_03_0060__en-us_topic_0131292964_b1464014365710">data_url</strong> or <strong id="modelarts_03_0060__en-us_topic_0131292964_b8641443135710">data_source</strong>.</p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row1095732592313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1084415185810">data_source</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p9844121105816">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p18441318589">JSON Array</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p186130125511">Dataset of a training job. This parameter cannot be used together with <strong id="modelarts_03_0060__en-us_topic_0131292964_b6354547135720">data_url</strong> or <strong id="modelarts_03_0060__en-us_topic_0131292964_b103591647105713">dataset_id</strong> and <strong id="modelarts_03_0060__en-us_topic_0131292964_b135964755720">dataset_version_id</strong>. For details, see <a href="#modelarts_03_0060__en-us_topic_0131292964_table250595919011">Table 3</a>.</p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row520737311568"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p6448902415619">engine_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p5622843315619">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p5820925615619">Long</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1732925815619">ID of the engine selected for a training job. The default value is <span class="parmname" id="modelarts_03_0060__en-us_topic_0131292964_parmname132320249463"><b>1</b></span>. 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="modelarts_03_0060__en-us_topic_0131292964_row1357012017283"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p10570220132819">train_url</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1357072022812">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p25701120172820">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p76822506429">OBS URL of the output file of a training job. By default, this parameter is left blank. Example value: <span class="filepath" id="modelarts_03_0060__en-us_topic_0131292964_filepath57712343465"><b>/usr/train/</b></span></p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row91617595515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p106881050154220">log_url</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p069365094212">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1369555013425">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p9699950194211">OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: <span class="filepath" id="modelarts_03_0060__en-us_topic_0131292964_filepath495193710466"><b>/usr/train/</b></span></p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row16726251165"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p255514164311">user_image_url</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p5555144113435">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p5555841114318">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p755554118434">SWR URL of a custom image used by a training job. Example value: <span class="filepath" id="modelarts_03_0060__en-us_topic_0131292964_filepath20441134224618"><b>100.125.5.235:20202/jobmng/custom-cpu-base:1.0</b></span></p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row04571387164"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p46411034174620">user_command</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p11641434154610">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1364113434619">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p17641113410465">Boot command used to start the container of a custom image of a training job. The format is <span class="filepath" id="modelarts_03_0060__en-us_topic_0131292964_filepath1755117454469"><b>bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}</b></span>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="modelarts_03_0060__en-us_topic_0131292964_table250595919011"></a><a name="en-us_topic_0131292964_table250595919011"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0060__en-us_topic_0131292964_table250595919011" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="modelarts_03_0060__en-us_topic_0131292964_b7213125511135">data_source</strong> parameters</caption><thead align="left"><tr id="modelarts_03_0060__en-us_topic_0131292964_row55072591012"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="modelarts_03_0060__en-us_topic_0131292964_p1527511378117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.3.2.5.1.2"><p id="modelarts_03_0060__en-us_topic_0131292964_p1628153716110">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.3.2.5.1.3"><p id="modelarts_03_0060__en-us_topic_0131292964_p22831437411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.3.2.5.1.4"><p id="modelarts_03_0060__en-us_topic_0131292964_p328510371619">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0060__en-us_topic_0131292964_row2507159009"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1680105517118">dataset_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.3.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p2804555115">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.3.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1180619554119">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p18097554112">Dataset ID of a training job. This parameter must be used together with <strong id="modelarts_03_0060__en-us_topic_0131292964_b4755145405716">dataset_version_id</strong>, but cannot be used together with <strong id="modelarts_03_0060__en-us_topic_0131292964_b1576105425713">data_url</strong>.</p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row205071598010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p118131955110">dataset_version</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.3.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p148201755118">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.3.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1282320551611">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p0823205511117">Dataset version ID of a training job. This parameter must be used together with <strong id="modelarts_03_0060__en-us_topic_0131292964_b1876165711573">dataset_id</strong>, but cannot be used together with <strong id="modelarts_03_0060__en-us_topic_0131292964_b98215573575">data_url</strong>.</p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row589115610214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p16892761827">type</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.3.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1892116628">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.3.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p188923615217">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p88921866216">Dataset type. The value can be <span class="parmvalue" id="modelarts_03_0060__en-us_topic_0131292964_parmvalue18495354614"><b>obs</b></span> or <span class="parmvalue" id="modelarts_03_0060__en-us_topic_0131292964_parmvalue291953114617"><b>dataset</b></span>. obs and dataset cannot be used at the same time.</p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row1057819414237"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p13117227131918">data_url</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.3.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p131171127181920">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.3.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p011752719191">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p141171327171918">OBS bucket path. This parameter cannot be used together with <strong id="modelarts_03_0060__en-us_topic_0131292964_b14616752582">dataset_id</strong> or <strong id="modelarts_03_0060__en-us_topic_0131292964_b126219512589">dataset_version</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="modelarts_03_0060__en-us_topic_0131292964_table1267642234716"></a><a name="en-us_topic_0131292964_table1267642234716"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0060__en-us_topic_0131292964_table1267642234716" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="modelarts_03_0060__en-us_topic_0131292964_b086723111514">parameter</strong> parameters</caption><thead align="left"><tr id="modelarts_03_0060__en-us_topic_0131292964_row5677422164714"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="modelarts_03_0060__en-us_topic_0131292964_p7296205262817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.4.2.5.1.2"><p id="modelarts_03_0060__en-us_topic_0131292964_p11128165034910">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.4.2.5.1.3"><p id="modelarts_03_0060__en-us_topic_0131292964_p196771122154718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.4.2.5.1.4"><p id="modelarts_03_0060__en-us_topic_0131292964_p5677022194719">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0060__en-us_topic_0131292964_row2677192224717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p14677192217478">label</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.4.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1512818502494">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.4.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p16677112218473">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p10677142210478">Parameter name.</p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row5528181488"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p05295804810">value</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.4.2.5.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p14128650124918">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.4.2.5.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p135299824812">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="modelarts_03_0060__en-us_topic_0131292964_p1652913874819">Parameter value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="modelarts_03_0060__en-us_topic_0131292964_section11070993"><h4 class="sectiontitle">Response Body</h4><div class="p" id="modelarts_03_0060__en-us_topic_0131292964_p111869146129"><a href="#modelarts_03_0060__en-us_topic_0131292964_table5371703815645">Table 5</a> describes the response parameters.
<div class="tablenoborder"><a name="modelarts_03_0060__en-us_topic_0131292964_table5371703815645"></a><a name="en-us_topic_0131292964_table5371703815645"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0060__en-us_topic_0131292964_table5371703815645" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0060__en-us_topic_0131292964_row740119415645"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.2.4.1.1"><p id="modelarts_03_0060__en-us_topic_0131292964_p5890372115656">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.2.2.2.4.1.2"><p id="modelarts_03_0060__en-us_topic_0131292964_p5447652915656">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="66%" id="mcps1.3.4.2.2.2.4.1.3"><p id="modelarts_03_0060__en-us_topic_0131292964_p9489193773920">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0060__en-us_topic_0131292964_row74354510131"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p2530905217407">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p2536505617407">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p4130369517407">Whether the request is successful</p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row142758496236"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p14275114915230">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p9276204919233">String</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p154155962314">Error message of a failed API call.</p>
<p id="modelarts_03_0060__en-us_topic_0131292964_p1455859112318">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="modelarts_03_0060__en-us_topic_0131292964_row3990309915645"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0060__en-us_topic_0131292964_p5981669415656">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0060__en-us_topic_0131292964_p469328915656">String</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0060__en-us_topic_0131292964_p4461216215656">Error code of a failed API call. For details, see <a href="modelarts_03_0095.html">Error Codes</a>. This parameter is not included when the API call succeeds.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="modelarts_03_0060__en-us_topic_0131292964_section144321614117"><h4 class="sectiontitle">Samples</h4><ol id="modelarts_03_0060__en-us_topic_0131292964_ol13497121511418"><li id="modelarts_03_0060__en-us_topic_0131292964_li1349718154416">The following shows how to modify the job parameter configuration named <span class="parmvalue" id="modelarts_03_0060__en-us_topic_0131292964_parmvalue1821271116479"><b>config</b></span>.<ul id="modelarts_03_0060__en-us_topic_0131292964_ul164441217510"><li id="modelarts_03_0060__en-us_topic_0131292964_li744616119515">Sample request<pre class="screen" id="modelarts_03_0060__en-us_topic_0131292964_screen54331729336">PUT https://endpoint/v1/{project_id}/training-job-configs/config
{
"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
},
{
"key": "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/"
}</pre>
</li></ul>
<div class="p" id="modelarts_03_0060__en-us_topic_0131292964_p20181736101217"><ul id="modelarts_03_0060__en-us_topic_0131292964_ul98581148151213"><li id="modelarts_03_0060__en-us_topic_0131292964_li839501">Successful sample response<pre class="screen" id="modelarts_03_0060__en-us_topic_0131292964_screen155083912416">{
"is_success": true
}</pre>
</li><li id="modelarts_03_0060__en-us_topic_0131292964_li8865144881214">Failed sample response<pre class="screen" id="modelarts_03_0060__en-us_topic_0131292964_screen646718162411">{
"is_success": false,
"error_message": "Error string",
"error_code": "ModelArts.0105"
}</pre>
</li></ul>
</div>
</li></ol>
</div>
<div class="section" id="modelarts_03_0060__en-us_topic_0131292964_section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0060__en-us_topic_0131292964_p1731954913014">For details about the status code, see <a href="modelarts_03_0094.html#modelarts_03_0094__en-us_topic_0132773864_table1450010510213">Table 1</a>.</p>
</div>
<div class="section" id="modelarts_03_0060__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0060__p1572811255123">See <a href="modelarts_03_0095.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="modelarts_03_0057.html">Training Job Parameter Configuration</a></div>
</div>
</div>
View Git Blame Copy Permalink