Google Git
Sign in
apache / mahout / master / . / docs / 0.13.0 / api / docs / mahout-mr / org / apache / mahout / cf / taste / eval / RecommenderIRStatsEvaluator.html
blob: 5274566a9da7f5154f70fbcd1d51f5a9911f20fd [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_121) on Fri Apr 14 22:11:35 PDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RecommenderIRStatsEvaluator (Mahout Map-Reduce 0.13.0 API)</title>
<meta name="date" content="2017-04-14">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RecommenderIRStatsEvaluator (Mahout Map-Reduce 0.13.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/RecommenderIRStatsEvaluator.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/mahout/cf/taste/eval/RecommenderEvaluator.html" title="interface in org.apache.mahout.cf.taste.eval"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/mahout/cf/taste/eval/RelevantItemsDataSplitter.html" title="interface in org.apache.mahout.cf.taste.eval"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/mahout/cf/taste/eval/RecommenderIRStatsEvaluator.html" target="_top">Frames</a></li>
<li><a href="RecommenderIRStatsEvaluator.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.mahout.cf.taste.eval</div>
<h2 title="Interface RecommenderIRStatsEvaluator" class="title">Interface RecommenderIRStatsEvaluator</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/mahout/cf/taste/impl/eval/GenericRecommenderIRStatsEvaluator.html" title="class in org.apache.mahout.cf.taste.impl.eval">GenericRecommenderIRStatsEvaluator</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">RecommenderIRStatsEvaluator</span></pre>
<div class="block"><p>
Implementations collect information retrieval-related statistics on a
<a href="../../../../../../org/apache/mahout/cf/taste/recommender/Recommender.html" title="interface in org.apache.mahout.cf.taste.recommender"><code>Recommender</code></a>'s performance, including precision, recall and
f-measure.
</p>
<p>
See <a href="http://en.wikipedia.org/wiki/Information_retrieval">Information retrieval</a>.</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="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></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><a href="../../../../../../org/apache/mahout/cf/taste/eval/IRStatistics.html" title="interface in org.apache.mahout.cf.taste.eval">IRStatistics</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/cf/taste/eval/RecommenderIRStatsEvaluator.html#evaluate-org.apache.mahout.cf.taste.eval.RecommenderBuilder-org.apache.mahout.cf.taste.eval.DataModelBuilder-org.apache.mahout.cf.taste.model.DataModel-org.apache.mahout.cf.taste.recommender.IDRescorer-int-double-double-">evaluate</a></span>(<a href="../../../../../../org/apache/mahout/cf/taste/eval/RecommenderBuilder.html" title="interface in org.apache.mahout.cf.taste.eval">RecommenderBuilder</a>&nbsp;recommenderBuilder,
<a href="../../../../../../org/apache/mahout/cf/taste/eval/DataModelBuilder.html" title="interface in org.apache.mahout.cf.taste.eval">DataModelBuilder</a>&nbsp;dataModelBuilder,
<a href="../../../../../../org/apache/mahout/cf/taste/model/DataModel.html" title="interface in org.apache.mahout.cf.taste.model">DataModel</a>&nbsp;dataModel,
<a href="../../../../../../org/apache/mahout/cf/taste/recommender/IDRescorer.html" title="interface in org.apache.mahout.cf.taste.recommender">IDRescorer</a>&nbsp;rescorer,
int&nbsp;at,
double&nbsp;relevanceThreshold,
double&nbsp;evaluationPercentage)</code>&nbsp;</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="evaluate-org.apache.mahout.cf.taste.eval.RecommenderBuilder-org.apache.mahout.cf.taste.eval.DataModelBuilder-org.apache.mahout.cf.taste.model.DataModel-org.apache.mahout.cf.taste.recommender.IDRescorer-int-double-double-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>evaluate</h4>
<pre><a href="../../../../../../org/apache/mahout/cf/taste/eval/IRStatistics.html" title="interface in org.apache.mahout.cf.taste.eval">IRStatistics</a>&nbsp;evaluate(<a href="../../../../../../org/apache/mahout/cf/taste/eval/RecommenderBuilder.html" title="interface in org.apache.mahout.cf.taste.eval">RecommenderBuilder</a>&nbsp;recommenderBuilder,
<a href="../../../../../../org/apache/mahout/cf/taste/eval/DataModelBuilder.html" title="interface in org.apache.mahout.cf.taste.eval">DataModelBuilder</a>&nbsp;dataModelBuilder,
<a href="../../../../../../org/apache/mahout/cf/taste/model/DataModel.html" title="interface in org.apache.mahout.cf.taste.model">DataModel</a>&nbsp;dataModel,
<a href="../../../../../../org/apache/mahout/cf/taste/recommender/IDRescorer.html" title="interface in org.apache.mahout.cf.taste.recommender">IDRescorer</a>&nbsp;rescorer,
int&nbsp;at,
double&nbsp;relevanceThreshold,
double&nbsp;evaluationPercentage)
throws <a href="../../../../../../org/apache/mahout/cf/taste/common/TasteException.html" title="class in org.apache.mahout.cf.taste.common">TasteException</a></pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>recommenderBuilder</code> - object that can build a <a href="../../../../../../org/apache/mahout/cf/taste/recommender/Recommender.html" title="interface in org.apache.mahout.cf.taste.recommender"><code>Recommender</code></a> to test</dd>
<dd><code>dataModelBuilder</code> - <a href="../../../../../../org/apache/mahout/cf/taste/eval/DataModelBuilder.html" title="interface in org.apache.mahout.cf.taste.eval"><code>DataModelBuilder</code></a> to use, or if null, a default <a href="../../../../../../org/apache/mahout/cf/taste/model/DataModel.html" title="interface in org.apache.mahout.cf.taste.model"><code>DataModel</code></a> implementation will be
used</dd>
<dd><code>dataModel</code> - dataset to test on</dd>
<dd><code>rescorer</code> - if any, to use when computing recommendations</dd>
<dd><code>at</code> - as in, "precision at 5". The number of recommendations to consider when evaluating precision,
etc.</dd>
<dd><code>relevanceThreshold</code> - items whose preference value is at least this value are considered "relevant" for the purposes
of computations</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../../../org/apache/mahout/cf/taste/eval/IRStatistics.html" title="interface in org.apache.mahout.cf.taste.eval"><code>IRStatistics</code></a> with resulting precision, recall, etc.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/mahout/cf/taste/common/TasteException.html" title="class in org.apache.mahout.cf.taste.common">TasteException</a></code> - if an error occurs while accessing the <a href="../../../../../../org/apache/mahout/cf/taste/model/DataModel.html" title="interface in org.apache.mahout.cf.taste.model"><code>DataModel</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RecommenderIRStatsEvaluator.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/mahout/cf/taste/eval/RecommenderEvaluator.html" title="interface in org.apache.mahout.cf.taste.eval"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/mahout/cf/taste/eval/RelevantItemsDataSplitter.html" title="interface in org.apache.mahout.cf.taste.eval"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/mahout/cf/taste/eval/RecommenderIRStatsEvaluator.html" target="_top">Frames</a></li>
<li><a href="RecommenderIRStatsEvaluator.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>Copyright &#169; 2008&#x2013;2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>