| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_291) on Mon Jan 10 11:05:28 MSK 2022 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>IgniteDistributedModelBuilder (Ignite 2.12.0)</title> |
| <meta name="date" content="2022-01-10"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <link rel='shortcut icon' href='https://ignite.apache.org/favicon.ico'/> |
| </head> |
| |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="IgniteDistributedModelBuilder (Ignite 2.12.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/IgniteDistributedModelBuilder.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/ignite/ml/inference/builder/AsyncModelBuilder.html" title="interface in org.apache.ignite.ml.inference.builder"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/ignite/ml/inference/builder/SingleModelBuilder.html" title="class in org.apache.ignite.ml.inference.builder"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/ignite/ml/inference/builder/IgniteDistributedModelBuilder.html" target="_top">Frames</a></li> |
| <li><a href="IgniteDistributedModelBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.ignite.ml.inference.builder</div> |
| <h2 title="Class IgniteDistributedModelBuilder" class="title">Class IgniteDistributedModelBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.ignite.ml.inference.builder.IgniteDistributedModelBuilder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/ignite/ml/inference/builder/AsyncModelBuilder.html" title="interface in org.apache.ignite.ml.inference.builder">AsyncModelBuilder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">IgniteDistributedModelBuilder</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../../org/apache/ignite/ml/inference/builder/AsyncModelBuilder.html" title="interface in org.apache.ignite.ml.inference.builder">AsyncModelBuilder</a></pre> |
| <div class="block">Builder that allows to start Apache Ignite services for distributed inference and get a facade that allows to work |
| with this distributed inference infrastructure as with a single inference model (see <a href="../../../../../../org/apache/ignite/ml/inference/Model.html" title="interface in org.apache.ignite.ml.inference"><code>Model</code></a>). |
| |
| The common workflow is based on a request/response queues and multiple workers represented by Apache Ignite services. |
| When the <a href="../../../../../../org/apache/ignite/ml/inference/builder/IgniteDistributedModelBuilder.html#build-org.apache.ignite.ml.inference.reader.ModelReader-org.apache.ignite.ml.inference.parser.ModelParser-"><code>build(ModelReader, ModelParser)</code></a> method is called Apache Ignite starts the specified number of |
| service instances and request/response queues. Each service instance reads request queue, processes inbound requests |
| and writes responses to response queue. The facade returned by the <a href="../../../../../../org/apache/ignite/ml/inference/builder/IgniteDistributedModelBuilder.html#build-org.apache.ignite.ml.inference.reader.ModelReader-org.apache.ignite.ml.inference.parser.ModelParser-"><code>build(ModelReader, ModelParser)</code></a> |
| method operates with request/response queues. When the <a href="../../../../../../org/apache/ignite/ml/inference/Model.html#predict-I-"><code>Model.predict(Object)</code></a> method is called the argument |
| is sent as a request to the request queue. When the response is appeared in the response queue the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent"><code>Future</code></a> |
| correspondent to the previously sent request is completed and the processing finishes. |
| |
| Be aware that <a href="../../../../../../org/apache/ignite/ml/inference/Model.html#close--"><code>Model.close()</code></a> method must be called to clear allocated resources, stop services and remove |
| queues.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/inference/builder/IgniteDistributedModelBuilder.html#IgniteDistributedModelBuilder-org.apache.ignite.Ignite-int-int-">IgniteDistributedModelBuilder</a></span>(<a href="../../../../../../org/apache/ignite/Ignite.html" title="interface in org.apache.ignite">Ignite</a> ignite, |
| int instances, |
| int maxPerNode)</code> |
| <div class="block">Constructs a new instance of Ignite distributed inference model builder.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><span class='angle_bracket'><</span>I extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>,O extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a><span class='angle_bracket'>></span><br><a href="../../../../../../org/apache/ignite/ml/inference/Model.html" title="interface in org.apache.ignite.ml.inference">Model</a><span class='angle_bracket'><</span>I,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><span class='angle_bracket'><</span>O<span class='angle_bracket'>></span><span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/inference/builder/IgniteDistributedModelBuilder.html#build-org.apache.ignite.ml.inference.reader.ModelReader-org.apache.ignite.ml.inference.parser.ModelParser-">build</a></span>(<a href="../../../../../../org/apache/ignite/ml/inference/reader/ModelReader.html" title="interface in org.apache.ignite.ml.inference.reader">ModelReader</a> reader, |
| <a href="../../../../../../org/apache/ignite/ml/inference/parser/ModelParser.html" title="interface in org.apache.ignite.ml.inference.parser">ModelParser</a><span class='angle_bracket'><</span>I,O,?<span class='angle_bracket'>></span> parser)</code> |
| <div class="block">Starts the specified in constructor number of service instances and request/response queues.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="IgniteDistributedModelBuilder-org.apache.ignite.Ignite-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>IgniteDistributedModelBuilder</h4> |
| <pre>public IgniteDistributedModelBuilder(<a href="../../../../../../org/apache/ignite/Ignite.html" title="interface in org.apache.ignite">Ignite</a> ignite, |
| int instances, |
| int maxPerNode)</pre> |
| <div class="block">Constructs a new instance of Ignite distributed inference model builder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ignite</code> - Ignite instance.</dd> |
| <dd><code>instances</code> - Number of service instances maintaining to make distributed inference.</dd> |
| <dd><code>maxPerNode</code> - Max per node number of instances.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="build-org.apache.ignite.ml.inference.reader.ModelReader-org.apache.ignite.ml.inference.parser.ModelParser-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <span class='angle_bracket'><</span>I extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>,O extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a><span class='angle_bracket'>></span> <a href="../../../../../../org/apache/ignite/ml/inference/Model.html" title="interface in org.apache.ignite.ml.inference">Model</a><span class='angle_bracket'><</span>I,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><span class='angle_bracket'><</span>O<span class='angle_bracket'>></span><span class='angle_bracket'>></span> build(<a href="../../../../../../org/apache/ignite/ml/inference/reader/ModelReader.html" title="interface in org.apache.ignite.ml.inference.reader">ModelReader</a> reader, |
| <a href="../../../../../../org/apache/ignite/ml/inference/parser/ModelParser.html" title="interface in org.apache.ignite.ml.inference.parser">ModelParser</a><span class='angle_bracket'><</span>I,O,?<span class='angle_bracket'>></span> parser)</pre> |
| <div class="block">Starts the specified in constructor number of service instances and request/response queues. Each service |
| instance reads request queue, processes inbound requests and writes responses to response queue. The returned |
| facade is represented by the <a href="../../../../../../org/apache/ignite/ml/inference/Model.html" title="interface in org.apache.ignite.ml.inference"><code>Model</code></a> operates with request/response queues, but hides these details |
| behind <a href="../../../../../../org/apache/ignite/ml/inference/Model.html#predict-I-"><code>Model.predict(Object)</code></a> method of <a href="../../../../../../org/apache/ignite/ml/inference/Model.html" title="interface in org.apache.ignite.ml.inference"><code>Model</code></a>. |
| |
| Be aware that <a href="../../../../../../org/apache/ignite/ml/inference/Model.html#close--"><code>Model.close()</code></a> method must be called to clear allocated resources, stop services and |
| remove queues.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/ignite/ml/inference/builder/AsyncModelBuilder.html#build-org.apache.ignite.ml.inference.reader.ModelReader-org.apache.ignite.ml.inference.parser.ModelParser-">build</a></code> in interface <code><a href="../../../../../../org/apache/ignite/ml/inference/builder/AsyncModelBuilder.html" title="interface in org.apache.ignite.ml.inference.builder">AsyncModelBuilder</a></code></dd> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>I</code> - Type of model input.</dd> |
| <dd><code>O</code> - Type of model output.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reader</code> - Inference model reader.</dd> |
| <dd><code>parser</code> - Inference model parser.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Facade represented by <a href="../../../../../../org/apache/ignite/ml/inference/Model.html" title="interface in org.apache.ignite.ml.inference"><code>Model</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/IgniteDistributedModelBuilder.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/ignite/ml/inference/builder/AsyncModelBuilder.html" title="interface in org.apache.ignite.ml.inference.builder"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/ignite/ml/inference/builder/SingleModelBuilder.html" title="class in org.apache.ignite.ml.inference.builder"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/ignite/ml/inference/builder/IgniteDistributedModelBuilder.html" target="_top">Frames</a></li> |
| <li><a href="IgniteDistributedModelBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2022 Copyright © Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Database and Caching Platform</b> </td> <td>: ver. <strong>2.12.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>: January 10 2022 </td> </tr> </tbody> </table> </td> </tr> </table></small></p> |
| </body> |
| </html> |
