forked from docs/doc-exports
Lai, Weijian
eda19245f1
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>
127 lines
14 KiB
HTML
127 lines
14 KiB
HTML
<a name="modelarts_04_0185"></a><a name="modelarts_04_0185"></a>
|
|
|
|
<h1 class="topictitle1">Modifying the Description of a Visualization Job</h1>
|
|
<div id="body8662426"><div class="section" id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_section35881040102516"><h4 class="sectiontitle">Sample Code</h4><p id="modelarts_04_0185__en-us_topic_0180094076_p382319624614">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_0185__en-us_topic_0180094076_ul18602481764"><li id="modelarts_04_0185__en-us_topic_0180094076_li8602581461">Method 1: Modify the description of a visualization job based on the specified <strong id="modelarts_04_0185__en-us_topic_0180094076_b29722055195320">visualization_id</strong>.<div class="codecoloring" codetype="Python" id="modelarts_04_0185__en-us_topic_0180094076_screen17262101718610"><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">VisualizationJob</span>
|
|
<span class="n">session</span> <span class="o">=</span> <span class="n">Session</span><span class="p">()</span>
|
|
<span class="n">job</span> <span class="o">=</span> <span class="n">VisualizationJob</span><span class="p">(</span><span class="n">modelarts_session</span><span class="o">=</span><span class="n">session</span><span class="p">,</span> <span class="n">visualization_id</span><span class="o">=</span><span class="s1">'8992'</span><span class="p">)</span>
|
|
<span class="n">job_description</span> <span class="o">=</span> <span class="n">job</span><span class="o">.</span><span class="n">update_visualization_job</span><span class="p">(</span><span class="n">job_desc</span><span class="o">=</span><span class="s1">'update visualization job'</span><span class="p">)</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
<ul id="modelarts_04_0185__en-us_topic_0180094076_ul938731119615"><li id="modelarts_04_0185__en-us_topic_0180094076_li2387311965">Method 2: Modify the description of the visualization job created in <a href="modelarts_04_0181.html">Creating a Visualization Job</a>.<div class="codecoloring" codetype="Python" id="modelarts_04_0185__en-us_topic_0180094076_screen165549289611"><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">job_description</span> <span class="o">=</span> <span class="n">job_visualization_instance</span><span class="o">.</span><span class="n">update_visualization_job</span><span class="p">(</span><span class="n">job_desc</span><span class="o">=</span><span class="s1">'update visualization job'</span><span class="p">)</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
<ul id="modelarts_04_0185__en-us_topic_0180094076_ul1427141418614"><li id="modelarts_04_0185__en-us_topic_0180094076_li12717142066">Method 3: Modify the description of a visualization job object returned in <a href="modelarts_04_0182.html">Querying the List of Visualization Job Objects</a>.<div class="codecoloring" codetype="Python" id="modelarts_04_0185__en-us_topic_0180094076_screen261815371268"><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">job_description</span> <span class="o">=</span> <span class="n">job_visualization_instance_list</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">update_visualization_job</span><span class="p">(</span><span class="n">job_desc</span><span class="o">=</span><span class="s1">'update visualization job'</span><span class="p">)</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_section85751315416"><h4 class="sectiontitle">Parameter Description</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_table155461191218" frame="border" border="1" rules="all"><caption><b>Table 1 </b><strong id="modelarts_04_0185__en-us_topic_0180094076_b11705165945410">VisualizationJob</strong> request parameters</caption><thead align="left"><tr id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_row254817912212"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.2.2.2.5.1.1"><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p12549899214">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.2.2.5.1.2"><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p3552101193813">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.2.2.5.1.3"><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p1755169172118">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54%" id="mcps1.3.2.2.2.5.1.4"><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p55521998211">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_row8893215413"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.2.2.5.1.1 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p6891421842">modelarts_session</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.2.2.5.1.2 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p68972047">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.5.1.3 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p158912219419">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.2.2.5.1.4 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_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_0185__en-us_topic_0180094076_en-us_topic_0170904410_row197933582219"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.2.2.5.1.1 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p9118145011917">visualization_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.2.2.5.1.2 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p196751771039">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.5.1.3 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p8675972311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.2.2.5.1.4 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p212635661310">ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_table160254042515" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="modelarts_04_0185__en-us_topic_0180094076_b23051416556">update_visualization_job</strong> request parameters</caption><thead align="left"><tr id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_row141641202511"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.2.3.2.5.1.1"><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p11941182519">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.3.2.5.1.2"><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p1761512472416">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.3.2.5.1.3"><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p611141142510">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54%" id="mcps1.3.2.3.2.5.1.4"><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p917419250">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_row18274192519"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.3.2.5.1.1 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p14928412414">job_desc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.5.1.2 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p4492841840">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.5.1.3 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p849216416411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.3.2.5.1.4 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p54921143417">Description of a visualization job. The value must contain 0 to 256 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_table55928961173927" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="modelarts_04_0185__en-us_topic_0180094076_b173213018522">update_visualization_job</strong> response parameters</caption><thead align="left"><tr id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_row40618446173927"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.2.4.2.4.1.1"><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p1631242217407">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.4.2.4.1.2"><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p5427574117407">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="67%" id="mcps1.3.2.4.2.4.1.3"><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p3425893817407">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_row11062410173927"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.4.2.4.1.1 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p162521644151414">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.4.2.4.1.2 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p22572447141">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.2.4.2.4.1.3 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p152581144121419">Error message when the API call fails.</p>
|
|
<p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p1526074491419">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_row52351653173927"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.4.2.4.1.1 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p4562323317407">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.4.2.4.1.2 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p2850279617407">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.2.4.2.4.1.3 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p676125714215">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_0185__i16051552103614">ModelArts API Reference</em>.</p>
|
|
<p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p2702514017407">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_row973117251837"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.4.2.4.1.1 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p473115258316">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.4.2.4.1.2 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_p773113251238">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.2.4.2.4.1.3 "><p id="modelarts_04_0185__en-us_topic_0180094076_en-us_topic_0170904410_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_0180.html">Visualization Jobs</a></div>
|
|
</div>
|
|
</div>
|
|
|