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

531 lines
63 KiB
HTML
Raw Blame History

<a name="modelarts_04_0194"></a><a name="modelarts_04_0194"></a>
<h1 class="topictitle1">Importing a Model</h1>
<div id="body8662426"><p id="modelarts_04_0194__en-us_topic_0180094081_p927862081217">The model import function covers the following aspects:</p>
<ul id="modelarts_04_0194__en-us_topic_0180094081_ul1541711501120"><li id="modelarts_04_0194__en-us_topic_0180094081_li125601755191220">Initialize the existing model and create a model object based on the model ID.</li><li id="modelarts_04_0194__en-us_topic_0180094081_li17417150141213">Create a model. For details about the attributes of the created model, see <a href="modelarts_04_0197.html">Querying the Details About a Model</a>.</li></ul>
<div class="section" id="modelarts_04_0194__section19615115954313"><h4 class="sectiontitle">Sample Model File</h4><p id="modelarts_04_0194__p1389916134410">Take a <a href="https://docs.otc.t-systems.com/modelarts/umn/examples_of_custom_scripts/pytorch.html#modelarts-23-0175" target="_blank" rel="noopener noreferrer">custom PyTorch script</a> as an example. Download <a href="https://obs-sdk.obs.eu-de.otc.t-systems.com/model.zip" target="_blank" rel="noopener noreferrer">model.zip</a> that can be directly deployed, decompress the package, and upload it to OBS. For details about the structure of the PyTorch model package, see <a href="https://docs.otc.t-systems.com/modelarts/umn/model_package_specifications/model_package_specifications.html" target="_blank" rel="noopener noreferrer">Model Package Specifications</a>.</p>
</div>
<pre class="screen" id="modelarts_04_0194__screen14779278318">OBS bucket or directory name
├── resnet
│ ├── model (Mandatory) Fixed subdirectory name. The subdirectory is used to store model-related files.
│ │ ├──&lt;&lt;Custom Python package&gt;&gt; (Optional) Customized Python package, which can be directly referenced in model inference code
│ │ ├──mnist_mlp.pt (Mandatory) PyTorch model file, which contains variable and weight information and is saved as <strong id="modelarts_04_0194__b823332514478">state_dict</strong>
│ │ ├──config.json (Mandatory) Model configuration file. The file name is fixed to <strong id="modelarts_04_0194__b143284312526">config.json</strong>. Only one model configuration file is supported.
│ │ ├──customize_service.py (Mandatory) Model inference code. The file name is fixed to<strong id="modelarts_04_0194__b1766016111531"> customize_service.py</strong>. Only one model inference file is supported. The files on which <strong id="modelarts_04_0194__b186601911145318">customize_service.py</strong> depends can be directly stored in the <strong id="modelarts_04_0194__b15931711135414">model</strong> directory.</pre>
<div class="section" id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_section20261580353"><h4 class="sectiontitle">Sample Code</h4><p id="modelarts_04_0194__en-us_topic_0180094081_p12339141734716">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>
<div class="codecoloring" codetype="Python" id="modelarts_04_0194__en-us_topic_0180094081_screen21131015151314"><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.model</span> <span class="kn">import</span> <span class="n">Model</span>
<span class="kn">from</span> <span class="nn">modelarts.config.model_config</span> <span class="kn">import</span> <span class="n">ServiceConfig</span><span class="p">,</span> <span class="n">Params</span><span class="p">,</span> <span class="n">Dependencies</span><span class="p">,</span> <span class="n">Packages</span>
<span class="n">session</span> <span class="o">=</span> <span class="n">Session</span><span class="p">()</span>
</pre></div></td></tr></table></div>
</div>
<ul id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_ul1533718463232"><li id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_li113371846172316">Method 1: Initialize an existing model.<div class="codecoloring" codetype="Python" id="modelarts_04_0194__en-us_topic_0180094081_screen4837165510135"><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">model_instance</span> <span class="o">=</span> <span class="n">Model</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="n">model_id</span><span class="o">=</span><span class="s2">&quot;your_model_id&quot;</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
<ul id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_ul8412102311240"><li id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_li941215234249">Method 2: Create a model.<div class="codecoloring" codetype="Python" id="modelarts_04_0194__en-us_topic_0180094081_screen1348113151414"><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>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span>
<span class="normal">12</span>
<span class="normal">13</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">model_location</span> <span class="o">=</span> <span class="s2">&quot;/your_obs_bucket/model_path&quot;</span> <span class="c1"># Change to the OBS path to the model file</span>
<span class="n">execution_code</span> <span class="o">=</span> <span class="s2">&quot;/your_obs_bucket/model_path/customize_service.py&quot;</span>
<span class="n">runtime</span> <span class="o">=</span> <span class="s2">&quot;python3.7&quot;</span>
<span class="n">model_instance</span> <span class="o">=</span> <span class="n">Model</span><span class="p">(</span>
<span class="n">session</span><span class="p">,</span>
<span class="n">model_name</span><span class="o">=</span><span class="s2">&quot;input_model_name&quot;</span><span class="p">,</span> <span class="c1"># (Optional) Model name</span>
<span class="n">model_version</span><span class="o">=</span><span class="s2">&quot;1.0.0&quot;</span><span class="p">,</span> <span class="c1"># (Optional) Model version</span>
<span class="n">source_location</span><span class="o">=</span><span class="n">model_location</span><span class="p">,</span> <span class="c1"># OBS path to the model file, for example, /your_obs_bucket/model_path</span>
<span class="n">model_type</span><span class="o">=</span><span class="s2">&quot;PyTorch&quot;</span><span class="p">,</span> <span class="c1"># Model type</span>
<span class="n">execution_code</span><span class="o">=</span><span class="n">execution_code</span><span class="p">,</span> <span class="c1"># (Optional) OBS path to the execution script, for example, /your_obs_bucket/model_path/customize_service.py</span>
<span class="n">runtime</span> <span class="o">=</span> <span class="n">runtime</span> <span class="c1"># (Optional) Supported runtime environment</span>
<span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
<div class="note" id="modelarts_04_0194__note18055513420"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="modelarts_04_0194__p58051251641"><strong id="modelarts_04_0194__b94680814338">dependencies</strong> will overwrite the data in <strong id="modelarts_04_0194__b55821531153312">config.json</strong> in the preceding example. You do not need to use <strong id="modelarts_04_0194__b17615171193419">dependencies</strong>. The following section describes the <strong id="modelarts_04_0194__b258112813342">dependencies</strong> formats.</p>
</div></div>
<ul id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_ul592417813297"><li id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_li59083816293">Definition formats of the <strong id="modelarts_04_0194__en-us_topic_0180094081_b625916561906">dependencies</strong> parameter group used in method 2<p id="modelarts_04_0194__en-us_topic_0180094081_p2087019511515">The SDK provides the definition of the <strong id="modelarts_04_0194__en-us_topic_0180094081_b181119451629">dependencies</strong> parameter group. The type of <strong id="modelarts_04_0194__en-us_topic_0180094081_b16112114513215">dependencies</strong> is list, and those of the tuple objects in the list are Dependencies.</p>
<p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p790810814296">The code is as follows:</p>
<div class="codecoloring" codetype="Python" id="modelarts_04_0194__en-us_topic_0180094081_screen082511951513"><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>
<span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">dependencies</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">dependency1</span> <span class="o">=</span> <span class="n">Dependencies</span><span class="p">(</span>
<span class="n">installer</span><span class="o">=</span><span class="s2">&quot;pip&quot;</span><span class="p">,</span> <span class="c1"># Installation mode. pip is supported.</span>
<span class="n">packages</span><span class="o">=</span><span class="n">packages</span> <span class="c1"># Collection of dependency packages. For details, see packages.</span>
<span class="p">)</span>
<span class="n">dependencies</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dependency1</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</li><li id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_li16908884292">Definition formats of the <strong id="modelarts_04_0194__en-us_topic_0180094081_b377991311315">package</strong> parameter group used in method 2<p id="modelarts_04_0194__en-us_topic_0180094081_p11288132521510">The SDK provides the definition of the <strong id="modelarts_04_0194__en-us_topic_0180094081_b13421451101216">packages</strong> parameter group. The type of <strong id="modelarts_04_0194__en-us_topic_0180094081_b1743155118126">packages</strong> is list, and those of the tuple objects in the list are Packages.</p>
<p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p490808112917">The code is as follows:</p>
<div class="codecoloring" codetype="Python" id="modelarts_04_0194__en-us_topic_0180094081_screen12238152820153"><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>
<span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">packages</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">package1</span> <span class="o">=</span> <span class="n">Packages</span><span class="p">(</span>
<span class="n">package_name</span><span class="o">=</span><span class="s2">&quot;package_name&quot;</span><span class="p">,</span> <span class="c1"># Package name</span>
<span class="n">package_version</span><span class="o">=</span><span class="s2">&quot;version&quot;</span><span class="p">,</span> <span class="c1"># Package version</span>
<span class="n">restraint</span><span class="o">=</span><span class="s2">&quot;EXACT&quot;</span><span class="p">)</span>
<span class="n">packages</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">package1</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
<div class="note" id="modelarts_04_0194__note147825212434"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="modelarts_04_0194__p237034910437">The following is an example of creating a <strong id="modelarts_04_0194__b177975811502">dependencies</strong> parameter group:</p>
<pre class="screen" id="modelarts_04_0194__screen29591229134317">dependencies = []
packages = [{
"package_name": "numpy",
"package_version": "1.15.0",
"restraint": "EXACT"
}, {
"package_name": "h5py",
"package_version": "2.8.0",
"restraint": "EXACT"
}]
dependency = Dependencies(installer="pip", packages=packages)
dependencies.append(dependency)</pre>
</div></div>
</li></ul>
</li></ul>
</div>
<div class="section" id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_section14581145486"><h4 class="sectiontitle">Parameter Description</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_table16518993181628" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters for initializing a model</caption><thead align="left"><tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row41524868181628"><th align="left" class="cellrowborder" valign="top" width="18.181818181818183%" id="mcps1.3.6.2.2.5.1.1"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p30350749181639">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.131313131313133%" id="mcps1.3.6.2.2.5.1.2"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p42491604181639">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.141414141414144%" id="mcps1.3.6.2.2.5.1.3"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p19267891181639">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.545454545454554%" id="mcps1.3.6.2.2.5.1.4"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p17195363181639">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row399025208"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.2.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1992242017">session</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.2.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p49910292012">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.2.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p69922102018">Object</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.2.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_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_0194__en-us_topic_0180094081_en-us_topic_0160574216_row167111536133010"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.2.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p871183614302">model_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.2.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1671263610305">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.2.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p147121836103013">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.2.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p6712143614304">Model ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_table49084802911" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters for creating a model</caption><thead align="left"><tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row109086813290"><th align="left" class="cellrowborder" valign="top" width="18.181818181818183%" id="mcps1.3.6.3.2.5.1.1"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p19081872913">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.131313131313133%" id="mcps1.3.6.3.2.5.1.2"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p49087842911">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.141414141414144%" id="mcps1.3.6.3.2.5.1.3"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1090815815291">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.545454545454554%" id="mcps1.3.6.3.2.5.1.4"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p190828152916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row181731441153310"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p3905144913316">session</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p139051949143310">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p0905204973313">Object</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p9905184953318">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_0194__en-us_topic_0180094081_en-us_topic_0160574216_row290868132910"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1890858102912">model_name</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p19908148162911">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p9908138112910">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p490816842918">Name of a model, which contains 1 to 64 characters that consist of only letters, digits, underscores (_), and hyphens (-). It must start with a letter. If this parameter is not specified, the system automatically generates a model name.</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row209088819298"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p119089815299">model_version</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p11908148102911">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p290888172912">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p790858102914">Model version in the format of <em id="modelarts_04_0194__en-us_topic_0180094081_i4691233135218">Digit.Digit.Digit</em>. The value range of the digits is [0, 99]. The version number cannot start with 0, for example, <strong id="modelarts_04_0194__en-us_topic_0180094081_b5158058102520">01.01.01</strong>.</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_row18608193343020"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_p1660833393017">publish</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_p96091033183019">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_p11609103312309">Bool</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_p205771237122017">Whether to publish a model. The options are as follows:</p>
<ul id="modelarts_04_0194__en-us_topic_0180094081_ul1917911465267"><li id="modelarts_04_0194__en-us_topic_0180094081_li5179146132614"><strong id="modelarts_04_0194__en-us_topic_0180094081_b1446890162913">True</strong>: Publish the model. (Default value)</li><li id="modelarts_04_0194__en-us_topic_0180094081_li7179204615266"><strong id="modelarts_04_0194__en-us_topic_0180094081_b182671937132612">False</strong>: Do not publish the model. </li></ul>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_row52703813214"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_p82701280322">source_location_type</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_p17270108123214">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_p5270178143210">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_p18427191019225">Model location type. The options are as follows:</p>
<ul id="modelarts_04_0194__en-us_topic_0180094081_ul1517814452612"><li id="modelarts_04_0194__en-us_topic_0180094081_li1117824417264"><strong id="modelarts_04_0194__en-us_topic_0180094081_b1738216460436">OBS_SOURCE</strong>: OBS path. (Default value)</li><li id="modelarts_04_0194__en-us_topic_0180094081_li1817844452619"><strong id="modelarts_04_0194__en-us_topic_0180094081_b58081158204319">LOCAL_SOURCE</strong>: local path.</li></ul>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row7908286293"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p090898192919">source_location</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1990868122913">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p59087818294">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_p14988425181310">Path (parent directory) of the model file</p>
<ul id="modelarts_04_0194__en-us_topic_0180094081_ul15786539112617"><li id="modelarts_04_0194__en-us_topic_0180094081_li16786339132610">If <strong id="modelarts_04_0194__en-us_topic_0180094081_b1273813369456">source_location_type</strong> is set to <strong id="modelarts_04_0194__en-us_topic_0180094081_b2153133912459">OBS_SOURCE</strong>, the model file path is an OBS path in the format of <strong id="modelarts_04_0194__en-us_topic_0180094081_b89184794513">/obs_bucketname/.../model_file_parent_dir/</strong>.</li><li id="modelarts_04_0194__en-us_topic_0180094081_li57861339132617">If <strong id="modelarts_04_0194__en-us_topic_0180094081_b1084584844515">source_location_type</strong> is set to <strong id="modelarts_04_0194__en-us_topic_0180094081_b7851194814455">LOCAL_SOURCE</strong>, the model file path is a local path in the format of <span class="filepath" id="modelarts_04_0194__en-us_topic_0180094081_filepath656624652915"><b>/local_path/.../model_file_parent_dir/</b></span>.</li></ul>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_row1777313438379"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_p17732431378">environment</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_p8773164343720">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_p16774154319371">Environment instance</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_p1774943113712">Environment required for normal model running, such as the Python or TensorFlow version</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row79083816294"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1690812810291">source_job_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p090878162911">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p109081802918">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p390816813295">ID of the source training job. If the model is generated from a training job, specify this parameter for source tracing. If the model is imported from a third-party meta model, leave this parameter blank. By default, this parameter is left blank.</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row690811892916"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p19081088295">source_job_version</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p09089815296">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p290820892916">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p19908682299">Version of the source training job. If the model is generated from a training job, specify this parameter for source tracing. If the model is imported from a third-party meta model, leave this parameter blank. By default, this parameter is left blank.</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row1990828182915"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1290828142919">source_type</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1390808142915">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p590818816293">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p2090814817291">Model source type. Currently, the value can only be <strong id="modelarts_04_0194__en-us_topic_0180094081_b466715371521">auto</strong>, which indicates an ExeML model (model download is not allowed). If the model is deployed by a training job, leave this parameter blank. By default, this parameter is left blank.</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row139081386293"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p209082085299">model_type</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p209084810294">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p14908786297">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p19084811294">Model type. The value can be <strong id="modelarts_04_0194__en-us_topic_0180094081_b1538517571148">TensorFlow</strong>, <strong id="modelarts_04_0194__en-us_topic_0180094081_b183861557181412">MXNet</strong>, <strong id="modelarts_04_0194__en-us_topic_0180094081_b93870574149">Spark_MLlib</strong>, <strong id="modelarts_04_0194__en-us_topic_0180094081_b12388125731415">Scikit_Learn</strong>, <strong id="modelarts_04_0194__en-us_topic_0180094081_b17389135710145">XGBoost</strong>, <strong id="modelarts_04_0194__en-us_topic_0180094081_b23907570146">MindSpore</strong>, <strong id="modelarts_04_0194__en-us_topic_0180094081_b43901571142">Image</strong>, or <strong id="modelarts_04_0194__en-us_topic_0180094081_b143911157141410">PyTorch</strong>.</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row119081589299"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p49082083295">model_algorithm</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p59085811292">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p179083892910">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p29081281290">Model algorithm. If the algorithm has been configured in the model configuration file, this parameter can be left blank. For example, <strong id="modelarts_04_0194__en-us_topic_0180094081_b046918220153">predict_analysis</strong>, <strong id="modelarts_04_0194__en-us_topic_0180094081_b84701621158">object_detection</strong>, or <strong id="modelarts_04_0194__en-us_topic_0180094081_b3471132161510">image_classification</strong>.</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row199082819295"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p790878152918">description</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p10908108142910">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p11908785297">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p12908884298">Model description, which contains a maximum of 100 characters and cannot contain the following special characters: !&lt;&gt;=&amp;'"</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row149080816297"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1990812882917">execution_code</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p09081085291">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p89084832918">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p19908108172912">OBS path to the script to be executed. If <span class="filepath" id="modelarts_04_0194__filepath154142331856"><b>customize_service.py</b></span> is not output by the model, configure this parameter to specify the path. The inference script must be stored in the <strong id="modelarts_04_0194__en-us_topic_0180094081_b4537241975">model</strong> directory in the path where the model is located. For details, see the <span class="parmname" id="modelarts_04_0194__en-us_topic_0180094081_parmname15245155975513"><b>source_location</b></span> parameter. The script name is fixed to <span class="filepath" id="modelarts_04_0194__en-us_topic_0180094081_filepath85401241775"><b>customize_service.py</b></span>.</p>
</td>
</tr>
<tr id="modelarts_04_0194__row393213612157"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__p209324612151">runtime</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__p105801810181511">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__p358041016153">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__p176061525152114">Supported runtime environment. This parameter is mandatory if <strong id="modelarts_04_0194__b2801142910354">model_type</strong> is used. The <strong id="modelarts_04_0194__b14740145817351">runtime</strong> parameter varies depending on engines. For details, see <a href="https://docs.otc.t-systems.com/modelarts/umn/model_management/importing_a_model/importing_a_meta_model_from_obs.html#modelarts-23-0207" target="_blank" rel="noopener noreferrer">Supported AI engines and their runtime</a>.</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row17908582292"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1390818172918">input_params</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p16908481297">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p2090814822919"><strong id="modelarts_04_0194__en-us_topic_0180094081_b2066832013163">params</strong> array</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p193982021193117">List of input parameters for model inference. By default, this parameter is left blank. If the <strong id="modelarts_04_0194__en-us_topic_0180094081_b1758772319161">apis</strong> information has been configured in the model configuration file, you do not need to set this parameter. The backend automatically reads the input parameters from the <strong id="modelarts_04_0194__en-us_topic_0180094081_b14588142341612">apis</strong> field in the configuration file.</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row9908988299"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p9908684291">output_params</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p209089811299">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p990810892915"><strong id="modelarts_04_0194__en-us_topic_0180094081_b460622511610">params</strong> array</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p39087862918">List of output parameters for model inference. By default, this parameter is left blank. If the <strong id="modelarts_04_0194__en-us_topic_0180094081_b6800127191614">apis</strong> information has been configured in the model configuration file, you do not need to set this parameter. The backend automatically reads the output parameters from the <strong id="modelarts_04_0194__en-us_topic_0180094081_b880112275169">apis</strong> field in the configuration file.</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row13908083294"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p3908158102910">dependencies</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p690898172910">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p129087812291"><strong id="modelarts_04_0194__en-us_topic_0180094081_b4902716850">dependency</strong> array</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p122789113344">Dependency package required for running the code and model. By default, this parameter is left blank. If the <strong id="modelarts_04_0194__en-us_topic_0180094081_b17270123412164">dependencies</strong> information has been configured in the model configuration file, you do not need to set this parameter. The backend automatically reads the dependencies to be installed from the <strong id="modelarts_04_0194__en-us_topic_0180094081_b6271534141617">dependencies</strong> field in the configuration file.</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row1690818814297"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.3.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p109087802914">apis</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p590817817296">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.3.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p39086882919">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.3.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p9908986292">List of inference APIs provided by a model. By default, this parameter is left blank. If the <strong id="modelarts_04_0194__en-us_topic_0180094081_b175551648171617">apis</strong> information has been configured in the model configuration file, you do not need to set this parameter. The backend automatically reads the configured inference API information from the <strong id="modelarts_04_0194__en-us_topic_0180094081_b955694811617">apis</strong> field in the configuration file.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_table4924148162911" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="modelarts_04_0194__en-us_topic_0180094081_b12408154915166">params</strong> parameters</caption><thead align="left"><tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row189247810293"><th align="left" class="cellrowborder" valign="top" width="18.181818181818183%" id="mcps1.3.6.4.2.5.1.1"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p119085810293">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.131313131313133%" id="mcps1.3.6.4.2.5.1.2"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p8908383299">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.141414141414144%" id="mcps1.3.6.4.2.5.1.3"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p59087862916">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.545454545454554%" id="mcps1.3.6.4.2.5.1.4"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p159081686299">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row1492428162918"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.4.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p159247813295">url</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.4.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p792478132912">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.4.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p192458162916">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.4.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p99241584290">Request path of a model inference API</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row1492419852912"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.4.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p20924385294">param_name</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.4.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p15924158122920">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.4.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p109249852916">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.4.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p492478152914">Parameter name, which contains a maximum of 64 characters</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row1692412832916"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.4.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p6924198132916">param_type</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.4.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1892468122914">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.4.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1292418815295">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.4.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p19136640478">Basic parameter types of JSON schema, including <strong id="modelarts_04_0194__en-us_topic_0180094081_b176203520167">string</strong>, <strong id="modelarts_04_0194__en-us_topic_0180094081_b176211752101612">object</strong>, <strong id="modelarts_04_0194__en-us_topic_0180094081_b16622165251613">array</strong>, <strong id="modelarts_04_0194__en-us_topic_0180094081_b196221052151618">boolean</strong>, <strong id="modelarts_04_0194__en-us_topic_0180094081_b1262315221619">number</strong>, and <strong id="modelarts_04_0194__en-us_topic_0180094081_b106241252151616">integer</strong></p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row092419882914"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.4.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1892417811297">min</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.4.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p13924118102911">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.4.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p13924208152914">Double</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.4.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1192419872917">This parameter is optional when <strong id="modelarts_04_0194__en-us_topic_0180094081_b784075511168">param_type</strong> is set to <strong id="modelarts_04_0194__en-us_topic_0180094081_b17841175519161">int</strong> or <strong id="modelarts_04_0194__en-us_topic_0180094081_b2841185514169">float</strong>. By default, this parameter is left blank.</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row3924885297"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.4.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1092408132918">max</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.4.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p792413820298">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.4.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p8924178152918">Double</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.4.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1392498172911">This parameter is optional when <strong id="modelarts_04_0194__en-us_topic_0180094081_b184542058101617">param_type</strong> is set to <strong id="modelarts_04_0194__en-us_topic_0180094081_b645535831610">int</strong> or <strong id="modelarts_04_0194__en-us_topic_0180094081_b14455458111618">float</strong>. By default, this parameter is left blank.</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row592412812291"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.6.4.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p292498142912">param_desc</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.4.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p2092478162918">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.6.4.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p492410852912">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.6.4.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p159241822920">Parameter description, which contains a maximum of 100 characters. By default, this parameter is left blank.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_table189248816299" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="modelarts_04_0194__en-us_topic_0180094081_b611611171711">dependency</strong> parameters</caption><thead align="left"><tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row3924589295"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.6.5.2.5.1.1"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p7924168162917">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.5.2.5.1.2"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1924148132911">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.5.2.5.1.3"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p792458162920">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54%" id="mcps1.3.6.5.2.5.1.4"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p199244813294">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row19924282295"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.6.5.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p292419813292">installer</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.5.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p9924198172917">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.5.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p209248842919">String</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.6.5.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p992420811297">Installation mode. Only <span class="parmvalue" id="modelarts_04_0194__en-us_topic_0180094081_parmvalue38285538463"><b>pip</b></span> is supported.</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row2924168192911"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.6.5.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p119243862910">packages</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.5.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p189242086298">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.5.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p692413817298"><strong id="modelarts_04_0194__en-us_topic_0180094081_b224415244520">package</strong> array</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.6.5.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p892416832912">Collection of dependency packages</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_table7924168152916" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="modelarts_04_0194__en-us_topic_0180094081_b463195141718">package</strong> parameters</caption><thead align="left"><tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row1392411872915"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.6.6.2.5.1.1"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p49241186297">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.6.2.5.1.2"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p20924108112915">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.6.2.5.1.3"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p17924188162912">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54%" id="mcps1.3.6.6.2.5.1.4"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p9924185292">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row1892420816298"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.6.6.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p09240842918">package_name</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.6.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p10924158182910">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.6.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p39241485295">String</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.6.6.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p39241988292">Name of a dependency package</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row1792488182919"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.6.6.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p11924685291">package_version</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.6.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p16924488291">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.6.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p119244816295">String</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.6.6.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p119245812910">Version of a dependency package</p>
</td>
</tr>
<tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row1592478112916"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.6.6.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p13924188142916">restraint</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.6.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1292411892914">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.6.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1792488112919">String</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.6.6.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_p2314411201">Version filtering condition. This parameter is mandatory only when <strong id="modelarts_04_0194__en-us_topic_0180094081_b13897227985">package_version</strong> exists. Possible values are as follows:</p>
<ul id="modelarts_04_0194__en-us_topic_0180094081_ul2314445209"><li id="modelarts_04_0194__en-us_topic_0180094081_li633324672019"><strong id="modelarts_04_0194__en-us_topic_0180094081_b4412223131710">EXACT</strong>: the specified version</li><li id="modelarts_04_0194__en-us_topic_0180094081_li3754648112010"><strong id="modelarts_04_0194__en-us_topic_0180094081_b76031243175">ATLEAST</strong>: not earlier than the specified version</li><li id="modelarts_04_0194__en-us_topic_0180094081_li43119447202"><strong id="modelarts_04_0194__en-us_topic_0180094081_b19650193341714">ATMOST</strong>: not later than the specified version</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_table19248816291" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="modelarts_04_0194__en-us_topic_0180094081_b266933461711">create_model</strong> response parameters</caption><thead align="left"><tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row092468182915"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.6.7.2.5.1.1"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p119241181292">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.7.2.5.1.2"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p189248810294">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.7.2.5.1.3"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p39246812913">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54%" id="mcps1.3.6.7.2.5.1.4"><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p16924148142918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_row1392418102915"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.6.7.2.5.1.1 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p1892488192918">model_instance</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.7.2.5.1.2 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p492438142911">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.7.2.5.1.3 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p11924108162919">Model object</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.6.7.2.5.1.4 "><p id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p19924118192917">Model object, which can be any of the APIs described in this chapter</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_note1292414818297"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><div class="p" id="modelarts_04_0194__en-us_topic_0180094081_en-us_topic_0160574216_p169249892911">Example of creating a model in a handwritten digit recognition project using MXNet:<div class="codecoloring" codetype="Python" id="modelarts_04_0194__en-us_topic_0180094081_screen1205194032118"><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>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</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.model</span> <span class="kn">import</span> <span class="n">Model</span>
<span class="n">session</span> <span class="o">=</span> <span class="n">Session</span><span class="p">()</span>
<span class="n">model_instance</span> <span class="o">=</span> <span class="n">Model</span><span class="p">(</span><span class="n">session</span><span class="p">,</span>
<span class="n">model_name</span><span class="o">=</span><span class="s2">&quot;digit_recognition&quot;</span><span class="p">,</span>
<span class="n">model_version</span><span class="o">=</span><span class="s2">&quot;1.0.0&quot;</span><span class="p">,</span>
<span class="n">source_location</span><span class="o">=</span><span class="n">model_location</span><span class="p">,</span>
<span class="n">model_type</span><span class="o">=</span><span class="s2">&quot;MXNet&quot;</span><span class="p">,</span>
<span class="n">model_algorithm</span><span class="o">=</span><span class="s2">&quot;image_classification&quot;</span>
<span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
</div></div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="modelarts_04_0193.html">Model Management</a></div>
</div>
</div>
View Git Blame Copy Permalink