blob: a9417495334cde1caaf9789fa009421e6a58a3dc [file] [log] [blame]
<!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_261) on Mon Dec 20 14:15:55 MSK 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EvaluationContext (Ignite 2.11.1)</title>
<meta name="date" content="2021-12-20">
<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="EvaluationContext (Ignite 2.11.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":17,"i2":6,"i3":18};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/EvaluationContext.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/selection/scoring/evaluator/context/EmptyContext.html" title="class in org.apache.ignite.ml.selection.scoring.evaluator.context"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/ignite/ml/selection/scoring/evaluator/context/EvaluationContext.html" target="_top">Frames</a></li>
<li><a href="EvaluationContext.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.selection.scoring.evaluator.context</div>
<h2 title="Interface EvaluationContext" class="title">Interface EvaluationContext<span class='angle_bracket'>&lt;</span>L,Self extends EvaluationContext<span class='angle_bracket'>&lt;</span>L,? super Self<span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span></h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>L</code> - Type of label.</dd>
<dd><code>Self</code> - Type of evaluation context.</dd>
</dl>
<dl>
<dt>All Superinterfaces:</dt>
<dd><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></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../../org/apache/ignite/ml/selection/scoring/evaluator/context/BinaryClassificationEvaluationContext.html" title="class in org.apache.ignite.ml.selection.scoring.evaluator.context">BinaryClassificationEvaluationContext</a>, <a href="../../../../../../../../org/apache/ignite/ml/selection/scoring/evaluator/context/EmptyContext.html" title="class in org.apache.ignite.ml.selection.scoring.evaluator.context">EmptyContext</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">EvaluationContext<span class='angle_bracket'>&lt;</span>L,Self extends EvaluationContext<span class='angle_bracket'>&lt;</span>L,? super Self<span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span></span>
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></pre>
<div class="block">Classes with this interface are responsible for preparatory computations before model evaluation. For example if we
don't know what is positive and negative label we can define it in automatically way using such evaluation context.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/ignite/ml/selection/scoring/evaluator/context/EvaluationContext.html#aggregate-org.apache.ignite.ml.structures.LabeledVector-">aggregate</a></span>(<a href="../../../../../../../../org/apache/ignite/ml/structures/LabeledVector.html" title="class in org.apache.ignite.ml.structures">LabeledVector</a><span class='angle_bracket'>&lt;</span><a href="../../../../../../../../org/apache/ignite/ml/selection/scoring/evaluator/context/EvaluationContext.html" title="type parameter in EvaluationContext">L</a><span class='angle_bracket'>&gt;</span>&nbsp;vector)</code>
<div class="block">Aggregates statistic from vector of sample.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <span class='angle_bracket'>&lt;</span>L 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'>&gt;</span><br><a href="../../../../../../../../org/apache/ignite/ml/selection/scoring/evaluator/context/EmptyContext.html" title="class in org.apache.ignite.ml.selection.scoring.evaluator.context">EmptyContext</a><span class='angle_bracket'>&lt;</span>L<span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/ignite/ml/selection/scoring/evaluator/context/EvaluationContext.html#empty--">empty</a></span>()</code>
<div class="block">Returns default empty context.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/ignite/ml/selection/scoring/evaluator/context/EvaluationContext.html" title="type parameter in EvaluationContext">Self</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/ignite/ml/selection/scoring/evaluator/context/EvaluationContext.html#mergeWith-Self-">mergeWith</a></span>(<a href="../../../../../../../../org/apache/ignite/ml/selection/scoring/evaluator/context/EvaluationContext.html" title="type parameter in EvaluationContext">Self</a>&nbsp;other)</code>
<div class="block">Merges statistics of this and other context.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>default boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/ignite/ml/selection/scoring/evaluator/context/EvaluationContext.html#needToCompute--">needToCompute</a></span>()</code>
<div class="block">Returns true if this contexts should be evaluated through map-reduce.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="aggregate-org.apache.ignite.ml.structures.LabeledVector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aggregate</h4>
<pre>void&nbsp;aggregate(<a href="../../../../../../../../org/apache/ignite/ml/structures/LabeledVector.html" title="class in org.apache.ignite.ml.structures">LabeledVector</a><span class='angle_bracket'>&lt;</span><a href="../../../../../../../../org/apache/ignite/ml/selection/scoring/evaluator/context/EvaluationContext.html" title="type parameter in EvaluationContext">L</a><span class='angle_bracket'>&gt;</span>&nbsp;vector)</pre>
<div class="block">Aggregates statistic from vector of sample.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vector</code> - Vector.</dd>
</dl>
</li>
</ul>
<a name="mergeWith-org.apache.ignite.ml.selection.scoring.evaluator.context.EvaluationContext-">
<!-- -->
</a><a name="mergeWith-Self-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mergeWith</h4>
<pre><a href="../../../../../../../../org/apache/ignite/ml/selection/scoring/evaluator/context/EvaluationContext.html" title="type parameter in EvaluationContext">Self</a>&nbsp;mergeWith(<a href="../../../../../../../../org/apache/ignite/ml/selection/scoring/evaluator/context/EvaluationContext.html" title="type parameter in EvaluationContext">Self</a>&nbsp;other)</pre>
<div class="block">Merges statistics of this and other context.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - Other context.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>New merged context.</dd>
</dl>
</li>
</ul>
<a name="needToCompute--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>needToCompute</h4>
<pre>default&nbsp;boolean&nbsp;needToCompute()</pre>
<div class="block">Returns true if this contexts should be evaluated through map-reduce.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if this contexts should be evaluated through map-reduce.</dd>
</dl>
</li>
</ul>
<a name="empty--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>empty</h4>
<pre>static&nbsp;<span class='angle_bracket'>&lt;</span>L 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'>&gt;</span>&nbsp;<a href="../../../../../../../../org/apache/ignite/ml/selection/scoring/evaluator/context/EmptyContext.html" title="class in org.apache.ignite.ml.selection.scoring.evaluator.context">EmptyContext</a><span class='angle_bracket'>&lt;</span>L<span class='angle_bracket'>&gt;</span>&nbsp;empty()</pre>
<div class="block">Returns default empty context.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Empty context.</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/EvaluationContext.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/selection/scoring/evaluator/context/EmptyContext.html" title="class in org.apache.ignite.ml.selection.scoring.evaluator.context"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/ignite/ml/selection/scoring/evaluator/context/EvaluationContext.html" target="_top">Frames</a></li>
<li><a href="EvaluationContext.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>2021 Copyright &#169; 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>:&nbsp;&nbsp; ver. <strong>2.11.1</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; December 20 2021 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>