| <!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>LearningEnvironment (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="LearningEnvironment (Ignite 2.12.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":18,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/LearningEnvironment.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/environment/DefaultLearningEnvironmentBuilder.html" title="class in org.apache.ignite.ml.environment"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironmentBuilder.html" title="interface in org.apache.ignite.ml.environment"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/ignite/ml/environment/LearningEnvironment.html" target="_top">Frames</a></li> |
| <li><a href="LearningEnvironment.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>Constr | </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>Constr | </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.environment</div> |
| <h2 title="Interface LearningEnvironment" class="title">Interface LearningEnvironment</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">LearningEnvironment</span></pre> |
| <div class="block">Specifies a set of utility-objects helpful at runtime but optional for learning algorithm |
| (like thread pool for parallel learning in bagging model or logger).</div> |
| </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>static <a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironment.html" title="interface in org.apache.ignite.ml.environment">LearningEnvironment</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironment.html#DEFAULT_TRAINER_ENV">DEFAULT_TRAINER_ENV</a></span></code> |
| <div class="block">Default environment</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironment.html#dataTtl--">dataTtl</a></span>()</code> |
| <div class="block">Returns partition data time-to-live in seconds (-1 for an infinite lifetime).</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/ml/environment/deploy/DeployingContext.html" title="interface in org.apache.ignite.ml.environment.deploy">DeployingContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironment.html#deployingContext--">deployingContext</a></span>()</code> |
| <div class="block">Returns deploy context instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironment.html#initDeployingContext-java.lang.Object-">initDeployingContext</a></span>(<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> clientSideObj)</code> |
| <div class="block">Initializes deploying context by object representing current client computation |
| with classes unknown for server side.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/ml/environment/logging/MLLogger.html" title="interface in org.apache.ignite.ml.environment.logging">MLLogger</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironment.html#logger--">logger</a></span>()</code> |
| <div class="block">Returns an instance of logger.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><span class='angle_bracket'><</span>T<span class='angle_bracket'>></span> <a href="../../../../../org/apache/ignite/ml/environment/logging/MLLogger.html" title="interface in org.apache.ignite.ml.environment.logging">MLLogger</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironment.html#logger-java.lang.Class-">logger</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><span class='angle_bracket'><</span>T<span class='angle_bracket'>></span> forCls)</code> |
| <div class="block">Returns an instance of logger for specific class.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/ml/environment/parallelism/ParallelismStrategy.html" title="interface in org.apache.ignite.ml.environment.parallelism">ParallelismStrategy</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironment.html#parallelismStrategy--">parallelismStrategy</a></span>()</code> |
| <div class="block">Returns Parallelism Strategy instance.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironment.html#partition--">partition</a></span>()</code> |
| <div class="block">Gets current partition.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Random.html?is-external=true" title="class or interface in java.util">Random</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironment.html#randomNumbersGenerator--">randomNumbersGenerator</a></span>()</code> |
| <div class="block">Random numbers generator.</div> |
| </td> |
| </tr> |
| </table> |
| </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="DEFAULT_TRAINER_ENV"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_TRAINER_ENV</h4> |
| <pre>static final <a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironment.html" title="interface in org.apache.ignite.ml.environment">LearningEnvironment</a> DEFAULT_TRAINER_ENV</pre> |
| <div class="block">Default environment</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="parallelismStrategy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parallelismStrategy</h4> |
| <pre><a href="../../../../../org/apache/ignite/ml/environment/parallelism/ParallelismStrategy.html" title="interface in org.apache.ignite.ml.environment.parallelism">ParallelismStrategy</a> parallelismStrategy()</pre> |
| <div class="block">Returns Parallelism Strategy instance.</div> |
| </li> |
| </ul> |
| <a name="logger--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logger</h4> |
| <pre><a href="../../../../../org/apache/ignite/ml/environment/logging/MLLogger.html" title="interface in org.apache.ignite.ml.environment.logging">MLLogger</a> logger()</pre> |
| <div class="block">Returns an instance of logger.</div> |
| </li> |
| </ul> |
| <a name="randomNumbersGenerator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>randomNumbersGenerator</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Random.html?is-external=true" title="class or interface in java.util">Random</a> randomNumbersGenerator()</pre> |
| <div class="block">Random numbers generator.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Random numbers generator.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="logger-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logger</h4> |
| <pre><span class='angle_bracket'><</span>T<span class='angle_bracket'>></span> <a href="../../../../../org/apache/ignite/ml/environment/logging/MLLogger.html" title="interface in org.apache.ignite.ml.environment.logging">MLLogger</a> logger(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><span class='angle_bracket'><</span>T<span class='angle_bracket'>></span> forCls)</pre> |
| <div class="block">Returns an instance of logger for specific class.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>forCls</code> - Logging class context.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="partition--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>partition</h4> |
| <pre>int partition()</pre> |
| <div class="block">Gets current partition. If this is called not in one of compute tasks of <a href="../../../../../org/apache/ignite/ml/dataset/Dataset.html" title="interface in org.apache.ignite.ml.dataset"><code>Dataset</code></a>, will return -1.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Partition.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dataTtl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dataTtl</h4> |
| <pre>long dataTtl()</pre> |
| <div class="block">Returns partition data time-to-live in seconds (-1 for an infinite lifetime).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Partition data time-to-live in seconds (-1 for an infinite lifetime).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deployingContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deployingContext</h4> |
| <pre><a href="../../../../../org/apache/ignite/ml/environment/deploy/DeployingContext.html" title="interface in org.apache.ignite.ml.environment.deploy">DeployingContext</a> deployingContext()</pre> |
| <div class="block">Returns deploy context instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Deploy context.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initDeployingContext-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>initDeployingContext</h4> |
| <pre>default void initDeployingContext(<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> clientSideObj)</pre> |
| <div class="block">Initializes deploying context by object representing current client computation |
| with classes unknown for server side.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clientSideObj</code> - Client side object.</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/LearningEnvironment.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/environment/DefaultLearningEnvironmentBuilder.html" title="class in org.apache.ignite.ml.environment"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironmentBuilder.html" title="interface in org.apache.ignite.ml.environment"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/ignite/ml/environment/LearningEnvironment.html" target="_top">Frames</a></li> |
| <li><a href="LearningEnvironment.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>Constr | </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>Constr | </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> |
