| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <link rel="canonical" href="https://ignite.apache.org/releases/2.4.0/javadoc/org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" /> |
| <META NAME="ROBOTS" CONTENT="NOINDEX"> |
| |
| <!-- Generated by javadoc (1.8.0_77) on Mon Mar 05 10:43:20 UTC 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>BaseLocalProcessorJob (Ignite 2.4.0)</title> |
| <meta name="date" content="2018-03-05"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-61232409-1', 'auto'); |
| ga('send', 'pageview'); |
| |
| </script></head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="BaseLocalProcessorJob (Ignite 2.4.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/BaseLocalProcessorJob.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 class="aboutLanguage">Ignite - In-Memory Data Fabric</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/apache/ignite/ml/trainers/group/ConstModel.html" title="class in org.apache.ignite.ml.trainers.group"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" target="_top">Frames</a></li> |
| <li><a href="BaseLocalProcessorJob.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.trainers.group</div> |
| <h2 title="Class BaseLocalProcessorJob" class="title">Class BaseLocalProcessorJob<K,V,T,R extends <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://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.trainers.group.BaseLocalProcessorJob<K,V,T,R></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>K</code> - Type of keys of cache used for group trainer.</dd> |
| <dd><code>V</code> - Type of values of cache used for group trainer.</dd> |
| <dd><code>T</code> - Type of elements to which workers are applier.</dd> |
| <dd><code>R</code> - Type of result of worker.</dd> |
| </dl> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../../org/apache/ignite/compute/ComputeJob.html" title="interface in org.apache.ignite.compute">ComputeJob</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/apache/ignite/ml/trainers/group/LocalEntriesProcessorJob.html" title="class in org.apache.ignite.ml.trainers.group">LocalEntriesProcessorJob</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/group/LocalKeysProcessorJob.html" title="class in org.apache.ignite.ml.trainers.group">LocalKeysProcessorJob</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">BaseLocalProcessorJob<K,V,T,R extends <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>></span> |
| extends <a href="http://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/compute/ComputeJob.html" title="interface in org.apache.ignite.compute">ComputeJob</a></pre> |
| <div class="block">Base job for group training. |
| It's purpose is to apply worker to each element (cache key or cache entry) of given cache specified |
| by keySupplier. Worker produces <a href="../../../../../../org/apache/ignite/ml/trainers/group/ResultAndUpdates.html" title="class in org.apache.ignite.ml.trainers.group"><code>ResultAndUpdates</code></a> object which contains 'side effects' which are updates |
| needed to apply to caches and computation result. |
| After we get all <a href="../../../../../../org/apache/ignite/ml/trainers/group/ResultAndUpdates.html" title="class in org.apache.ignite.ml.trainers.group"><code>ResultAndUpdates</code></a> we merge all 'update' parts of them for each node |
| and apply them on corresponding node, also we reduce all 'result' by some given reducer.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../serialized-form.html#org.apache.ignite.ml.trainers.group.BaseLocalProcessorJob">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html#cacheName">cacheName</a></span></code> |
| <div class="block">Name of cache used for training.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../org/apache/ignite/ml/math/functions/IgniteSupplier.html" title="interface in org.apache.ignite.ml.math.functions">IgniteSupplier</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true" title="class or interface in java.util.stream">Stream</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/GroupTrainerCacheKey.html" title="class in org.apache.ignite.ml.trainers.group">GroupTrainerCacheKey</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">K</a>>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html#keySupplier">keySupplier</a></span></code> |
| <div class="block">Supplier of keys determining elements to which worker should be applied.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../org/apache/ignite/ml/math/functions/IgniteFunction.html" title="interface in org.apache.ignite.ml.math.functions">IgniteFunction</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">R</a>>,<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">R</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html#reducer">reducer</a></span></code> |
| <div class="block">Operator used to reduce results from worker.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html#trainingUUID">trainingUUID</a></span></code> |
| <div class="block">UUID of group training.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../org/apache/ignite/ml/math/functions/IgniteFunction.html" title="interface in org.apache.ignite.ml.math.functions">IgniteFunction</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">T</a>,<a href="../../../../../../org/apache/ignite/ml/trainers/group/ResultAndUpdates.html" title="class in org.apache.ignite.ml.trainers.group">ResultAndUpdates</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">R</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html#worker">worker</a></span></code> |
| <div class="block">Worker.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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/trainers/group/BaseLocalProcessorJob.html#BaseLocalProcessorJob-org.apache.ignite.ml.math.functions.IgniteFunction-org.apache.ignite.ml.math.functions.IgniteSupplier-org.apache.ignite.ml.math.functions.IgniteFunction-java.util.UUID-java.lang.String-">BaseLocalProcessorJob</a></span>(<a href="../../../../../../org/apache/ignite/ml/math/functions/IgniteFunction.html" title="interface in org.apache.ignite.ml.math.functions">IgniteFunction</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">T</a>,<a href="../../../../../../org/apache/ignite/ml/trainers/group/ResultAndUpdates.html" title="class in org.apache.ignite.ml.trainers.group">ResultAndUpdates</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">R</a>>> worker, |
| <a href="../../../../../../org/apache/ignite/ml/math/functions/IgniteSupplier.html" title="interface in org.apache.ignite.ml.math.functions">IgniteSupplier</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true" title="class or interface in java.util.stream">Stream</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/GroupTrainerCacheKey.html" title="class in org.apache.ignite.ml.trainers.group">GroupTrainerCacheKey</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">K</a>>>> keySupplier, |
| <a href="../../../../../../org/apache/ignite/ml/math/functions/IgniteFunction.html" title="interface in org.apache.ignite.ml.math.functions">IgniteFunction</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">R</a>>,<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">R</a>> reducer, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a> trainingUUID, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> cacheName)</code> |
| <div class="block">Construct instance of this class with given arguments.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>protected <a href="../../../../../../org/apache/ignite/cache/affinity/Affinity.html" title="interface in org.apache.ignite.cache.affinity">Affinity</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/GroupTrainerCacheKey.html" title="class in org.apache.ignite.ml.trainers.group">GroupTrainerCacheKey</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html#affinity--">affinity</a></span>()</code> |
| <div class="block">Get affinity function for cache used in group training.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../org/apache/ignite/IgniteCache.html" title="interface in org.apache.ignite">IgniteCache</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/GroupTrainerCacheKey.html" title="class in org.apache.ignite.ml.trainers.group">GroupTrainerCacheKey</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">K</a>>,<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html#cache--">cache</a></span>()</code> |
| <div class="block">Get cache used for training.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html#cancel--">cancel</a></span>()</code> |
| <div class="block">This method is called when system detects that completion of this |
| job can no longer alter the overall outcome (for example, when parent task |
| has already reduced the results).</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">R</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html#execute--">execute</a></span>()</code> |
| <div class="block">Executes this job.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected static <a href="../../../../../../org/apache/ignite/Ignite.html" title="interface in org.apache.ignite">Ignite</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html#ignite--">ignite</a></span>()</code> |
| <div class="block">Ignite instance.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected abstract <a href="http://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true" title="class or interface in java.util.stream">Stream</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html#toProcess--">toProcess</a></span>()</code> |
| <div class="block">Get stream of elements to process.</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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="trainingUUID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>trainingUUID</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a> trainingUUID</pre> |
| <div class="block">UUID of group training.</div> |
| </li> |
| </ul> |
| <a name="worker"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>worker</h4> |
| <pre>protected <a href="../../../../../../org/apache/ignite/ml/math/functions/IgniteFunction.html" title="interface in org.apache.ignite.ml.math.functions">IgniteFunction</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">T</a>,<a href="../../../../../../org/apache/ignite/ml/trainers/group/ResultAndUpdates.html" title="class in org.apache.ignite.ml.trainers.group">ResultAndUpdates</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">R</a> extends <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>>> worker</pre> |
| <div class="block">Worker.</div> |
| </li> |
| </ul> |
| <a name="keySupplier"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>keySupplier</h4> |
| <pre>protected <a href="../../../../../../org/apache/ignite/ml/math/functions/IgniteSupplier.html" title="interface in org.apache.ignite.ml.math.functions">IgniteSupplier</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true" title="class or interface in java.util.stream">Stream</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/GroupTrainerCacheKey.html" title="class in org.apache.ignite.ml.trainers.group">GroupTrainerCacheKey</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">K</a>>>> keySupplier</pre> |
| <div class="block">Supplier of keys determining elements to which worker should be applied.</div> |
| </li> |
| </ul> |
| <a name="reducer"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reducer</h4> |
| <pre>protected <a href="../../../../../../org/apache/ignite/ml/math/functions/IgniteFunction.html" title="interface in org.apache.ignite.ml.math.functions">IgniteFunction</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">R</a> extends <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>>,<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">R</a> extends <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>> reducer</pre> |
| <div class="block">Operator used to reduce results from worker.</div> |
| </li> |
| </ul> |
| <a name="cacheName"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>cacheName</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> cacheName</pre> |
| <div class="block">Name of cache used for training.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="BaseLocalProcessorJob-org.apache.ignite.ml.math.functions.IgniteFunction-org.apache.ignite.ml.math.functions.IgniteSupplier-org.apache.ignite.ml.math.functions.IgniteFunction-java.util.UUID-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BaseLocalProcessorJob</h4> |
| <pre>public BaseLocalProcessorJob(<a href="../../../../../../org/apache/ignite/ml/math/functions/IgniteFunction.html" title="interface in org.apache.ignite.ml.math.functions">IgniteFunction</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">T</a>,<a href="../../../../../../org/apache/ignite/ml/trainers/group/ResultAndUpdates.html" title="class in org.apache.ignite.ml.trainers.group">ResultAndUpdates</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">R</a>>> worker, |
| <a href="../../../../../../org/apache/ignite/ml/math/functions/IgniteSupplier.html" title="interface in org.apache.ignite.ml.math.functions">IgniteSupplier</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true" title="class or interface in java.util.stream">Stream</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/GroupTrainerCacheKey.html" title="class in org.apache.ignite.ml.trainers.group">GroupTrainerCacheKey</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">K</a>>>> keySupplier, |
| <a href="../../../../../../org/apache/ignite/ml/math/functions/IgniteFunction.html" title="interface in org.apache.ignite.ml.math.functions">IgniteFunction</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">R</a>>,<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">R</a>> reducer, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a> trainingUUID, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> cacheName)</pre> |
| <div class="block">Construct instance of this class with given arguments.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>worker</code> - Worker.</dd> |
| <dd><code>keySupplier</code> - Supplier of keys.</dd> |
| <dd><code>reducer</code> - Reducer.</dd> |
| <dd><code>trainingUUID</code> - UUID of training.</dd> |
| <dd><code>cacheName</code> - Name of cache used for training.</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="cancel--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cancel</h4> |
| <pre>public void cancel()</pre> |
| <div class="block">This method is called when system detects that completion of this |
| job can no longer alter the overall outcome (for example, when parent task |
| has already reduced the results). Job is also cancelled when |
| <a href="../../../../../../org/apache/ignite/lang/IgniteFuture.html#cancel--"><code>IgniteFuture.cancel()</code></a> is called. |
| <p> |
| Note that job cancellation is only a hint, and just like with |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#interrupt--" title="class or interface in java.lang"><code>Thread.interrupt()</code></a> method, it is really up to the actual job |
| instance to gracefully finish execution and exit.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/ignite/compute/ComputeJob.html#cancel--">cancel</a></code> in interface <code><a href="../../../../../../org/apache/ignite/compute/ComputeJob.html" title="interface in org.apache.ignite.compute">ComputeJob</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public <a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">R</a> execute() |
| throws <a href="../../../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre> |
| <div class="block">Executes this job.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/ignite/compute/ComputeJob.html#execute--">execute</a></code> in interface <code><a href="../../../../../../org/apache/ignite/compute/ComputeJob.html" title="interface in org.apache.ignite.compute">ComputeJob</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Job execution result (possibly <code>null</code>). This result will be returned |
| in <a href="../../../../../../org/apache/ignite/compute/ComputeJobResult.html#getData--"><code>ComputeJobResult.getData()</code></a> method passed into |
| <a href="../../../../../../org/apache/ignite/compute/ComputeTask.html#result-org.apache.ignite.compute.ComputeJobResult-java.util.List-"><code>ComputeTask.result(ComputeJobResult, List)</code></a> task method on caller node.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If job execution caused an exception. This exception will be |
| returned in <a href="../../../../../../org/apache/ignite/compute/ComputeJobResult.html#getException--"><code>ComputeJobResult.getException()</code></a> method passed into |
| <a href="../../../../../../org/apache/ignite/compute/ComputeTask.html#result-org.apache.ignite.compute.ComputeJobResult-java.util.List-"><code>ComputeTask.result(ComputeJobResult, List)</code></a> task method on caller node. |
| If execution produces a <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang"><code>RuntimeException</code></a> or <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Error.html?is-external=true" title="class or interface in java.lang"><code>Error</code></a>, then |
| it will be wrapped into <a href="../../../../../../org/apache/ignite/IgniteCheckedException.html" title="class in org.apache.ignite"><code>IgniteCheckedException</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toProcess--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toProcess</h4> |
| <pre>protected abstract <a href="http://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true" title="class or interface in java.util.stream">Stream</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">T</a>> toProcess()</pre> |
| <div class="block">Get stream of elements to process.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Stream of elements to process.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ignite--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ignite</h4> |
| <pre>protected static <a href="../../../../../../org/apache/ignite/Ignite.html" title="interface in org.apache.ignite">Ignite</a> ignite()</pre> |
| <div class="block">Ignite instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Ignite instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cache</h4> |
| <pre>protected <a href="../../../../../../org/apache/ignite/IgniteCache.html" title="interface in org.apache.ignite">IgniteCache</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/GroupTrainerCacheKey.html" title="class in org.apache.ignite.ml.trainers.group">GroupTrainerCacheKey</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">K</a>>,<a href="../../../../../../org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" title="type parameter in BaseLocalProcessorJob">V</a>> cache()</pre> |
| <div class="block">Get cache used for training.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Cache used for training.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="affinity--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>affinity</h4> |
| <pre>protected <a href="../../../../../../org/apache/ignite/cache/affinity/Affinity.html" title="interface in org.apache.ignite.cache.affinity">Affinity</a><<a href="../../../../../../org/apache/ignite/ml/trainers/group/GroupTrainerCacheKey.html" title="class in org.apache.ignite.ml.trainers.group">GroupTrainerCacheKey</a>> affinity()</pre> |
| <div class="block">Get affinity function for cache used in group training.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Affinity function for cache used in group training.</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/BaseLocalProcessorJob.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 class="aboutLanguage">Ignite - In-Memory Data Fabric</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/apache/ignite/ml/trainers/group/ConstModel.html" title="class in org.apache.ignite.ml.trainers.group"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/ignite/ml/trainers/group/BaseLocalProcessorJob.html" target="_top">Frames</a></li> |
| <li><a href="BaseLocalProcessorJob.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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>2018 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 Fabric</b> </td> <td>: ver. <strong>2.4.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>: March 5 2018 </td> </tr> </tbody> </table> </td> </tr> </table></small></p> |
| </body> |
| </html> |
