|
|
<!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 (version 1.7.0_51) on Wed Sep 16 10:26:35 PDT 2015 -->
<title>MulticlassMetrics</title>
<meta name="date" content="2015-09-16">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MulticlassMetrics";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="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/spark/mllib/evaluation/BinaryClassificationMetrics.html" title="class in org.apache.spark.mllib.evaluation"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/mllib/evaluation/MultilabelMetrics.html" title="class in org.apache.spark.mllib.evaluation"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/mllib/evaluation/MulticlassMetrics.html" target="_top">Frames</a></li>
<li><a href="MulticlassMetrics.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.spark.mllib.evaluation</div>
<h2 title="Class MulticlassMetrics" class="title">Class MulticlassMetrics</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.mllib.evaluation.MulticlassMetrics</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">MulticlassMetrics</span>
extends java.lang.Object</pre>
<div class="block">::Experimental::
Evaluator for multiclass classification.
<p>
param: predictionAndLabels an RDD of (prediction, label) pairs.</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="overviewSummary" 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><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#MulticlassMetrics(org.apache.spark.rdd.RDD)">MulticlassMetrics</a></strong>(<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a><scala.Tuple2<java.lang.Object,java.lang.Object>> predictionAndLabels)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/linalg/Matrix.html" title="interface in org.apache.spark.mllib.linalg">Matrix</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#confusionMatrix()">confusionMatrix</a></strong>()</code>
<div class="block">Returns confusion matrix:
predicted classes are in columns,
they are ordered by class label ascending,
as in "labels"</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#falsePositiveRate(double)">falsePositiveRate</a></strong>(double label)</code>
<div class="block">Returns false positive rate for a given label (category)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#fMeasure()">fMeasure</a></strong>()</code>
<div class="block">Returns f-measure
(equals to precision and recall because precision equals recall)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#fMeasure(double)">fMeasure</a></strong>(double label)</code>
<div class="block">Returns f1-measure for a given label (category)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#fMeasure(double, double)">fMeasure</a></strong>(double label,
double beta)</code>
<div class="block">Returns f-measure for a given label (category)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#labels()">labels</a></strong>()</code>
<div class="block">Returns the sequence of labels in ascending order</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#precision()">precision</a></strong>()</code>
<div class="block">Returns precision</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#precision(double)">precision</a></strong>(double label)</code>
<div class="block">Returns precision for a given label (category)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#recall()">recall</a></strong>()</code>
<div class="block">Returns recall
(equals to precision for multiclass classifier
because sum of all false positives is equal to sum
of all false negatives)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#recall(double)">recall</a></strong>(double label)</code>
<div class="block">Returns recall for a given label (category)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#truePositiveRate(double)">truePositiveRate</a></strong>(double label)</code>
<div class="block">Returns true positive rate for a given label (category)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#weightedFalsePositiveRate()">weightedFalsePositiveRate</a></strong>()</code>
<div class="block">Returns weighted false positive rate</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#weightedFMeasure()">weightedFMeasure</a></strong>()</code>
<div class="block">Returns weighted averaged f1-measure</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#weightedFMeasure(double)">weightedFMeasure</a></strong>(double beta)</code>
<div class="block">Returns weighted averaged f-measure</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#weightedPrecision()">weightedPrecision</a></strong>()</code>
<div class="block">Returns weighted averaged precision</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#weightedRecall()">weightedRecall</a></strong>()</code>
<div class="block">Returns weighted averaged recall
(equals to precision, recall and f-measure)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/evaluation/MulticlassMetrics.html#weightedTruePositiveRate()">weightedTruePositiveRate</a></strong>()</code>
<div class="block">Returns weighted true positive rate
(equals to precision, recall and f-measure)</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="MulticlassMetrics(org.apache.spark.rdd.RDD)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MulticlassMetrics</h4>
<pre>public MulticlassMetrics(<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a><scala.Tuple2<java.lang.Object,java.lang.Object>> predictionAndLabels)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="confusionMatrix()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>confusionMatrix</h4>
<pre>public <a href="../../../../../org/apache/spark/mllib/linalg/Matrix.html" title="interface in org.apache.spark.mllib.linalg">Matrix</a> confusionMatrix()</pre>
<div class="block">Returns confusion matrix:
predicted classes are in columns,
they are ordered by class label ascending,
as in "labels"</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="truePositiveRate(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>truePositiveRate</h4>
<pre>public double truePositiveRate(double label)</pre>
<div class="block">Returns true positive rate for a given label (category)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>label</code> - the label.</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="falsePositiveRate(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>falsePositiveRate</h4>
<pre>public double falsePositiveRate(double label)</pre>
<div class="block">Returns false positive rate for a given label (category)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>label</code> - the label.</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="precision(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>precision</h4>
<pre>public double precision(double label)</pre>
<div class="block">Returns precision for a given label (category)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>label</code> - the label.</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="recall(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recall</h4>
<pre>public double recall(double label)</pre>
<div class="block">Returns recall for a given label (category)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>label</code> - the label.</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="fMeasure(double, double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fMeasure</h4>
<pre>public double fMeasure(double label,
double beta)</pre>
<div class="block">Returns f-measure for a given label (category)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>label</code> - the label.</dd><dd><code>beta</code> - the beta parameter.</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="fMeasure(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fMeasure</h4>
<pre>public double fMeasure(double label)</pre>
<div class="block">Returns f1-measure for a given label (category)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>label</code> - the label.</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="precision()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>precision</h4>
<pre>public double precision()</pre>
<div class="block">Returns precision</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="recall()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recall</h4>
<pre>public double recall()</pre>
<div class="block">Returns recall
(equals to precision for multiclass classifier
because sum of all false positives is equal to sum
of all false negatives)</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="fMeasure()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fMeasure</h4>
<pre>public double fMeasure()</pre>
<div class="block">Returns f-measure
(equals to precision and recall because precision equals recall)</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="weightedTruePositiveRate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>weightedTruePositiveRate</h4>
<pre>public double weightedTruePositiveRate()</pre>
<div class="block">Returns weighted true positive rate
(equals to precision, recall and f-measure)</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="weightedFalsePositiveRate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>weightedFalsePositiveRate</h4>
<pre>public double weightedFalsePositiveRate()</pre>
<div class="block">Returns weighted false positive rate</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="weightedRecall()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>weightedRecall</h4>
<pre>public double weightedRecall()</pre>
<div class="block">Returns weighted averaged recall
(equals to precision, recall and f-measure)</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="weightedPrecision()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>weightedPrecision</h4>
<pre>public double weightedPrecision()</pre>
<div class="block">Returns weighted averaged precision</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="weightedFMeasure(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>weightedFMeasure</h4>
<pre>public double weightedFMeasure(double beta)</pre>
<div class="block">Returns weighted averaged f-measure</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>beta</code> - the beta parameter.</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="weightedFMeasure()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>weightedFMeasure</h4>
<pre>public double weightedFMeasure()</pre>
<div class="block">Returns weighted averaged f1-measure</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="labels()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>labels</h4>
<pre>public double[] labels()</pre>
<div class="block">Returns the sequence of labels in ascending order</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="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/spark/mllib/evaluation/BinaryClassificationMetrics.html" title="class in org.apache.spark.mllib.evaluation"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/mllib/evaluation/MultilabelMetrics.html" title="class in org.apache.spark.mllib.evaluation"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/mllib/evaluation/MulticlassMetrics.html" target="_top">Frames</a></li>
<li><a href="MulticlassMetrics.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 ======= -->
<script defer="defer" type="text/javascript" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/api-javadocs.js"></script></body>
</html>
|