vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/sdk-ref/modelarts_04_0171.html
Lai, Weijian eda19245f1 modelarts sdk-ref version 21.430 update 
Reviewed-by: Jiang, Beibei <beibei.jiang@t-systems.com>
Reviewed-by: Rechenburg, Matthias <matthias.rechenburg@t-systems.com>
Co-authored-by: Lai, Weijian <laiweijian4@huawei.com>
Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>
2023-03-20 09:32:27 +00:00

114 lines
13 KiB
HTML
Raw Blame History

<a name="modelarts_04_0171"></a><a name="modelarts_04_0171"></a>
<h1 class="topictitle1">Stopping a Training Job Version</h1>
<div id="body8662426"><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p1065717151239">You can stop a training job version that is being created only when the job is running.</p>
<div class="section" id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_section35881040102516"><h4 class="sectiontitle">Sample Code</h4><p id="modelarts_04_0171__en-us_topic_0180094064_p165969815444">In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see <a href="modelarts_04_0123.html">Session Authentication</a>.</p>
<ul id="modelarts_04_0171__en-us_topic_0180094064_ul1948415239526"><li id="modelarts_04_0171__en-us_topic_0180094064_li44855239521">Method 1: Stop a training job version based on the specified <strong id="modelarts_04_0171__en-us_topic_0180094064_b5565114762110">job_id</strong> and <strong id="modelarts_04_0171__en-us_topic_0180094064_b356624772116">version_id</strong>.<div class="codecoloring" codetype="Python" id="modelarts_04_0171__en-us_topic_0180094064_screen3842113155218"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="kn">from</span> <span class="nn">modelarts.session</span> <span class="kn">import</span> <span class="n">Session</span>
<span class="kn">from</span> <span class="nn">modelarts.estimator</span> <span class="kn">import</span> <span class="n">Estimator</span>
<span class="n">session</span> <span class="o">=</span> <span class="n">Session</span><span class="p">()</span>
<span class="n">estimator</span> <span class="o">=</span> <span class="n">Estimator</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="n">job_id</span><span class="o">=</span><span class="s2">&quot;182626&quot;</span><span class="p">,</span> <span class="n">version_id</span><span class="o">=</span><span class="s2">&quot;278813&quot;</span><span class="p">)</span>
<span class="n">status</span> <span class="o">=</span> <span class="n">estimator</span><span class="o">.</span><span class="n">stop_job_version</span><span class="p">()</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
<ul id="modelarts_04_0171__en-us_topic_0180094064_ul1037532614529"><li id="modelarts_04_0171__en-us_topic_0180094064_li12375122618529">Method 2: Stop the training job version created in <a href="modelarts_04_0168.html">Creating a Training Job Version</a>.<div class="codecoloring" codetype="Python" id="modelarts_04_0171__en-us_topic_0180094064_screen1773015401529"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">status</span> <span class="o">=</span> <span class="n">job_version_instance</span><span class="o">.</span><span class="n">stop_job_version</span><span class="p">()</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
<ul id="modelarts_04_0171__en-us_topic_0180094064_ul3661142865216"><li id="modelarts_04_0171__en-us_topic_0180094064_li866213285525">Method 3: Stop the training job version object returned in <a href="modelarts_04_0169.html">Querying the List of Training Job Versions</a>.<div class="codecoloring" codetype="Python" id="modelarts_04_0171__en-us_topic_0180094064_screen15825116195314"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">status</span> <span class="o">=</span> <span class="n">job_version_instance_list</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">stop_job_version</span><span class="p">()</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_section85751315416"><h4 class="sectiontitle">Parameter Description</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_table155461191218" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Estimator request parameters</caption><thead align="left"><tr id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_row254817912212"><th align="left" class="cellrowborder" valign="top" width="19.801980198019802%" id="mcps1.3.3.2.2.5.1.1"><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p12549899214">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.3.2.2.5.1.2"><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p3552101193813">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.871287128712872%" id="mcps1.3.3.2.2.5.1.3"><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p1755169172118">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.46534653465347%" id="mcps1.3.3.2.2.5.1.4"><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p55521998211">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_row8893215413"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p6891421842">modelarts_session</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.2 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p68972047">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.3.2.2.5.1.3 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p158912219419">Object</p>
</td>
<td class="cellrowborder" valign="top" width="53.46534653465347%" headers="mcps1.3.3.2.2.5.1.4 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p1689152543">Session object. For details about the initialization method, see <a href="modelarts_04_0123.html">Session Authentication</a>.</p>
</td>
</tr>
<tr id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_row197933582219"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p10361105925611">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.2 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p196751771039">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.3.2.2.5.1.3 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p8675972311">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.46534653465347%" headers="mcps1.3.3.2.2.5.1.4 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p212635661310">ID of a training job. Obtain <strong id="modelarts_04_0171__b6304125661715">job_id</strong> using the training job object generated in <a href="modelarts_04_0131.html">Creating a Training Job</a>, for example, <span class="filepath" id="modelarts_04_0171__filepath163051456121720"><b>job_instance.job_id</b></span>, or from the response in <a href="modelarts_04_0160.html">Obtaining Training Jobs</a>.</p>
</td>
</tr>
<tr id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_row105532902114"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p212669145714">version_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.2 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p955361173817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.3.2.2.5.1.3 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p327982618582">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.46534653465347%" headers="mcps1.3.3.2.2.5.1.4 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p388712374570">Version ID of a training job. Obtain <strong id="modelarts_04_0171__b516915619186">version_id</strong> from the response in <a href="modelarts_04_0169.html">Querying the List of Training Job Versions</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_table61691357155927" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_b10448224570">stop_job_version</strong> response parameters</caption><thead align="left"><tr id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_row32271610155927"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.3.2.4.1.1"><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p63651488155944">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.3.2.4.1.2"><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p66066406155944">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67%" id="mcps1.3.3.3.2.4.1.3"><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p49778641155944">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_row341513612180"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.4.1.1 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p1415665185">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.3.2.4.1.2 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p174152067182">String</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.3.3.2.4.1.3 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p17985833171818">Error message when the API call fails.</p>
<p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p179882033201819">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_row29721694155927"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.4.1.1 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p26964844155944">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.3.2.4.1.2 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p17378453155944">String</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.3.3.2.4.1.3 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p071812541519">Error code when the API fails to be called. For details, see <a href="https://docs.otc.t-systems.com/modelarts/api-ref/common_parameters/error_codes.html" target="_blank" rel="noopener noreferrer">Error Codes</a> in <em id="modelarts_04_0171__i178991040141814">ModelArts API Reference</em>.</p>
<p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p6203060911624">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_row26618175334"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.4.1.1 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p3208115516321">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.3.2.4.1.2 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p1820817559324">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.3.3.2.4.1.3 "><p id="modelarts_04_0171__en-us_topic_0180094064_en-us_topic_0170904398_p14433359122514">Whether the API call succeeds</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="modelarts_04_0167.html">Training Job Versions</a></div>
</div>
</div>
View Git Blame Copy Permalink