forked from docs/doc-exports
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>
1407 lines
106 KiB
HTML
1407 lines
106 KiB
HTML
<a name="EN-US_TOPIC_0000001943974157"></a><a name="EN-US_TOPIC_0000001943974157"></a>
|
|
|
|
<h1 class="topictitle1">Specifications for Editing a Model Configuration File </h1>
|
|
<div id="body0000001210080157"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p8060118">You must edit a configuration file <strong id="EN-US_TOPIC_0000001943974157__b186581018193612">config.json</strong> when publishing a model. The model configuration file describes the model usage, computing framework, precision, inference code dependency package, and model API.</p>
|
|
<div class="section" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_section677218485416"><h4 class="sectiontitle">Configuration File Format</h4><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1668565774120">The configuration file is in JSON format. <a href="#EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table7143191919436">Table 1</a> describes the parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table7143191919436"></a><a name="en-us_topic_0172466149_table7143191919436"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table7143191919436" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row11203161917436"><th align="left" class="cellrowborder" valign="top" width="15.67%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1220313195432">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.979999999999999%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p19203171918436">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.549999999999999%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p14203151918436">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.8%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p42031019164312">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row1720381944316"><td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p2203181924319">model_algorithm</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.979999999999999%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p15203121915435">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.549999999999999%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p122031196437">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.8%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p42031319124311">Model algorithm, which is set by the model developer to help users understand the usage of the model. The value must start with a letter and contain no more than 36 characters. Special characters (&!'\"<>=) are not allowed. Common model algorithms include <strong id="EN-US_TOPIC_0000001943974157__b120110110581">image_classification</strong>, <strong id="EN-US_TOPIC_0000001943974157__b1120219112584">object_detection</strong>, and <strong id="EN-US_TOPIC_0000001943974157__b82021711155818">predict_analysis</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row1320321911433"><td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p132031619184317">model_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.979999999999999%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p16203131954319">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.549999999999999%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1204171919439">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.8%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1120471924312">Model AI engine, which indicates the computing framework used by a model. Common AI engines and <strong id="EN-US_TOPIC_0000001943974157__b1311821515589">Image</strong> are supported.</p>
|
|
<ul id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_ul109545693120"><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li159547673114">For details about supported AI engines, see <a href="inference-modelarts-0003.html#EN-US_TOPIC_0000001943974209__en-us_topic_0171858287_section04192617912">Supported AI Engines for ModelArts Inference</a>.</li><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li69543611314">If <strong id="EN-US_TOPIC_0000001943974157__b1266423095815">model_type</strong> is set to <strong id="EN-US_TOPIC_0000001943974157__b136653302581">Image</strong>, the AI application is created using a custom image. In this case, parameter <strong id="EN-US_TOPIC_0000001943974157__b1266563018588">swr_location</strong> is mandatory. For details about specifications for custom images, see <a href="modelarts_23_0219.html">Custom Image Specifications for Creating an AI Application</a>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row1520411964314"><td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p7204719144316">runtime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.979999999999999%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p18204719164310">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.549999999999999%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p19204171914431">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.8%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p5204141974315">Model runtime environment. Python 3.6 is used by default. The value of <strong id="EN-US_TOPIC_0000001943974157__b178578018120">runtime</strong> depends on the value of <strong id="EN-US_TOPIC_0000001943974157__b685720213">model_type</strong>. If <strong id="EN-US_TOPIC_0000001943974157__b5857200611">model_type</strong> is set to <strong id="EN-US_TOPIC_0000001943974157__b285811013115">Image</strong>, you do not need to set <strong id="EN-US_TOPIC_0000001943974157__b108591807112">runtime</strong>. If <strong id="EN-US_TOPIC_0000001943974157__b3859301011">model_type</strong> is set to another mainstream framework, select the engine and runtime environment. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row82045192436"><td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p19204819124318">swr_location</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.979999999999999%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p720418190433">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.549999999999999%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p520421915435">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.8%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p132081031113818">SWR image address.</p>
|
|
<ul id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_ul17272122510110"><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li1127282511111">If you import a custom image metamodel from a container image, you do not need to set <strong id="EN-US_TOPIC_0000001943974157__b07217151332">swr_location</strong>.</li><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li17794193319185">If you import a custom image meta model from OBS (not recommended) and set <strong id="EN-US_TOPIC_0000001943974157__b1212432613318">model_type</strong> to <strong id="EN-US_TOPIC_0000001943974157__b17124226635">Image</strong>, you must set <strong id="EN-US_TOPIC_0000001943974157__b1112518266317">swr_location</strong>. <strong id="EN-US_TOPIC_0000001943974157__b352911206416">swr_location</strong> specifies the path to the Docker image on SWR, which will be used to publish the model.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row1920411974313"><td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p6204171916437">metrics</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.979999999999999%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p152046199435">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.549999999999999%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p3204419174317">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.8%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p19204171944317">Model precision information, including the F1 score, recall, precision, and accuracy. For details about the <strong id="EN-US_TOPIC_0000001943974157__b194211746541">metrics</strong> object structure, see <a href="#EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table81712704511">Table 2</a>.</p>
|
|
<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p125791956123818">The result is displayed in the model precision area on the AI application details page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row5204101913436"><td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p3204419104311">apis</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.979999999999999%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p82041319154310">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.549999999999999%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p9204191934319">api array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.8%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p121288351399">Format of the requests received and returned by a model. The value is structure data.</p>
|
|
<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p14429228194617">It is the RESTful API array provided by a model. For details about the API data structure, see <a href="#EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table1683418482455">Table 3</a>. For details about the code example, see <a href="#EN-US_TOPIC_0000001943974157__section9498141310396">Code Example of apis Parameters</a>.</p>
|
|
<ul id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_ul58205323238"><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li9820632202311">If <span class="parmname" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_parmname14952142919231"><b>model_type</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_parmvalue129521729182311"><b>Image</b></span>, the AI application is created using a custom image. APIs with different paths can be declared in <span class="parmname" id="EN-US_TOPIC_0000001943974157__parmname03612161278"><b>apis</b></span> based on the request path exposed by the image.</li><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li1882003213230">When <strong id="EN-US_TOPIC_0000001943974157__b153353241489">model_type</strong> is not <strong id="EN-US_TOPIC_0000001943974157__b123365242083">Image</strong>, only one API whose request path is <strong id="EN-US_TOPIC_0000001943974157__b203378249816">/</strong> can be declared in <span class="parmname" id="EN-US_TOPIC_0000001943974157__parmname2337624588"><b>apis</b></span> because the preconfigured AI engine exposes only one inference API whose request path is <strong id="EN-US_TOPIC_0000001943974157__b833818247819">/</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row1820551910435"><td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p0205111917436">dependencies</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.979999999999999%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p520571915435">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.549999999999999%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1205171954314">dependency array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.8%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p2081175214304">Package on which the model inference code depends, which is structure data.</p>
|
|
<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p461616349473">Model developers need to provide the package name, installation mode, and version constraints. Only the pip installation mode is supported. <a href="#EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table13709813144819">Table 6</a> describes the dependency array.</p>
|
|
<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1708154013474">If the model package does not contain the <strong id="EN-US_TOPIC_0000001943974157__b462884514341">customize_service.py</strong> file, you do not need to set this parameter. Dependency packages cannot be installed for custom image models.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row1375212074819"><td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p775222016488">health</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.979999999999999%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p27525206488">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.549999999999999%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p975282054820">health data structure</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.8%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p195731431519">Configuration of an image health interface. This parameter is mandatory only when <strong id="EN-US_TOPIC_0000001943974157__b15485111113369">model_type</strong> is set to <strong id="EN-US_TOPIC_0000001943974157__b1348516114362">Image</strong>.</p>
|
|
<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1075252034819">If services cannot be interrupted during a rolling upgrade, a health check API must be provided for ModelArts to call. For details about the health data structure, see <a href="#EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table115896191852">Table 8</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table81712704511"></a><a name="en-us_topic_0172466149_table81712704511"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table81712704511" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0000001943974157__b1891122819111">metrics</strong> object description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row1777142774517"><th align="left" class="cellrowborder" valign="top" width="15.718428157184283%" id="mcps1.3.2.4.2.5.1.1"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p177713278458">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.998900109989002%" id="mcps1.3.2.4.2.5.1.2"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p377112719457">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.50894910508949%" id="mcps1.3.2.4.2.5.1.3"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1277427144516">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.77372262773723%" id="mcps1.3.2.4.2.5.1.4"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p177702715455">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row13774279450"><td class="cellrowborder" valign="top" width="15.718428157184283%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p07711279456">f1</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.998900109989002%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p97711275458">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.50894910508949%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p127720278454">Number</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.77372262773723%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p15771227104512">F1 score. The value is rounded to 17 decimal places.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row1077182754519"><td class="cellrowborder" valign="top" width="15.718428157184283%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1781227104514">recall</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.998900109989002%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p178727144520">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.50894910508949%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p0781127114520">Number</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.77372262773723%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p20785275455">Recall. The value is rounded to 17 decimal places.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row107832734518"><td class="cellrowborder" valign="top" width="15.718428157184283%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p13781927194513">precision</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.998900109989002%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p18780272459">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.50894910508949%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p19788274453">Number</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.77372262773723%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p578427104513">Precision. The value is rounded to 17 decimal places.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row7781727144511"><td class="cellrowborder" valign="top" width="15.718428157184283%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p127812744519">accuracy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.998900109989002%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p978182764519">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.50894910508949%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p5781427134514">Number</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.77372262773723%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p17972717452">Accuracy. The value is rounded to 17 decimal places.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table1683418482455"></a><a name="en-us_topic_0172466149_table1683418482455"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table1683418482455" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0000001943974157__b116533814111">api</strong> data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row3892114815451"><th align="left" class="cellrowborder" valign="top" width="14.378562143785622%" id="mcps1.3.2.5.2.5.1.1"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p9892174812451">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.218778122187782%" id="mcps1.3.2.5.2.5.1.2"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p489254812453">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.598940105989401%" id="mcps1.3.2.5.2.5.1.3"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p198921448124517">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.80371962803719%" id="mcps1.3.2.5.2.5.1.4"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p789214810458">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row11893148164512"><td class="cellrowborder" valign="top" width="14.378562143785622%" headers="mcps1.3.2.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p20893248154514">url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.218778122187782%" headers="mcps1.3.2.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1089311480458">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.598940105989401%" headers="mcps1.3.2.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p14893154834518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.80371962803719%" headers="mcps1.3.2.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p16893184814512">Request path. The default value is a slash (<span class="parmvalue" id="EN-US_TOPIC_0000001943974157__parmvalue1596394916451"><b>/</b></span>). For a custom image model (<strong id="EN-US_TOPIC_0000001943974157__b5598952184518">model_type</strong> is <strong id="EN-US_TOPIC_0000001943974157__b1599352154516">Image</strong>), set this parameter to the actual request path exposed in the image. For a non-custom image model (<strong id="EN-US_TOPIC_0000001943974157__b17768155864511">model_type</strong> is not <strong id="EN-US_TOPIC_0000001943974157__b1476965817457">Image</strong>), the URL can only be <strong id="EN-US_TOPIC_0000001943974157__b1376945814518">/</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row178931548114515"><td class="cellrowborder" valign="top" width="14.378562143785622%" headers="mcps1.3.2.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p18893124817455">method</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.218778122187782%" headers="mcps1.3.2.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1089315481459">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.598940105989401%" headers="mcps1.3.2.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p989364874518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.80371962803719%" headers="mcps1.3.2.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p7893948134520">Request method. The default value is <span class="parmname" id="EN-US_TOPIC_0000001943974157__parmname36671249124719"><b>POST</b></span>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row18893948144513"><td class="cellrowborder" valign="top" width="14.378562143785622%" headers="mcps1.3.2.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p389334812455">request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.218778122187782%" headers="mcps1.3.2.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p168931148164514">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.598940105989401%" headers="mcps1.3.2.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p2893448114515">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.80371962803719%" headers="mcps1.3.2.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p88935489458">Request body. For details, see <a href="#EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table332913335466">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row574651734618"><td class="cellrowborder" valign="top" width="14.378562143785622%" headers="mcps1.3.2.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p0713161811466">response</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.218778122187782%" headers="mcps1.3.2.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p20713318194617">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.598940105989401%" headers="mcps1.3.2.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p27135188463">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.80371962803719%" headers="mcps1.3.2.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p971361804617">Response body. For details, see <a href="#EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table17521240184711">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table332913335466"></a><a name="en-us_topic_0172466149_table332913335466"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table332913335466" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0000001943974157__b99202464816">request</strong> structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row113891633204616"><th align="left" class="cellrowborder" valign="top" width="14.228577142285772%" id="mcps1.3.2.6.2.5.1.1"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1738983314468">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.938606139386062%" id="mcps1.3.2.6.2.5.1.2"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p438913338467">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.448755124487551%" id="mcps1.3.2.6.2.5.1.3"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1038915336462">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.38406159384062%" id="mcps1.3.2.6.2.5.1.4"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1238916337467">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row1038918334464"><td class="cellrowborder" valign="top" width="14.228577142285772%" headers="mcps1.3.2.6.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p23898337466">Content-type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.938606139386062%" headers="mcps1.3.2.6.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1390153315468">No for real-time services</p>
|
|
<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1286122917493">Yes for batch services</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.448755124487551%" headers="mcps1.3.2.6.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p4390103312468">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.38406159384062%" headers="mcps1.3.2.6.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1030518322486">Data is sent in a specified content format. The default value is <span class="parmvalue" id="EN-US_TOPIC_0000001943974157__parmvalue7456134464814"><b>application/json</b></span>.</p>
|
|
<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p239003384620">The options are as follows:</p>
|
|
<ul id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_ul13891518411"><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li188101510416"><strong id="EN-US_TOPIC_0000001943974157__b936125113483">application/json</strong>: JSON data is uploaded.</li><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li027416433417"><strong id="EN-US_TOPIC_0000001943974157__b81904944911">multipart/form-data</strong>: A file is uploaded. </li></ul>
|
|
<div class="note" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_note14399133218326"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p539913293210">For machine learning models, only <strong id="EN-US_TOPIC_0000001943974157__b106900131498">application/json</strong> is supported.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row103901133124613"><td class="cellrowborder" valign="top" width="14.228577142285772%" headers="mcps1.3.2.6.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p143908334466">data</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.938606139386062%" headers="mcps1.3.2.6.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p12617164874915">No for real-time services</p>
|
|
<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p961744813497">Yes for batch services</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.448755124487551%" headers="mcps1.3.2.6.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p14390113313463">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.38406159384062%" headers="mcps1.3.2.6.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1039083318467">The request body is described in JSON schema.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table17521240184711"></a><a name="en-us_topic_0172466149_table17521240184711"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table17521240184711" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="EN-US_TOPIC_0000001943974157__b6867095019">response</strong> structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row55811540164720"><th align="left" class="cellrowborder" valign="top" width="14.478552144785523%" id="mcps1.3.2.7.2.5.1.1"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p155811940194714">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.048595140485954%" id="mcps1.3.2.7.2.5.1.2"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p13581174011475">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.228777122287772%" id="mcps1.3.2.7.2.5.1.3"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p10581124024718">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.24407559244076%" id="mcps1.3.2.7.2.5.1.4"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p35815401478">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row758174084715"><td class="cellrowborder" valign="top" width="14.478552144785523%" headers="mcps1.3.2.7.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p358111409473">Content-type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.048595140485954%" headers="mcps1.3.2.7.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p88641158184911">No for real-time services</p>
|
|
<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p186425812490">Yes for batch services</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.228777122287772%" headers="mcps1.3.2.7.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p25811740104715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.24407559244076%" headers="mcps1.3.2.7.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1495512018507">Data is sent in a specified content format. The default value is <span class="parmvalue" id="EN-US_TOPIC_0000001943974157__parmvalue16313144894811"><b>application/json</b></span>.</p>
|
|
<div class="note" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_note1252565043811"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p15525135013817">For machine learning models, only <strong id="EN-US_TOPIC_0000001943974157__b1711471634919">application/json</strong> is supported.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row1858114034716"><td class="cellrowborder" valign="top" width="14.478552144785523%" headers="mcps1.3.2.7.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p16581040104720">data</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.048595140485954%" headers="mcps1.3.2.7.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p13338161125012">No for real-time services</p>
|
|
<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p153389116508">Yes for batch services</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.228777122287772%" headers="mcps1.3.2.7.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1858119401471">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.24407559244076%" headers="mcps1.3.2.7.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p958184014719">The response body is described in JSON schema.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table13709813144819"></a><a name="en-us_topic_0172466149_table13709813144819"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table13709813144819" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="EN-US_TOPIC_0000001943974157__b188475065013">dependency</strong> array description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row378771334813"><th align="left" class="cellrowborder" valign="top" width="17.778222177782226%" id="mcps1.3.2.8.2.5.1.1"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p678871394814">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.778222177782226%" id="mcps1.3.2.8.2.5.1.2"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p17788171394816">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.72782721727827%" id="mcps1.3.2.8.2.5.1.3"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1278861394811">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.71572842715729%" id="mcps1.3.2.8.2.5.1.4"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1078819134484">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row14788141320486"><td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.8.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p197885134486">installer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.8.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1578813132481">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.72782721727827%" headers="mcps1.3.2.8.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p9788413114816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.71572842715729%" headers="mcps1.3.2.8.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p14788213184813">Installation method. Only <span class="parmvalue" id="EN-US_TOPIC_0000001943974157__parmvalue1467490165116"><b>pip</b></span> is supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row19788013184811"><td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.8.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p178851311482">packages</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.8.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p157883136488">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.72782721727827%" headers="mcps1.3.2.8.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p14788131313484"><strong id="EN-US_TOPIC_0000001943974157__b12193015115112">package</strong> array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.71572842715729%" headers="mcps1.3.2.8.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p14788513114819">Dependency package collection. For details about the package structure array, see <a href="#EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table47885356482">Table 7</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table47885356482"></a><a name="en-us_topic_0172466149_table47885356482"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table47885356482" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="EN-US_TOPIC_0000001943974157__b8844824195119">package</strong> array description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row16884635134816"><th align="left" class="cellrowborder" valign="top" width="17.778222177782226%" id="mcps1.3.2.9.2.5.1.1"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p14884113524810">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.778222177782226%" id="mcps1.3.2.9.2.5.1.2"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p19884193517486">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.72782721727827%" id="mcps1.3.2.9.2.5.1.3"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p98841735154817">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.71572842715729%" id="mcps1.3.2.9.2.5.1.4"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p48842353486">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row68851135114810"><td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.9.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p118851235154818">package_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.9.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p16885173574813">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.72782721727827%" headers="mcps1.3.2.9.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p118851735124810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.71572842715729%" headers="mcps1.3.2.9.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p888553514485">Dependency package name. Special characters (&!'"<>=) are not allowed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row14885163574810"><td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.9.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p9885183584810">package_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.9.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p6886183514480">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.72782721727827%" headers="mcps1.3.2.9.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p5886123520482">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.71572842715729%" headers="mcps1.3.2.9.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p11886163504816">Dependency package version. If the dependency package does not rely on package versions, leave this field blank. Special characters (&!'"<>=) are not allowed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row16886335184816"><td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.9.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p188613574812">restraint</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.9.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1088793514815">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.72782721727827%" headers="mcps1.3.2.9.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p208871135104811">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.71572842715729%" headers="mcps1.3.2.9.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1229462518493">Version restriction. This parameter is mandatory only when <span class="parmname" id="EN-US_TOPIC_0000001943974157__parmname157211551105113"><b>package_version</b></span> is configured. Possible values are <span class="parmvalue" id="EN-US_TOPIC_0000001943974157__parmvalue15723851175119"><b>EXACT</b></span>, <span class="parmvalue" id="EN-US_TOPIC_0000001943974157__parmvalue127251451135111"><b>ATLEAST</b></span>, and <span class="parmvalue" id="EN-US_TOPIC_0000001943974157__parmvalue2726195175119"><b>ATMOST</b></span>.</p>
|
|
<ul id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_ul510374493"><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li20173719491"><span class="parmname" id="EN-US_TOPIC_0000001943974157__parmname1991819225218"><b>EXACT</b></span> indicates that a specified version is installed.</li><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li161103734918"><span class="parmname" id="EN-US_TOPIC_0000001943974157__parmname7878259527"><b>ATLEAST</b></span> indicates that the version of the installation package is not earlier than the specified version.</li><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li12116373491"><span class="parmname" id="EN-US_TOPIC_0000001943974157__parmname1412241110528"><b>ATMOST</b></span> indicates that the version of the installation package is not later than the specified version.<div class="note" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_note1086219275551"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_ul17348102725913"><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li6348227155916">If there are specific requirements on the version, preferentially use <strong id="EN-US_TOPIC_0000001943974157__b4540181615520">EXACT</strong>. If <strong id="EN-US_TOPIC_0000001943974157__b9541131645210">EXACT</strong> conflicts with the system installation packages, you can select <strong id="EN-US_TOPIC_0000001943974157__b154121675211">ATLEAST</strong>.</li><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li13626536105914">If there is no specific requirement on the version, retain only the <strong id="EN-US_TOPIC_0000001943974157__b1276563105213">package_name</strong> parameter and leave <strong id="EN-US_TOPIC_0000001943974157__b9767531125210">restraint</strong> and <strong id="EN-US_TOPIC_0000001943974157__b207683317528">package_version</strong> blank.</li></ul>
|
|
</div></div>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table115896191852"></a><a name="en-us_topic_0172466149_table115896191852"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_table115896191852" frame="border" border="1" rules="all"><caption><b>Table 8 </b><strong id="EN-US_TOPIC_0000001943974157__b3726124155213">health</strong> data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row858981916518"><th align="left" class="cellrowborder" valign="top" width="17.778222177782226%" id="mcps1.3.2.10.2.5.1.1"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p9589111914520">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.778222177782226%" id="mcps1.3.2.10.2.5.1.2"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p16589619857">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.72782721727827%" id="mcps1.3.2.10.2.5.1.3"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p458919191054">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.71572842715729%" id="mcps1.3.2.10.2.5.1.4"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1558913190517">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row165891219551"><td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.10.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p8589171912511">url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.10.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p135894191752">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.72782721727827%" headers="mcps1.3.2.10.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p758981918519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.71572842715729%" headers="mcps1.3.2.10.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p185891619859">Request URL of the health check API.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row185895191518"><td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.10.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1558915195518">protocol</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.10.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p8589219353">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.72782721727827%" headers="mcps1.3.2.10.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p165898191353">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.71572842715729%" headers="mcps1.3.2.10.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p5589131920510">Request protocol of the health check API. Only HTTP is supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row1958921919519"><td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.10.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p95891119159">initial_delay_seconds</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.10.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p4589519656">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.72782721727827%" headers="mcps1.3.2.10.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p11589719855">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.71572842715729%" headers="mcps1.3.2.10.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p543917256911">After an instance is started, a health check starts after seconds configured in <strong id="EN-US_TOPIC_0000001943974157__b2991614165313">initial_delay_seconds</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_row108032531082"><td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.10.2.5.1.1 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1280314535816">timeout_seconds</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.778222177782226%" headers="mcps1.3.2.10.2.5.1.2 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p15803053387">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.72782721727827%" headers="mcps1.3.2.10.2.5.1.3 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p380318533817">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.71572842715729%" headers="mcps1.3.2.10.2.5.1.4 "><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p58039531481">Health check timeout duration in the unit of second. This parameter cannot be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943974157__section9498141310396"><a name="EN-US_TOPIC_0000001943974157__section9498141310396"></a><a name="section9498141310396"></a><h4 class="sectiontitle">Code Example of apis Parameters</h4><pre class="screen" id="EN-US_TOPIC_0000001943974157__screen910273318429">[{
|
|
"url": "/",
|
|
"method": "post",
|
|
"request": {
|
|
"Content-type": "multipart/form-data",
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"images": {
|
|
"type": "file"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"response": {
|
|
"Content-type": "applicaton/json",
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"mnist_result": {
|
|
"type": "array",
|
|
"item": [
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}]</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_section218715919415"><a name="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_section218715919415"></a><a name="en-us_topic_0172466149_section218715919415"></a><h4 class="sectiontitle">Example of an Object Detection Model Configuration File</h4><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p18323116198">The following code uses the TensorFlow engine as an example. You can modify the <strong id="EN-US_TOPIC_0000001943974157__b856218537548">model_type</strong> parameter based on the actual engine type.</p>
|
|
<ul id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_ul19743491621"><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li7744495210">Model input<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p9447730219"><a name="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li7744495210"></a><a name="en-us_topic_0172466149_li7744495210"></a>Key: images</p>
|
|
<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1447931723">Value: image files</p>
|
|
</li><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li101181414522">Model output<div class="codecoloring" codetype="Python" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_screen41573010218"><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>
|
|
<span class="normal">14</span>
|
|
<span class="normal">15</span>
|
|
<span class="normal">16</span>
|
|
<span class="normal">17</span>
|
|
<span class="normal">18</span>
|
|
<span class="normal">19</span>
|
|
<span class="normal">20</span>
|
|
<span class="normal">21</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
|
|
<span class="s2">"detection_classes"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="s2">"face"</span><span class="p">,</span>
|
|
<span class="s2">"arm"</span>
|
|
<span class="p">],</span>
|
|
<span class="s2">"detection_boxes"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="mf">33.6</span><span class="p">,</span>
|
|
<span class="mf">42.6</span><span class="p">,</span>
|
|
<span class="mf">104.5</span><span class="p">,</span>
|
|
<span class="mf">203.4</span>
|
|
<span class="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="mf">103.1</span><span class="p">,</span>
|
|
<span class="mf">92.8</span><span class="p">,</span>
|
|
<span class="mf">765.6</span><span class="p">,</span>
|
|
<span class="mf">945.7</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s2">"detection_scores"</span><span class="p">:</span> <span class="p">[</span><span class="mf">0.99</span><span class="p">,</span> <span class="mf">0.73</span><span class="p">]</span>
|
|
<span class="p">}</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li1315171322">Configuration file<div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_screen18930715435"><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>
|
|
<span class="normal">14</span>
|
|
<span class="normal">15</span>
|
|
<span class="normal">16</span>
|
|
<span class="normal">17</span>
|
|
<span class="normal">18</span>
|
|
<span class="normal">19</span>
|
|
<span class="normal">20</span>
|
|
<span class="normal">21</span>
|
|
<span class="normal">22</span>
|
|
<span class="normal">23</span>
|
|
<span class="normal">24</span>
|
|
<span class="normal">25</span>
|
|
<span class="normal">26</span>
|
|
<span class="normal">27</span>
|
|
<span class="normal">28</span>
|
|
<span class="normal">29</span>
|
|
<span class="normal">30</span>
|
|
<span class="normal">31</span>
|
|
<span class="normal">32</span>
|
|
<span class="normal">33</span>
|
|
<span class="normal">34</span>
|
|
<span class="normal">35</span>
|
|
<span class="normal">36</span>
|
|
<span class="normal">37</span>
|
|
<span class="normal">38</span>
|
|
<span class="normal">39</span>
|
|
<span class="normal">40</span>
|
|
<span class="normal">41</span>
|
|
<span class="normal">42</span>
|
|
<span class="normal">43</span>
|
|
<span class="normal">44</span>
|
|
<span class="normal">45</span>
|
|
<span class="normal">46</span>
|
|
<span class="normal">47</span>
|
|
<span class="normal">48</span>
|
|
<span class="normal">49</span>
|
|
<span class="normal">50</span>
|
|
<span class="normal">51</span>
|
|
<span class="normal">52</span>
|
|
<span class="normal">53</span>
|
|
<span class="normal">54</span>
|
|
<span class="normal">55</span>
|
|
<span class="normal">56</span>
|
|
<span class="normal">57</span>
|
|
<span class="normal">58</span>
|
|
<span class="normal">59</span>
|
|
<span class="normal">60</span>
|
|
<span class="normal">61</span>
|
|
<span class="normal">62</span>
|
|
<span class="normal">63</span>
|
|
<span class="normal">64</span>
|
|
<span class="normal">65</span>
|
|
<span class="normal">66</span>
|
|
<span class="normal">67</span>
|
|
<span class="normal">68</span>
|
|
<span class="normal">69</span>
|
|
<span class="normal">70</span>
|
|
<span class="normal">71</span></pre></div></td><td class="code"><div><pre><span></span>{
|
|
<span class="w"> </span>"model_type":<span class="w"> </span>"TensorFlow",
|
|
<span class="w"> </span>"model_algorithm":<span class="w"> </span>"object_detection",
|
|
<span class="w"> </span>"metrics":<span class="w"> </span>{
|
|
<span class="w"> </span>"f1":<span class="w"> </span>0.345294,
|
|
<span class="w"> </span>"accuracy":<span class="w"> </span>0.462963,
|
|
<span class="w"> </span>"precision":<span class="w"> </span>0.338977,
|
|
<span class="w"> </span>"recall":<span class="w"> </span>0.351852
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>"apis":<span class="w"> </span>[{
|
|
<span class="w"> </span>
|
|
<span class="w"> </span>"url":<span class="w"> </span>"/",
|
|
<span class="w"> </span>"method":<span class="w"> </span>"post",
|
|
<span class="w"> </span>"request":<span class="w"> </span>{
|
|
<span class="w"> </span>"Content-type":<span class="w"> </span>"multipart/form-data",
|
|
<span class="w"> </span>"data":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{
|
|
<span class="w"> </span>"images":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"file"
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>"response":<span class="w"> </span>{
|
|
<span class="w"> </span>"Content-type":<span class="w"> </span>"application/json",
|
|
<span class="w"> </span>"data":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{
|
|
<span class="w"> </span>"detection_classes":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"array",
|
|
<span class="w"> </span>"items":<span class="w"> </span>[{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"string"
|
|
<span class="w"> </span>}]
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>"detection_boxes":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"array",
|
|
<span class="w"> </span>"items":<span class="w"> </span>[{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"array",
|
|
<span class="w"> </span>"minItems":<span class="w"> </span>4,
|
|
<span class="w"> </span>"maxItems":<span class="w"> </span>4,
|
|
<span class="w"> </span>"items":<span class="w"> </span>[{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"number"
|
|
<span class="w"> </span>}]
|
|
<span class="w"> </span>}]
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>"detection_scores":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"array",
|
|
<span class="w"> </span>"items":<span class="w"> </span>[{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"number"
|
|
<span class="w"> </span>}]
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}],
|
|
<span class="w"> </span>"dependencies":<span class="w"> </span>[{
|
|
<span class="w"> </span>"installer":<span class="w"> </span>"pip",
|
|
<span class="w"> </span>"packages":<span class="w"> </span>[{
|
|
<span class="w"> </span>"restraint":<span class="w"> </span>"EXACT",
|
|
<span class="w"> </span>"package_version":<span class="w"> </span>"1.15.0",
|
|
<span class="w"> </span>"package_name":<span class="w"> </span>"numpy"
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>{
|
|
<span class="w"> </span>"restraint":<span class="w"> </span>"EXACT",
|
|
<span class="w"> </span>"package_version":<span class="w"> </span>"5.2.0",
|
|
<span class="w"> </span>"package_name":<span class="w"> </span>"Pillow"
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>]
|
|
<span class="w"> </span>}]
|
|
}
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_section8806755101916"><h4 class="sectiontitle">Example of an Image Classification Model Configuration File</h4><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p8229421192015">The following code uses the TensorFlow engine as an example. You can modify the <strong id="EN-US_TOPIC_0000001943974157__b195837543552">model_type</strong> parameter based on the actual engine type.</p>
|
|
<ul id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_ul07931028734"><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li97936281538">Model input<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p115813457310"><a name="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li97936281538"></a><a name="en-us_topic_0172466149_li97936281538"></a>Key: images</p>
|
|
<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p9581945833">Value: image files</p>
|
|
</li><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li1261510310318">Model output<div class="codecoloring" codetype="Python" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_screen17964175013314"><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></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
|
|
<span class="s2">"predicted_label"</span><span class="p">:</span> <span class="s2">"flower"</span><span class="p">,</span>
|
|
<span class="s2">"scores"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">[</span><span class="s2">"rose"</span><span class="p">,</span> <span class="mf">0.99</span><span class="p">],</span>
|
|
<span class="p">[</span><span class="s2">"begonia"</span><span class="p">,</span> <span class="mf">0.01</span><span class="p">]</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li79592332316">Configuration file<div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_screen1558320391416"><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>
|
|
<span class="normal">14</span>
|
|
<span class="normal">15</span>
|
|
<span class="normal">16</span>
|
|
<span class="normal">17</span>
|
|
<span class="normal">18</span>
|
|
<span class="normal">19</span>
|
|
<span class="normal">20</span>
|
|
<span class="normal">21</span>
|
|
<span class="normal">22</span>
|
|
<span class="normal">23</span>
|
|
<span class="normal">24</span>
|
|
<span class="normal">25</span>
|
|
<span class="normal">26</span>
|
|
<span class="normal">27</span>
|
|
<span class="normal">28</span>
|
|
<span class="normal">29</span>
|
|
<span class="normal">30</span>
|
|
<span class="normal">31</span>
|
|
<span class="normal">32</span>
|
|
<span class="normal">33</span>
|
|
<span class="normal">34</span>
|
|
<span class="normal">35</span>
|
|
<span class="normal">36</span>
|
|
<span class="normal">37</span>
|
|
<span class="normal">38</span>
|
|
<span class="normal">39</span>
|
|
<span class="normal">40</span>
|
|
<span class="normal">41</span>
|
|
<span class="normal">42</span>
|
|
<span class="normal">43</span>
|
|
<span class="normal">44</span>
|
|
<span class="normal">45</span>
|
|
<span class="normal">46</span>
|
|
<span class="normal">47</span>
|
|
<span class="normal">48</span>
|
|
<span class="normal">49</span>
|
|
<span class="normal">50</span>
|
|
<span class="normal">51</span>
|
|
<span class="normal">52</span>
|
|
<span class="normal">53</span>
|
|
<span class="normal">54</span>
|
|
<span class="normal">55</span>
|
|
<span class="normal">56</span>
|
|
<span class="normal">57</span>
|
|
<span class="normal">58</span>
|
|
<span class="normal">59</span>
|
|
<span class="normal">60</span>
|
|
<span class="normal">61</span>
|
|
<span class="normal">62</span>
|
|
<span class="normal">63</span>
|
|
<span class="normal">64</span>
|
|
<span class="normal">65</span>
|
|
<span class="normal">66</span>
|
|
<span class="normal">67</span></pre></div></td><td class="code"><div><pre><span></span>{
|
|
<span class="w"> </span>"model_type":<span class="w"> </span>"TensorFlow",
|
|
<span class="w"> </span>"model_algorithm":<span class="w"> </span>"image_classification",
|
|
<span class="w"> </span>"metrics":<span class="w"> </span>{
|
|
<span class="w"> </span>"f1":<span class="w"> </span>0.345294,
|
|
<span class="w"> </span>"accuracy":<span class="w"> </span>0.462963,
|
|
<span class="w"> </span>"precision":<span class="w"> </span>0.338977,
|
|
<span class="w"> </span>"recall":<span class="w"> </span>0.351852
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>"apis":<span class="w"> </span>[{
|
|
<span class="w"> </span>
|
|
<span class="w"> </span>"url":<span class="w"> </span>"/",
|
|
<span class="w"> </span>"method":<span class="w"> </span>"post",
|
|
<span class="w"> </span>"request":<span class="w"> </span>{
|
|
<span class="w"> </span>"Content-type":<span class="w"> </span>"multipart/form-data",
|
|
<span class="w"> </span>"data":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{
|
|
<span class="w"> </span>"images":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"file"
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>"response":<span class="w"> </span>{
|
|
<span class="w"> </span>"Content-type":<span class="w"> </span>"application/json",
|
|
<span class="w"> </span>"data":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{
|
|
<span class="w"> </span>"predicted_label":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"string"
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>"scores":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"array",
|
|
<span class="w"> </span>"items":<span class="w"> </span>[{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"array",
|
|
<span class="w"> </span>"minItems":<span class="w"> </span>2,
|
|
<span class="w"> </span>"maxItems":<span class="w"> </span>2,
|
|
<span class="w"> </span>"items":<span class="w"> </span>[
|
|
<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"string"
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"number"
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>]
|
|
<span class="w"> </span>}]
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}],
|
|
<span class="w"> </span>"dependencies":<span class="w"> </span>[{
|
|
<span class="w"> </span>"installer":<span class="w"> </span>"pip",
|
|
<span class="w"> </span>"packages":<span class="w"> </span>[{
|
|
<span class="w"> </span>"restraint":<span class="w"> </span>"ATLEAST",
|
|
<span class="w"> </span>"package_version":<span class="w"> </span>"1.15.0",
|
|
<span class="w"> </span>"package_name":<span class="w"> </span>"numpy"
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>{
|
|
<span class="w"> </span>"restraint":<span class="w"> </span>"",
|
|
<span class="w"> </span>"package_version":<span class="w"> </span>"",
|
|
<span class="w"> </span>"package_name":<span class="w"> </span>"Pillow"
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>]
|
|
<span class="w"> </span>}]
|
|
}
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_section1490393064512"><h4 class="sectiontitle">Example of a Predictive Analytics Model Configuration File</h4><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p13569122091519">The following code uses the TensorFlow engine as an example. You can modify the <strong id="EN-US_TOPIC_0000001943974157__b4586654125517">model_type</strong> parameter based on the actual engine type.</p>
|
|
<ul id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_ul629110581646"><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li6291125817415">Model input<div class="codecoloring" codetype="Python" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_screen157161625659"><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>
|
|
<span class="normal">14</span>
|
|
<span class="normal">15</span>
|
|
<span class="normal">16</span>
|
|
<span class="normal">17</span>
|
|
<span class="normal">18</span>
|
|
<span class="normal">19</span>
|
|
<span class="normal">20</span>
|
|
<span class="normal">21</span>
|
|
<span class="normal">22</span>
|
|
<span class="normal">23</span>
|
|
<span class="normal">24</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
|
|
<span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s2">"req_data"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s2">"buying_price"</span><span class="p">:</span> <span class="s2">"high"</span><span class="p">,</span>
|
|
<span class="s2">"maint_price"</span><span class="p">:</span> <span class="s2">"high"</span><span class="p">,</span>
|
|
<span class="s2">"doors"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
|
|
<span class="s2">"persons"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
|
|
<span class="s2">"lug_boot"</span><span class="p">:</span> <span class="s2">"small"</span><span class="p">,</span>
|
|
<span class="s2">"safety"</span><span class="p">:</span> <span class="s2">"low"</span><span class="p">,</span>
|
|
<span class="s2">"acceptability"</span><span class="p">:</span> <span class="s2">"acc"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s2">"buying_price"</span><span class="p">:</span> <span class="s2">"high"</span><span class="p">,</span>
|
|
<span class="s2">"maint_price"</span><span class="p">:</span> <span class="s2">"high"</span><span class="p">,</span>
|
|
<span class="s2">"doors"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
|
|
<span class="s2">"persons"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
|
|
<span class="s2">"lug_boot"</span><span class="p">:</span> <span class="s2">"small"</span><span class="p">,</span>
|
|
<span class="s2">"safety"</span><span class="p">:</span> <span class="s2">"low"</span><span class="p">,</span>
|
|
<span class="s2">"acceptability"</span><span class="p">:</span> <span class="s2">"acc"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li10051551">Model output<div class="codecoloring" codetype="Python" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_screen974574011718"><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></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
|
|
<span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s2">"resp_data"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s2">"predict_result"</span><span class="p">:</span> <span class="s2">"unacc"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s2">"predict_result"</span><span class="p">:</span> <span class="s2">"unacc"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li372010210513">Configuration file<div class="note" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_note95211743173617"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p206734913369">In the code, the <strong id="EN-US_TOPIC_0000001943974157__b371518296592">data</strong> parameter in the request and response structures is described in JSON Schema. The content in <strong id="EN-US_TOPIC_0000001943974157__b1163694812599">data</strong> and <strong id="EN-US_TOPIC_0000001943974157__b7636174816598">properties</strong> corresponds to the model input and output.</p>
|
|
</div></div>
|
|
<div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_screen355813593719"><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>
|
|
<span class="normal">14</span>
|
|
<span class="normal">15</span>
|
|
<span class="normal">16</span>
|
|
<span class="normal">17</span>
|
|
<span class="normal">18</span>
|
|
<span class="normal">19</span>
|
|
<span class="normal">20</span>
|
|
<span class="normal">21</span>
|
|
<span class="normal">22</span>
|
|
<span class="normal">23</span>
|
|
<span class="normal">24</span>
|
|
<span class="normal">25</span>
|
|
<span class="normal">26</span>
|
|
<span class="normal">27</span>
|
|
<span class="normal">28</span>
|
|
<span class="normal">29</span>
|
|
<span class="normal">30</span>
|
|
<span class="normal">31</span>
|
|
<span class="normal">32</span>
|
|
<span class="normal">33</span>
|
|
<span class="normal">34</span>
|
|
<span class="normal">35</span>
|
|
<span class="normal">36</span>
|
|
<span class="normal">37</span>
|
|
<span class="normal">38</span>
|
|
<span class="normal">39</span>
|
|
<span class="normal">40</span>
|
|
<span class="normal">41</span>
|
|
<span class="normal">42</span>
|
|
<span class="normal">43</span>
|
|
<span class="normal">44</span>
|
|
<span class="normal">45</span>
|
|
<span class="normal">46</span>
|
|
<span class="normal">47</span>
|
|
<span class="normal">48</span>
|
|
<span class="normal">49</span>
|
|
<span class="normal">50</span>
|
|
<span class="normal">51</span>
|
|
<span class="normal">52</span>
|
|
<span class="normal">53</span>
|
|
<span class="normal">54</span>
|
|
<span class="normal">55</span>
|
|
<span class="normal">56</span>
|
|
<span class="normal">57</span>
|
|
<span class="normal">58</span>
|
|
<span class="normal">59</span>
|
|
<span class="normal">60</span>
|
|
<span class="normal">61</span>
|
|
<span class="normal">62</span>
|
|
<span class="normal">63</span>
|
|
<span class="normal">64</span>
|
|
<span class="normal">65</span>
|
|
<span class="normal">66</span>
|
|
<span class="normal">67</span>
|
|
<span class="normal">68</span>
|
|
<span class="normal">69</span>
|
|
<span class="normal">70</span>
|
|
<span class="normal">71</span>
|
|
<span class="normal">72</span>
|
|
<span class="normal">73</span>
|
|
<span class="normal">74</span>
|
|
<span class="normal">75</span>
|
|
<span class="normal">76</span>
|
|
<span class="normal">77</span>
|
|
<span class="normal">78</span></pre></div></td><td class="code"><div><pre><span></span>{
|
|
<span class="w"> </span>"model_type":<span class="w"> </span>"TensorFlow",
|
|
<span class="w"> </span>"model_algorithm":<span class="w"> </span>"predict_analysis",
|
|
<span class="w"> </span>"metrics":<span class="w"> </span>{
|
|
<span class="w"> </span>"f1":<span class="w"> </span>0.345294,
|
|
<span class="w"> </span>"accuracy":<span class="w"> </span>0.462963,
|
|
<span class="w"> </span>"precision":<span class="w"> </span>0.338977,
|
|
<span class="w"> </span>"recall":<span class="w"> </span>0.351852
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>"apis":<span class="w"> </span>[
|
|
<span class="w"> </span>{
|
|
<span class="w"> </span>
|
|
<span class="w"> </span>"url":<span class="w"> </span>"/",
|
|
<span class="w"> </span>"method":<span class="w"> </span>"post",
|
|
<span class="w"> </span>"request":<span class="w"> </span>{
|
|
<span class="w"> </span>"Content-type":<span class="w"> </span>"application/json",
|
|
<span class="w"> </span>"data":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{
|
|
<span class="w"> </span>"data":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{
|
|
<span class="w"> </span>"req_data":<span class="w"> </span>{
|
|
<span class="w"> </span>"items":<span class="w"> </span>[
|
|
<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>],
|
|
<span class="w"> </span>"type":<span class="w"> </span>"array"
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>"response":<span class="w"> </span>{
|
|
<span class="w"> </span>"Content-type":<span class="w"> </span>"application/json",
|
|
<span class="w"> </span>"data":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{
|
|
<span class="w"> </span>"data":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{
|
|
<span class="w"> </span>"resp_data":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"array",
|
|
<span class="w"> </span>"items":<span class="w"> </span>[
|
|
<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>]
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>],
|
|
<span class="w"> </span>"dependencies":<span class="w"> </span>[
|
|
<span class="w"> </span>{
|
|
<span class="w"> </span>"installer":<span class="w"> </span>"pip",
|
|
<span class="w"> </span>"packages":<span class="w"> </span>[
|
|
<span class="w"> </span>{
|
|
<span class="w"> </span>"restraint":<span class="w"> </span>"EXACT",
|
|
<span class="w"> </span>"package_version":<span class="w"> </span>"1.15.0",
|
|
<span class="w"> </span>"package_name":<span class="w"> </span>"numpy"
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>{
|
|
<span class="w"> </span>"restraint":<span class="w"> </span>"EXACT",
|
|
<span class="w"> </span>"package_version":<span class="w"> </span>"5.2.0",
|
|
<span class="w"> </span>"package_name":<span class="w"> </span>"Pillow"
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>]
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>]
|
|
}
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_section9113122232018"><h4 class="sectiontitle">Example of a Custom Image Model Configuration File</h4><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p184212308818">The model input and output are similar to those in <a href="#EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_section218715919415">Example of an Object Detection Model Configuration File</a>.</p>
|
|
<ul id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_ul91171528224"><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li011814281029">The following is a request example when the input is images.<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p1732711551441"><a name="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li011814281029"></a><a name="en-us_topic_0172466149_li011814281029"></a>This is a model prediction request containing the parameter <strong id="EN-US_TOPIC_0000001943974157__b68731112212">images</strong> with the parameter type of file is received. The file upload button is displayed on the inference page. You need to upload files for inference.</p>
|
|
<div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_screen1882918186717"><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="w"> </span>"Content-type":<span class="w"> </span>"multipart/form-data",
|
|
<span class="w"> </span>"data":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{
|
|
<span class="w"> </span>"images":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"file"
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
}
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li821211391826">The following is a request example when the input is JSON data.<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p7722143763910"><a name="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li821211391826"></a><a name="en-us_topic_0172466149_li821211391826"></a>This is a JSON request body for model prediction. There is only one prediction request containing the parameter <strong id="EN-US_TOPIC_0000001943974157__b38701255437">input</strong> with the parameter type of string. On the inference page, a text box is displayed for you to enter the prediction request.</p>
|
|
<div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_screen141704313443"><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="w"> </span>"Content-type":<span class="w"> </span>"application/json",
|
|
<span class="w"> </span>"data":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{
|
|
<span class="w"> </span>"input":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"string"
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
}
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p2032513425513">A complete request example is as follows:</p>
|
|
<div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_screen698819551191"><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>
|
|
<span class="normal">14</span>
|
|
<span class="normal">15</span>
|
|
<span class="normal">16</span>
|
|
<span class="normal">17</span>
|
|
<span class="normal">18</span>
|
|
<span class="normal">19</span>
|
|
<span class="normal">20</span>
|
|
<span class="normal">21</span>
|
|
<span class="normal">22</span>
|
|
<span class="normal">23</span>
|
|
<span class="normal">24</span>
|
|
<span class="normal">25</span>
|
|
<span class="normal">26</span>
|
|
<span class="normal">27</span>
|
|
<span class="normal">28</span>
|
|
<span class="normal">29</span>
|
|
<span class="normal">30</span>
|
|
<span class="normal">31</span>
|
|
<span class="normal">32</span>
|
|
<span class="normal">33</span>
|
|
<span class="normal">34</span>
|
|
<span class="normal">35</span>
|
|
<span class="normal">36</span>
|
|
<span class="normal">37</span>
|
|
<span class="normal">38</span>
|
|
<span class="normal">39</span>
|
|
<span class="normal">40</span>
|
|
<span class="normal">41</span>
|
|
<span class="normal">42</span>
|
|
<span class="normal">43</span>
|
|
<span class="normal">44</span>
|
|
<span class="normal">45</span>
|
|
<span class="normal">46</span>
|
|
<span class="normal">47</span>
|
|
<span class="normal">48</span>
|
|
<span class="normal">49</span>
|
|
<span class="normal">50</span>
|
|
<span class="normal">51</span>
|
|
<span class="normal">52</span>
|
|
<span class="normal">53</span>
|
|
<span class="normal">54</span>
|
|
<span class="normal">55</span>
|
|
<span class="normal">56</span></pre></div></td><td class="code"><div><pre><span></span>{
|
|
<span class="w"> </span>"model_algorithm":<span class="w"> </span>"image_classification",
|
|
<span class="w"> </span>"model_type":<span class="w"> </span>"Image",
|
|
<span class="w"> </span>"metrics":<span class="w"> </span>{
|
|
<span class="w"> </span>"f1":<span class="w"> </span>0.345294,
|
|
<span class="w"> </span>"accuracy":<span class="w"> </span>0.462963,
|
|
<span class="w"> </span>"precision":<span class="w"> </span>0.338977,
|
|
<span class="w"> </span>"recall":<span class="w"> </span>0.351852
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>"apis":<span class="w"> </span>[{
|
|
<span class="w"> </span>
|
|
<span class="w"> </span>"url":<span class="w"> </span>"/",
|
|
<span class="w"> </span>"method":<span class="w"> </span>"post",
|
|
<span class="w"> </span>"request":<span class="w"> </span>{
|
|
<span class="w"> </span>"Content-type":<span class="w"> </span>"multipart/form-data",
|
|
<span class="w"> </span>"data":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{
|
|
<span class="w"> </span>"images":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"file"
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>"response":<span class="w"> </span>{
|
|
<span class="w"> </span>"Content-type":<span class="w"> </span>"application/json",
|
|
<span class="w"> </span>"data":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"required":<span class="w"> </span>[
|
|
<span class="w"> </span>"predicted_label",
|
|
<span class="w"> </span>"scores"
|
|
<span class="w"> </span>],
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{
|
|
<span class="w"> </span>"predicted_label":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"string"
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>"scores":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"array",
|
|
<span class="w"> </span>"items":<span class="w"> </span>[{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"array",
|
|
<span class="w"> </span>"minItems":<span class="w"> </span>2,
|
|
<span class="w"> </span>"maxItems":<span class="w"> </span>2,
|
|
<span class="w"> </span>"items":<span class="w"> </span>[{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"string"
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"number"
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>]
|
|
<span class="w"> </span>}]
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}]
|
|
}
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_section18488143221"><h4 class="sectiontitle">Example of a Machine Learning Model Configuration File</h4><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p17358113192814">The following uses XGBoost as an example:</p>
|
|
<ul id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_ul12224026121620"><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li522472610161">Model input</li></ul>
|
|
<pre class="screen" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_screen13935184261617">{
|
|
"req_data": [
|
|
{
|
|
"sepal_length": 5,
|
|
"sepal_width": 3.3,
|
|
"petal_length": 1.4,
|
|
"petal_width": 0.2
|
|
},
|
|
{
|
|
"sepal_length": 5,
|
|
"sepal_width": 2,
|
|
"petal_length": 3.5,
|
|
"petal_width": 1
|
|
},
|
|
{
|
|
"sepal_length": 6,
|
|
"sepal_width": 2.2,
|
|
"petal_length": 5,
|
|
"petal_width": 1.5
|
|
}
|
|
]
|
|
}</pre>
|
|
<ul id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_ul1312813513161"><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li1712815113167">Model output</li></ul>
|
|
<pre class="screen" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_screen18314315173">{
|
|
"resp_data": [
|
|
{
|
|
"predict_result": "Iris-setosa"
|
|
},
|
|
{
|
|
"predict_result": "Iris-versicolor"
|
|
}
|
|
]
|
|
}</pre>
|
|
<ul id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_ul16401142164719"><li id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_li9406425471">Configuration file</li></ul>
|
|
<pre class="screen" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_screen144119455171">{
|
|
"model_type": "XGBoost",
|
|
"model_algorithm": "xgboost_iris_test",
|
|
"runtime": "python2.7",
|
|
"metrics": {
|
|
"f1": 0.345294,
|
|
"accuracy": 0.462963,
|
|
"precision": 0.338977,
|
|
"recall": 0.351852
|
|
},
|
|
"apis": [
|
|
{
|
|
|
|
"url": "/",
|
|
"method": "post",
|
|
"request": {
|
|
"Content-type": "application/json",
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"req_data": {
|
|
"items": [
|
|
{
|
|
"type": "object",
|
|
"properties": {}
|
|
}
|
|
],
|
|
"type": "array"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"response": {
|
|
"Content-type": "applicaton/json",
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resp_data": {
|
|
"type": "array",
|
|
"items": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"predict_result": {}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}</pre>
|
|
<p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p169101712219"></p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_section119911955122011"><a name="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_section119911955122011"></a><a name="en-us_topic_0172466149_section119911955122011"></a><h4 class="sectiontitle">Example of a Model Configuration File Using a Custom Dependency Package</h4><p id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_p12201155652111">The following example defines the NumPy 1.16.4 dependency environment.</p>
|
|
<div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001943974157__en-us_topic_0172466149_screen463994352113"><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>
|
|
<span class="normal">14</span>
|
|
<span class="normal">15</span>
|
|
<span class="normal">16</span>
|
|
<span class="normal">17</span>
|
|
<span class="normal">18</span>
|
|
<span class="normal">19</span>
|
|
<span class="normal">20</span>
|
|
<span class="normal">21</span>
|
|
<span class="normal">22</span>
|
|
<span class="normal">23</span>
|
|
<span class="normal">24</span>
|
|
<span class="normal">25</span>
|
|
<span class="normal">26</span>
|
|
<span class="normal">27</span>
|
|
<span class="normal">28</span>
|
|
<span class="normal">29</span>
|
|
<span class="normal">30</span>
|
|
<span class="normal">31</span>
|
|
<span class="normal">32</span>
|
|
<span class="normal">33</span>
|
|
<span class="normal">34</span>
|
|
<span class="normal">35</span>
|
|
<span class="normal">36</span>
|
|
<span class="normal">37</span>
|
|
<span class="normal">38</span>
|
|
<span class="normal">39</span>
|
|
<span class="normal">40</span>
|
|
<span class="normal">41</span>
|
|
<span class="normal">42</span>
|
|
<span class="normal">43</span>
|
|
<span class="normal">44</span>
|
|
<span class="normal">45</span>
|
|
<span class="normal">46</span>
|
|
<span class="normal">47</span>
|
|
<span class="normal">48</span>
|
|
<span class="normal">49</span>
|
|
<span class="normal">50</span>
|
|
<span class="normal">51</span>
|
|
<span class="normal">52</span>
|
|
<span class="normal">53</span>
|
|
<span class="normal">54</span>
|
|
<span class="normal">55</span>
|
|
<span class="normal">56</span>
|
|
<span class="normal">57</span></pre></div></td><td class="code"><div><pre><span></span>{
|
|
<span class="w"> </span>"model_algorithm":<span class="w"> </span>"image_classification",
|
|
<span class="w"> </span>"model_type":<span class="w"> </span>"TensorFlow",
|
|
<span class="w"> </span>"runtime":<span class="w"> </span>"python3.6",
|
|
<span class="w"> </span>"apis":<span class="w"> </span>[
|
|
<span class="w"> </span>{
|
|
<span class="w"> </span>"procotol":<span class="w"> </span>"http",
|
|
<span class="w"> </span>"url":<span class="w"> </span>"/",
|
|
<span class="w"> </span>"method":<span class="w"> </span>"post",
|
|
<span class="w"> </span>"request":<span class="w"> </span>{
|
|
<span class="w"> </span>"Content-type":<span class="w"> </span>"multipart/form-data",
|
|
<span class="w"> </span>"data":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{
|
|
<span class="w"> </span>"images":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"file"
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>"response":<span class="w"> </span>{
|
|
<span class="w"> </span>"Content-type":<span class="w"> </span>"applicaton/json",
|
|
<span class="w"> </span>"data":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"object",
|
|
<span class="w"> </span>"properties":<span class="w"> </span>{
|
|
<span class="w"> </span>"mnist_result":<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"array",
|
|
<span class="w"> </span>"item":<span class="w"> </span>[
|
|
<span class="w"> </span>{
|
|
<span class="w"> </span>"type":<span class="w"> </span>"string"
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>]
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>],
|
|
<span class="w"> </span>"metrics":<span class="w"> </span>{
|
|
<span class="w"> </span>"f1":<span class="w"> </span>0.124555,
|
|
<span class="w"> </span>"recall":<span class="w"> </span>0.171875,
|
|
<span class="w"> </span>"precision":<span class="w"> </span>0.00234938928519385,
|
|
<span class="w"> </span>"accuracy":<span class="w"> </span>0.00746268656716417
|
|
<span class="w"> </span>},
|
|
<span class="w"> </span>"dependencies":<span class="w"> </span>[
|
|
<span class="w"> </span>{
|
|
<span class="w"> </span>"installer":<span class="w"> </span>"pip",
|
|
<span class="w"> </span>"packages":<span class="w"> </span>[
|
|
<span class="w"> </span>{
|
|
<span class="w"> </span>"restraint":<span class="w"> </span>"EXACT",
|
|
<span class="w"> </span>"package_version":<span class="w"> </span>"1.16.4",
|
|
<span class="w"> </span>"package_name":<span class="w"> </span>"numpy"
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>]
|
|
<span class="w"> </span>}
|
|
<span class="w"> </span>]
|
|
}
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="inference-modelarts-0054.html">Model Package Specifications</a></div>
|
|
</div>
|
|
</div>
|
|
|