blob: c720ccbc93adebc03f624fd5ef4d4313dbeb30aa [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:37 PDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.mahout.cf.taste.impl.recommender (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="org.apache.mahout.cf.taste.impl.recommender (Mahout Map-Reduce 0.13.0 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/impl/neighborhood/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/svd/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/mahout/cf/taste/impl/recommender/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.mahout.cf.taste.impl.recommender</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/TopItems.Estimator.html" title="interface in org.apache.mahout.cf.taste.impl.recommender">TopItems.Estimator</a>&lt;T&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/AbstractCandidateItemsStrategy.html" title="class in org.apache.mahout.cf.taste.impl.recommender">AbstractCandidateItemsStrategy</a></td>
<td class="colLast">
<div class="block">Abstract base implementation for retrieving candidate items to recommend</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/AbstractRecommender.html" title="class in org.apache.mahout.cf.taste.impl.recommender">AbstractRecommender</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/AllSimilarItemsCandidateItemsStrategy.html" title="class in org.apache.mahout.cf.taste.impl.recommender">AllSimilarItemsCandidateItemsStrategy</a></td>
<td class="colLast">
<div class="block">returns the result of <a href="../../../../../../../org/apache/mahout/cf/taste/similarity/ItemSimilarity.html#allSimilarItemIDs-long-"><code>ItemSimilarity.allSimilarItemIDs(long)</code></a> as candidate items</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/AllUnknownItemsCandidateItemsStrategy.html" title="class in org.apache.mahout.cf.taste.impl.recommender">AllUnknownItemsCandidateItemsStrategy</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/ByValueRecommendedItemComparator.html" title="class in org.apache.mahout.cf.taste.impl.recommender">ByValueRecommendedItemComparator</a></td>
<td class="colLast">
<div class="block">Defines a natural ordering from most-preferred item (highest value) to least-preferred.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/CachingRecommender.html" title="class in org.apache.mahout.cf.taste.impl.recommender">CachingRecommender</a></td>
<td class="colLast">
<div class="block">
A <a href="../../../../../../../org/apache/mahout/cf/taste/recommender/Recommender.html" title="interface in org.apache.mahout.cf.taste.recommender"><code>Recommender</code></a> which caches the results from another <a href="../../../../../../../org/apache/mahout/cf/taste/recommender/Recommender.html" title="interface in org.apache.mahout.cf.taste.recommender"><code>Recommender</code></a> in memory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/EstimatedPreferenceCapper.html" title="class in org.apache.mahout.cf.taste.impl.recommender">EstimatedPreferenceCapper</a></td>
<td class="colLast">
<div class="block">Simple class which encapsulates restricting a preference value
to a predefined range.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/GenericBooleanPrefItemBasedRecommender.html" title="class in org.apache.mahout.cf.taste.impl.recommender">GenericBooleanPrefItemBasedRecommender</a></td>
<td class="colLast">
<div class="block">A variant on <a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/GenericItemBasedRecommender.html" title="class in org.apache.mahout.cf.taste.impl.recommender"><code>GenericItemBasedRecommender</code></a> which is appropriate for use when no notion of preference
value exists in the data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/GenericBooleanPrefUserBasedRecommender.html" title="class in org.apache.mahout.cf.taste.impl.recommender">GenericBooleanPrefUserBasedRecommender</a></td>
<td class="colLast">
<div class="block">A variant on <a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/GenericUserBasedRecommender.html" title="class in org.apache.mahout.cf.taste.impl.recommender"><code>GenericUserBasedRecommender</code></a> which is appropriate for use when no notion of preference
value exists in the data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/GenericItemBasedRecommender.html" title="class in org.apache.mahout.cf.taste.impl.recommender">GenericItemBasedRecommender</a></td>
<td class="colLast">
<div class="block">
A simple <a href="../../../../../../../org/apache/mahout/cf/taste/recommender/Recommender.html" title="interface in org.apache.mahout.cf.taste.recommender"><code>Recommender</code></a> which uses a given
<a href="../../../../../../../org/apache/mahout/cf/taste/model/DataModel.html" title="interface in org.apache.mahout.cf.taste.model"><code>DataModel</code></a> and
<a href="../../../../../../../org/apache/mahout/cf/taste/similarity/ItemSimilarity.html" title="interface in org.apache.mahout.cf.taste.similarity"><code>ItemSimilarity</code></a> to produce recommendations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/GenericItemBasedRecommender.MostSimilarEstimator.html" title="class in org.apache.mahout.cf.taste.impl.recommender">GenericItemBasedRecommender.MostSimilarEstimator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/GenericRecommendedItem.html" title="class in org.apache.mahout.cf.taste.impl.recommender">GenericRecommendedItem</a></td>
<td class="colLast">
<div class="block">
A simple implementation of <a href="../../../../../../../org/apache/mahout/cf/taste/recommender/RecommendedItem.html" title="interface in org.apache.mahout.cf.taste.recommender"><code>RecommendedItem</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/GenericUserBasedRecommender.html" title="class in org.apache.mahout.cf.taste.impl.recommender">GenericUserBasedRecommender</a></td>
<td class="colLast">
<div class="block">
A simple <a href="../../../../../../../org/apache/mahout/cf/taste/recommender/Recommender.html" title="interface in org.apache.mahout.cf.taste.recommender"><code>Recommender</code></a>
which uses a given <a href="../../../../../../../org/apache/mahout/cf/taste/model/DataModel.html" title="interface in org.apache.mahout.cf.taste.model"><code>DataModel</code></a> and <a href="../../../../../../../org/apache/mahout/cf/taste/neighborhood/UserNeighborhood.html" title="interface in org.apache.mahout.cf.taste.neighborhood"><code>UserNeighborhood</code></a> to produce recommendations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/ItemAverageRecommender.html" title="class in org.apache.mahout.cf.taste.impl.recommender">ItemAverageRecommender</a></td>
<td class="colLast">
<div class="block">
A simple recommender that always estimates preference for an item to be the average of all known preference
values for that item.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/ItemUserAverageRecommender.html" title="class in org.apache.mahout.cf.taste.impl.recommender">ItemUserAverageRecommender</a></td>
<td class="colLast">
<div class="block">
Like <a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/ItemAverageRecommender.html" title="class in org.apache.mahout.cf.taste.impl.recommender"><code>ItemAverageRecommender</code></a>, except that estimated preferences are adjusted for the users' average
preference value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/NullRescorer.html" title="class in org.apache.mahout.cf.taste.impl.recommender">NullRescorer</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">
A simple <a href="../../../../../../../org/apache/mahout/cf/taste/recommender/Rescorer.html" title="interface in org.apache.mahout.cf.taste.recommender"><code>Rescorer</code></a> which always returns the original score.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/PreferredItemsNeighborhoodCandidateItemsStrategy.html" title="class in org.apache.mahout.cf.taste.impl.recommender">PreferredItemsNeighborhoodCandidateItemsStrategy</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/RandomRecommender.html" title="class in org.apache.mahout.cf.taste.impl.recommender">RandomRecommender</a></td>
<td class="colLast">
<div class="block">Produces random recommendations and preference estimates.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/SamplingCandidateItemsStrategy.html" title="class in org.apache.mahout.cf.taste.impl.recommender">SamplingCandidateItemsStrategy</a></td>
<td class="colLast">
<div class="block">Returns all items that have not been rated by the user <em>(3)</em> and that were preferred by another user
<em>(2)</em> that has preferred at least one item <em>(1)</em> that the current user has preferred too.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/SimilarUser.html" title="class in org.apache.mahout.cf.taste.impl.recommender">SimilarUser</a></td>
<td class="colLast">
<div class="block">Simply encapsulates a user and a similarity value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/TopItems.html" title="class in org.apache.mahout.cf.taste.impl.recommender">TopItems</a></td>
<td class="colLast">
<div class="block">
A simple class that refactors the "find top N things" logic that is used in several places.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/impl/neighborhood/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/mahout/cf/taste/impl/recommender/svd/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/mahout/cf/taste/impl/recommender/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>