vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/sdk-ref/modelarts_04_0175.html
Lai, Weijian 1ad28cc33e modelarts sdk-ref first version 
Reviewed-by: Jiang, Beibei <beibei.jiang@t-systems.com>
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Lai, Weijian <laiweijian4@huawei.com>
Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>
2023-03-01 15:24:28 +00:00

122 lines
15 KiB
HTML
Raw Blame History

<a name="modelarts_04_0175"></a><a name="modelarts_04_0175"></a>
<h1 class="topictitle1">Querying the List of Training Job Parameter Configuration Objects</h1>
<div id="body8662426"><div class="section" id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_section35881040102516"><h4 class="sectiontitle">Sample Code</h4><p id="modelarts_04_0175__en-us_topic_0180558691_p736383434418">In the ModelArts notebook instance, 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>
<div class="codecoloring" codetype="Python" id="modelarts_04_0175__en-us_topic_0180558691_screen15271722125718"><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></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">job_config_instance_list</span> <span class="o">=</span> <span class="n">Estimator</span><span class="o">.</span><span class="n">get_job_configs_object_list</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">is_show</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">per_page</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">page</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">sort_by</span><span class="o">=</span><span class="s2">&quot;create_time&quot;</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="s2">&quot;asc&quot;</span><span class="p">,</span> <span class="n">search_content</span><span class="o">=</span><span class="s2">&quot;configname&quot;</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_section0599140112517"><h4 class="sectiontitle">Parameter Description</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_table160254042515" frame="border" border="1" rules="all"><caption><b>Table 1 </b><strong id="modelarts_04_0175__en-us_topic_0180558691_b38201412174113">get_job_configs_object_list</strong> request parameters</caption><thead align="left"><tr id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_row141641202511"><th align="left" class="cellrowborder" valign="top" width="21.637836216378364%" id="mcps1.3.2.2.2.5.1.1"><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p11941182519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.518648135186481%" id="mcps1.3.2.2.2.5.1.2"><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p186297590913">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.718428157184283%" id="mcps1.3.2.2.2.5.1.3"><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p611141142510">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.12508749125088%" id="mcps1.3.2.2.2.5.1.4"><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p917419250">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_row811541192518"><td class="cellrowborder" valign="top" width="21.637836216378364%" headers="mcps1.3.2.2.2.5.1.1 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p6891421842">modelarts_session</p>
</td>
<td class="cellrowborder" valign="top" width="13.518648135186481%" headers="mcps1.3.2.2.2.5.1.2 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p68972047">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.718428157184283%" headers="mcps1.3.2.2.2.5.1.3 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p158912219419">Object</p>
</td>
<td class="cellrowborder" valign="top" width="49.12508749125088%" headers="mcps1.3.2.2.2.5.1.4 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_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_0175__en-us_topic_0180558691_en-us_topic_0170904402_row16195453115"><td class="cellrowborder" valign="top" width="21.637836216378364%" headers="mcps1.3.2.2.2.5.1.1 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p685762812445">per_page</p>
</td>
<td class="cellrowborder" valign="top" width="13.518648135186481%" headers="mcps1.3.2.2.2.5.1.2 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p1585762812442">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.718428157184283%" headers="mcps1.3.2.2.2.5.1.3 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p10857528154416">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.12508749125088%" headers="mcps1.3.2.2.2.5.1.4 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p9857202812442">Number of job parameters displayed on each page. The value range is [1, 1000]. Default value: <strong id="modelarts_04_0175__en-us_topic_0180558691_b7525121015409">10</strong></p>
</td>
</tr>
<tr id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_row07900451112"><td class="cellrowborder" valign="top" width="21.637836216378364%" headers="mcps1.3.2.2.2.5.1.1 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p1785762812442">page</p>
</td>
<td class="cellrowborder" valign="top" width="13.518648135186481%" headers="mcps1.3.2.2.2.5.1.2 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p685712810442">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.718428157184283%" headers="mcps1.3.2.2.2.5.1.3 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p13857128134410">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.12508749125088%" headers="mcps1.3.2.2.2.5.1.4 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p1085717285447">Index of the page to be queried. Default value: <span class="parmname" id="modelarts_04_0175__en-us_topic_0180558691_parmname162371646165711"><b>1</b></span></p>
</td>
</tr>
<tr id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_row116444671117"><td class="cellrowborder" valign="top" width="21.637836216378364%" headers="mcps1.3.2.2.2.5.1.1 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p5857112819448">sortBy/sort_by</p>
</td>
<td class="cellrowborder" valign="top" width="13.518648135186481%" headers="mcps1.3.2.2.2.5.1.2 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p19857152817443">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.718428157184283%" headers="mcps1.3.2.2.2.5.1.3 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p68573282448">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.12508749125088%" headers="mcps1.3.2.2.2.5.1.4 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p17530232175418">When AK/SK-based authentication is used, the parameter name is <span class="parmvalue" id="modelarts_04_0175__en-us_topic_0180558691_parmvalue15805123419419"><b>sortBy</b></span>. When the username and password are used for authentication, the parameter name is <span class="parmvalue" id="modelarts_04_0175__en-us_topic_0180558691_parmvalue208061345410"><b>sort_by</b></span>. The parameter specifies the sorting mode of the query. The value can be <strong id="modelarts_04_0175__en-us_topic_0180558691_b11211437124119">job_name</strong>, <strong id="modelarts_04_0175__en-us_topic_0180558691_b41211937124119">job_desc</strong>, <strong id="modelarts_04_0175__en-us_topic_0180558691_b1112220374413">status</strong>, <strong id="modelarts_04_0175__en-us_topic_0180558691_b101231137174115">duration</strong>, <strong id="modelarts_04_0175__en-us_topic_0180558691_b1112323710415">engine_type</strong>, or <strong id="modelarts_04_0175__en-us_topic_0180558691_b171242372415">create_time</strong>. Default value: <strong id="modelarts_04_0175__en-us_topic_0180558691_b141251737154117">job_name</strong></p>
</td>
</tr>
<tr id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_row02401646131113"><td class="cellrowborder" valign="top" width="21.637836216378364%" headers="mcps1.3.2.2.2.5.1.1 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p4857428104419">order</p>
</td>
<td class="cellrowborder" valign="top" width="13.518648135186481%" headers="mcps1.3.2.2.2.5.1.2 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p1785712287447">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.718428157184283%" headers="mcps1.3.2.2.2.5.1.3 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p9857142824415">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.12508749125088%" headers="mcps1.3.2.2.2.5.1.4 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p1385819280441">Sorting order. The options are as follows:</p>
<ul id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_ul11858152894418"><li id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_li13858122815449"><span class="parmvalue" id="modelarts_04_0175__en-us_topic_0180558691_parmvalue12456764562"><b>asc</b></span>: ascending order. It is the default value.</li><li id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_li585811283441"><span class="parmvalue" id="modelarts_04_0175__en-us_topic_0180558691_parmvalue18579121045615"><b>desc</b></span>: descending order</li></ul>
</td>
</tr>
<tr id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_row204121046151111"><td class="cellrowborder" valign="top" width="21.637836216378364%" headers="mcps1.3.2.2.2.5.1.1 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p1885832812448">search_content</p>
</td>
<td class="cellrowborder" valign="top" width="13.518648135186481%" headers="mcps1.3.2.2.2.5.1.2 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p685812819445">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.718428157184283%" headers="mcps1.3.2.2.2.5.1.3 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p18581428184418">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.12508749125088%" headers="mcps1.3.2.2.2.5.1.4 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0170904402_p138583282447">Search content, for example, a parameter name. By default, this parameter is left blank.</p>
</td>
</tr>
<tr id="modelarts_04_0175__en-us_topic_0180558691_row9886183795413"><td class="cellrowborder" valign="top" width="21.637836216378364%" headers="mcps1.3.2.2.2.5.1.1 "><p id="modelarts_04_0175__en-us_topic_0180558691_p17887193765410">is_show</p>
</td>
<td class="cellrowborder" valign="top" width="13.518648135186481%" headers="mcps1.3.2.2.2.5.1.2 "><p id="modelarts_04_0175__en-us_topic_0180558691_p198878374547">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.718428157184283%" headers="mcps1.3.2.2.2.5.1.3 "><p id="modelarts_04_0175__en-us_topic_0180558691_p128873378549">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="49.12508749125088%" headers="mcps1.3.2.2.2.5.1.4 "><p id="modelarts_04_0175__en-us_topic_0180558691_p1388716377547">Whether to print the training job parameter configuration list. Default value: <span class="parmname" id="modelarts_04_0175__en-us_topic_0180558691_parmname1389771314349"><b>True</b></span></p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="modelarts_04_0175__en-us_topic_0180558691_p2796152145419">A training object list is returned in the successful response to <span class="filepath" id="modelarts_04_0175__en-us_topic_0180558691_filepath1042663818552"><b>get_job_configs_object_list</b></span>. For details, see <a href="#modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0160436006_table973120224596">Table 2</a>.</p>
<div class="tablenoborder"><a name="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0160436006_table973120224596"></a><a name="en-us_topic_0180558691_en-us_topic_0160436006_table973120224596"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0160436006_table973120224596" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="modelarts_04_0175__en-us_topic_0180558691_b1799332351315">TrainingJob</strong> object description</caption><thead align="left"><tr id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0160436006_row2731522195910"><th align="left" class="cellrowborder" valign="top" width="24.91249124912491%" id="mcps1.3.2.4.2.4.1.1"><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0160436006_p57306225598">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.152415241524153%" id="mcps1.3.2.4.2.4.1.2"><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0160436006_p117308225593">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.935093509350935%" id="mcps1.3.2.4.2.4.1.3"><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0160436006_p2730132255915">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0160436006_row1873172215912"><td class="cellrowborder" valign="top" width="24.91249124912491%" headers="mcps1.3.2.4.2.4.1.1 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0160436006_p4731322145919">TrainingJob</p>
</td>
<td class="cellrowborder" valign="top" width="24.152415241524153%" headers="mcps1.3.2.4.2.4.1.2 "><p id="modelarts_04_0175__en-us_topic_0180558691_en-us_topic_0160436006_p117311922115916">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50.935093509350935%" headers="mcps1.3.2.4.2.4.1.3 "><p id="modelarts_04_0175__en-us_topic_0180558691_p11201122121013">Training object. This object contains attributes such as <strong id="modelarts_04_0175__en-us_topic_0180558691_b2653165022916">config_name</strong>, and operations on a training job parameter configuration, such as querying or deleting the training job parameter configuration. For example, you can use <strong id="modelarts_04_0175__en-us_topic_0180558691_b19653155052915">job_config_instance.config_name</strong> to obtain the name of a training job parameter configuration.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="modelarts_04_0173.html">Training Job Parameter Configuration</a></div>
</div>
</div>
View Git Blame Copy Permalink