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

366 lines
34 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001943866621"></a><a name="EN-US_TOPIC_0000001943866621"></a>
<h1 class="topictitle1">Modifying a Training Job Configuration</h1>
<div id="body1536915643272"><div class="section" id="EN-US_TOPIC_0000001943866621__section36009104"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001943866621__p11491544">This API is used to modify a training job configuration.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001943866621__section55646480"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001943866621__p490851875512">PUT /v1/{project_id}/training-job-configs/{config_name}</p>
<div class="p" id="EN-US_TOPIC_0000001943866621__p11395125891"><a href="#EN-US_TOPIC_0000001943866621__table5935107791848">Table 1</a> describes the required parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943866621__table5935107791848"></a><a name="table5935107791848"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943866621__table5935107791848" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943866621__row4393448591848"><th align="left" class="cellrowborder" valign="top" width="17.578242175782425%" id="mcps1.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001943866621__p1756688391916">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.03839616038396%" id="mcps1.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001943866621__p1363142591916">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.648835116488351%" id="mcps1.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001943866621__p3040368091916">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.73452654734526%" id="mcps1.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001943866621__p23681614151847">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001943866621__row128743791848"><td class="cellrowborder" valign="top" width="17.578242175782425%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p2850081691916">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.03839616038396%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p2686476991916">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.648835116488351%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p2856268291916">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.73452654734526%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p3187594091916">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>
<tr id="EN-US_TOPIC_0000001943866621__row6211206791848"><td class="cellrowborder" valign="top" width="17.578242175782425%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p2682756291916">config_name</p>
</td>
<td class="cellrowborder" valign="top" width="16.03839616038396%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p2554888591916">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.648835116488351%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p5619380991916">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.73452654734526%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p5540467791916">Name of a training job configuration</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001943866621__section31056272"><h4 class="sectiontitle">Request Body</h4><div class="p" id="EN-US_TOPIC_0000001943866621__p766802591012"><a href="#EN-US_TOPIC_0000001943866621__table5503766015447">Table 2</a> describes the request parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943866621__table5503766015447"></a><a name="table5503766015447"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943866621__table5503766015447" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943866621__row534239415447"><th align="left" class="cellrowborder" valign="top" width="18.53%" id="mcps1.3.3.2.2.2.5.1.1"><p id="EN-US_TOPIC_0000001943866621__p5956760615537">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.69%" id="mcps1.3.3.2.2.2.5.1.2"><p id="EN-US_TOPIC_0000001943866621__p6024675115537">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.490000000000002%" id="mcps1.3.3.2.2.2.5.1.3"><p id="EN-US_TOPIC_0000001943866621__p4814862415537">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.290000000000006%" id="mcps1.3.3.2.2.2.5.1.4"><p id="EN-US_TOPIC_0000001943866621__p997834133911">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001943866621__row6661846515447"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p4695045815537">config_desc</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p14372115965310">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p1227185615537">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__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="EN-US_TOPIC_0000001943866621__row359914115447"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p6643336815537">worker_server_num</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p1239371215537">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p6436659215537">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__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="EN-US_TOPIC_0000001943866621__row5834071415447"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p3916728515537">app_url</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p1843354615537">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p1672228015537">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p1232741415537">Code directory of a training job, for example, <span class="filepath" id="EN-US_TOPIC_0000001943866621__filepath1428144974516"><b>/usr/app/</b></span>. This parameter must be used together with <strong id="EN-US_TOPIC_0000001943866621__b1411851815474">boot_file_url</strong>. After setting <strong id="EN-US_TOPIC_0000001943866621__b911991824713">model_id</strong>, you do not need to set <strong id="EN-US_TOPIC_0000001943866621__b8119151816478">app_url</strong> or <strong id="EN-US_TOPIC_0000001943866621__b711971844713">boot_file_url</strong>, and <strong id="EN-US_TOPIC_0000001943866621__b9119201834714">engine_id</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row2284608515447"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p6120595215537">boot_file_url</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p5873507015537">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p5992023315537">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__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_0000001943866621__filepath176512530450"><b>/usr/app/boot.py</b></span>. This parameter must be used together with <strong id="EN-US_TOPIC_0000001943866621__b1239110224471">app_url</strong>. After setting <strong id="EN-US_TOPIC_0000001943866621__b1039642284715">model_id</strong>, you do not need to set <strong id="EN-US_TOPIC_0000001943866621__b8396722144717">app_url</strong> or <strong id="EN-US_TOPIC_0000001943866621__b1239622254716">boot_file_url</strong>, and <strong id="EN-US_TOPIC_0000001943866621__b33978226473">engine_id</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row877435616253"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p37741256102514">model_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p117741565251">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p157741256132517">Long</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p15841241743">Model ID of a training job. After setting <strong id="EN-US_TOPIC_0000001943866621__b17141358164516">model_id</strong>, you do not need to set <strong id="EN-US_TOPIC_0000001943866621__b121411158154515">app_url</strong> or <strong id="EN-US_TOPIC_0000001943866621__b0141195816452">boot_file_url</strong>, and <strong id="EN-US_TOPIC_0000001943866621__b11142155824519">engine_id</strong>. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row1402908715549"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p205419715619">parameter</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p655755054219">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p5581875315619">Array&lt;Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__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="#EN-US_TOPIC_0000001943866621__table1267642234716">Table 4</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row4634107115559"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p1107928315619">spec_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p2500672615619">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p1227893415619">Long</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__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="EN-US_TOPIC_0000001943866621__row1358114194273"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p1439022102713">data_url</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p14581141902720">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p165817190270">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p9793183711618">OBS URL of the dataset required by a training job, for example, <span class="filepath" id="EN-US_TOPIC_0000001943866621__filepath1089517184467"><b>/usr/data/</b></span>.</p>
<p id="EN-US_TOPIC_0000001943866621__p1299994574519">This parameter cannot be used together with <strong id="EN-US_TOPIC_0000001943866621__b4562034195710">data_source</strong> or <strong id="EN-US_TOPIC_0000001943866621__b12613342574">dataset_id</strong> and <strong id="EN-US_TOPIC_0000001943866621__b1261113425719">dataset_version_id</strong>. However, one of the parameters must exist.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row1576243122819"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p127631537289">dataset_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p37452284284">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p576316318288">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p876311362817">Dataset ID of a training job. This parameter must be used together with <strong id="EN-US_TOPIC_0000001943866621__b1612517378574">dataset_version_id</strong>, but cannot be used together with <strong id="EN-US_TOPIC_0000001943866621__b18130133795713">data_url</strong> or <strong id="EN-US_TOPIC_0000001943866621__b6130137165720">data_source</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row4916853289"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p199162057286">dataset_version_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p17799165015559">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p991715582812">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p44929535618">Dataset version ID of a training job. This parameter must be used together with <strong id="EN-US_TOPIC_0000001943866621__b66351843145717">dataset_id</strong>, but cannot be used together with <strong id="EN-US_TOPIC_0000001943866621__b1464014365710">data_url</strong> or <strong id="EN-US_TOPIC_0000001943866621__b8641443135710">data_source</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row1095732592313"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p1084415185810">data_source</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p9844121105816">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p18441318589">JSON Array</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p186130125511">Dataset of a training job. This parameter cannot be used together with <strong id="EN-US_TOPIC_0000001943866621__b6354547135720">data_url</strong> or <strong id="EN-US_TOPIC_0000001943866621__b103591647105713">dataset_id</strong> and <strong id="EN-US_TOPIC_0000001943866621__b135964755720">dataset_version_id</strong>. For details, see <a href="#EN-US_TOPIC_0000001943866621__table250595919011">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row520737311568"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p6448902415619">engine_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p5622843315619">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p5820925615619">Long</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p1732925815619">ID of the engine selected for a training job. The default value is <span class="parmname" id="EN-US_TOPIC_0000001943866621__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="EN-US_TOPIC_0000001943866621__row1357012017283"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p10570220132819">train_url</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p1357072022812">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p25701120172820">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__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_0000001943866621__filepath57712343465"><b>/usr/train/</b></span></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row91617595515"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p106881050154220">log_url</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p069365094212">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p1369555013425">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__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_0000001943866621__filepath495193710466"><b>/usr/train/</b></span></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row16726251165"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p255514164311">user_image_url</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p5555144113435">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p5555841114318">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p755554118434">SWR URL of a custom image used by a training job. Example value: <span class="filepath" id="EN-US_TOPIC_0000001943866621__filepath20441134224618"><b>100.125.5.235:20202/jobmng/custom-cpu-base:1.0</b></span></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row04571387164"><td class="cellrowborder" valign="top" width="18.53%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p46411034174620">user_command</p>
</td>
<td class="cellrowborder" valign="top" width="16.69%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p11641434154610">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.490000000000002%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p1364113434619">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.290000000000006%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__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_0000001943866621__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="EN-US_TOPIC_0000001943866621__table250595919011"></a><a name="table250595919011"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943866621__table250595919011" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0000001943866621__b7213125511135">data_source</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943866621__row55072591012"><th align="left" class="cellrowborder" valign="top" width="18.39%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001943866621__p1527511378117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.78%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001943866621__p1628153716110">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.790000000000001%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001943866621__p22831437411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.04%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001943866621__p328510371619">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001943866621__row2507159009"><td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p1680105517118">dataset_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.78%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p2804555115">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.790000000000001%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p1180619554119">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.04%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p18097554112">Dataset ID of a training job. This parameter must be used together with <strong id="EN-US_TOPIC_0000001943866621__b4755145405716">dataset_version_id</strong>, but cannot be used together with <strong id="EN-US_TOPIC_0000001943866621__b1576105425713">data_url</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row205071598010"><td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p118131955110">dataset_version</p>
</td>
<td class="cellrowborder" valign="top" width="16.78%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p148201755118">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.790000000000001%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p1282320551611">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.04%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p0823205511117">Dataset version ID of a training job. This parameter must be used together with <strong id="EN-US_TOPIC_0000001943866621__b1876165711573">dataset_id</strong>, but cannot be used together with <strong id="EN-US_TOPIC_0000001943866621__b98215573575">data_url</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row589115610214"><td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p16892761827">type</p>
</td>
<td class="cellrowborder" valign="top" width="16.78%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p1892116628">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.790000000000001%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p188923615217">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.04%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p88921866216">Dataset type. The value can be <span class="parmvalue" id="EN-US_TOPIC_0000001943866621__parmvalue18495354614"><b>obs</b></span> or <span class="parmvalue" id="EN-US_TOPIC_0000001943866621__parmvalue291953114617"><b>dataset</b></span>. obs and dataset cannot be used at the same time.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row1057819414237"><td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p13117227131918">data_url</p>
</td>
<td class="cellrowborder" valign="top" width="16.78%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p131171127181920">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.790000000000001%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p011752719191">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.04%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p141171327171918">OBS bucket path. This parameter cannot be used together with <strong id="EN-US_TOPIC_0000001943866621__b14616752582">dataset_id</strong> or <strong id="EN-US_TOPIC_0000001943866621__b126219512589">dataset_version</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943866621__table1267642234716"></a><a name="table1267642234716"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943866621__table1267642234716" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0000001943866621__b086723111514">parameter</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943866621__row5677422164714"><th align="left" class="cellrowborder" valign="top" width="16.74832516748325%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000001943866621__p7296205262817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.618438156184384%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0000001943866621__p11128165034910">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.72882711728827%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0000001943866621__p196771122154718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.9044095590441%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0000001943866621__p5677022194719">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001943866621__row2677192224717"><td class="cellrowborder" valign="top" width="16.74832516748325%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p14677192217478">label</p>
</td>
<td class="cellrowborder" valign="top" width="15.618438156184384%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p1512818502494">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.72882711728827%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p16677112218473">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.9044095590441%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p10677142210478">Parameter name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row5528181488"><td class="cellrowborder" valign="top" width="16.74832516748325%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001943866621__p05295804810">value</p>
</td>
<td class="cellrowborder" valign="top" width="15.618438156184384%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001943866621__p14128650124918">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.72882711728827%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001943866621__p135299824812">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.9044095590441%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001943866621__p1652913874819">Parameter value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001943866621__section11070993"><h4 class="sectiontitle">Response Body</h4><div class="p" id="EN-US_TOPIC_0000001943866621__p111869146129"><a href="#EN-US_TOPIC_0000001943866621__table5371703815645">Table 5</a> describes the response parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943866621__table5371703815645"></a><a name="table5371703815645"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943866621__table5371703815645" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943866621__row740119415645"><th align="left" class="cellrowborder" valign="top" width="17.378262173782623%" id="mcps1.3.4.2.2.2.4.1.1"><p id="EN-US_TOPIC_0000001943866621__p5890372115656">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.38876112388761%" id="mcps1.3.4.2.2.2.4.1.2"><p id="EN-US_TOPIC_0000001943866621__p5447652915656">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70.23297670232978%" id="mcps1.3.4.2.2.2.4.1.3"><p id="EN-US_TOPIC_0000001943866621__p9489193773920">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001943866621__row74354510131"><td class="cellrowborder" valign="top" width="17.378262173782623%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001943866621__p2530905217407">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="12.38876112388761%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001943866621__p2536505617407">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="70.23297670232978%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001943866621__p4130369517407">Whether the request is successful</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row142758496236"><td class="cellrowborder" valign="top" width="17.378262173782623%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001943866621__p14275114915230">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="12.38876112388761%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001943866621__p9276204919233">String</p>
</td>
<td class="cellrowborder" valign="top" width="70.23297670232978%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001943866621__p154155962314">Error message of a failed API call.</p>
<p id="EN-US_TOPIC_0000001943866621__p1455859112318">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001943866621__row3990309915645"><td class="cellrowborder" valign="top" width="17.378262173782623%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001943866621__p5981669415656">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="12.38876112388761%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001943866621__p469328915656">String</p>
</td>
<td class="cellrowborder" valign="top" width="70.23297670232978%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001943866621__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="EN-US_TOPIC_0000001943866621__section144321614117"><h4 class="sectiontitle">Sample Request</h4><div class="p" id="EN-US_TOPIC_0000001943866621__p56154213593">The following shows how to modify the job parameter configuration named <span class="parmvalue" id="EN-US_TOPIC_0000001943866621__parmvalue793675711411"><b>config</b></span>.<pre class="screen" id="EN-US_TOPIC_0000001943866621__screen741385716263">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
},
{
"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_0000001943866621__section1442411306"><h4 class="sectiontitle">Sample Response</h4><ul id="EN-US_TOPIC_0000001943866621__ul732741115019"><li id="EN-US_TOPIC_0000001943866621__li332814116015">Successful response<pre class="screen" id="EN-US_TOPIC_0000001943866621__screen532814111609">{
"is_success": true
}</pre>
</li><li id="EN-US_TOPIC_0000001943866621__li432816116016">Failed response<pre class="screen" id="EN-US_TOPIC_0000001943866621__screen153283116012">{
"is_success": false,
"error_message": "Error string",
"error_code": "ModelArts.0105"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001943866621__section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000001943866621__p1731954913014">For details about the status code, see <a href="modelarts_03_0094.html#EN-US_TOPIC_0000001909907492__table1450010510213">Table 1</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