You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mahout.apache.org by gs...@apache.org on 2009/04/09 23:39:22 UTC
svn commit: r763817 - in /lucene/mahout/site: publish/
src/documentation/content/xdocs/
Author: gsingers
Date: Thu Apr 9 21:39:21 2009
New Revision: 763817
URL: http://svn.apache.org/viewvc?rev=763817&view=rev
Log:
Mahout 0.1 announcement
Modified:
lucene/mahout/site/publish/broken-links.xml
lucene/mahout/site/publish/index.html
lucene/mahout/site/publish/releases.html
lucene/mahout/site/publish/systemrequirements.html
lucene/mahout/site/publish/taste.html
lucene/mahout/site/src/documentation/content/xdocs/index.xml
lucene/mahout/site/src/documentation/content/xdocs/releases.xml
lucene/mahout/site/src/documentation/content/xdocs/systemrequirements.xml
Modified: lucene/mahout/site/publish/broken-links.xml
URL: http://svn.apache.org/viewvc/lucene/mahout/site/publish/broken-links.xml?rev=763817&r1=763816&r2=763817&view=diff
==============================================================================
--- lucene/mahout/site/publish/broken-links.xml (original)
+++ lucene/mahout/site/publish/broken-links.xml Thu Apr 9 21:39:21 2009
@@ -1,2 +1,26 @@
<broken-links>
+ <link message="No pipeline matched request: index.pdf" uri="index.pdf">
+ <referrer uri="index.html"/>
+ </link>
+ <link message="No pipeline matched request: developer-resources.pdf" uri="developer-resources.pdf">
+ <referrer uri="developer-resources.html"/>
+ </link>
+ <link message="No pipeline matched request: releases.pdf" uri="releases.pdf">
+ <referrer uri="releases.html"/>
+ </link>
+ <link message="No pipeline matched request: mailinglists.pdf" uri="mailinglists.pdf">
+ <referrer uri="mailinglists.html"/>
+ </link>
+ <link message="No pipeline matched request: taste.pdf" uri="taste.pdf">
+ <referrer uri="taste.html"/>
+ </link>
+ <link message="No pipeline matched request: whoweare.pdf" uri="whoweare.pdf">
+ <referrer uri="whoweare.html"/>
+ </link>
+ <link message="No pipeline matched request: systemrequirements.pdf" uri="systemrequirements.pdf">
+ <referrer uri="systemrequirements.html"/>
+ </link>
+ <link message="No pipeline matched request: linkmap.pdf" uri="linkmap.pdf">
+ <referrer uri="linkmap.html"/>
+ </link>
</broken-links>
Modified: lucene/mahout/site/publish/index.html
URL: http://svn.apache.org/viewvc/lucene/mahout/site/publish/index.html?rev=763817&r1=763816&r2=763817&view=diff
==============================================================================
--- lucene/mahout/site/publish/index.html (original)
+++ lucene/mahout/site/publish/index.html Thu Apr 9 21:39:21 2009
@@ -189,6 +189,9 @@
<a href="#Mahout News">Mahout News</a>
<ul class="minitoc">
<li>
+<a href="#07+April+2009+-+Apache+Mahout+0.1+released">07 April 2009 - Apache Mahout 0.1 released</a>
+</li>
+<li>
<a href="#09+February+2009+-+Lucene+at+ApacheCon+Europe+2009+in+Amsterdam">09 February 2009 - Lucene at ApacheCon Europe 2009 in Amsterdam</a>
</li>
<li>
@@ -222,7 +225,36 @@
<a name="N10025"></a><a name="Mahout News"></a>
<h2 class="boxed">Mahout News</h2>
<div class="section">
-<a name="N1002B"></a><a name="09+February+2009+-+Lucene+at+ApacheCon+Europe+2009+in+Amsterdam"></a>
+<a name="N1002B"></a><a name="07+April+2009+-+Apache+Mahout+0.1+released"></a>
+<h3 class="boxed">07 April 2009 - Apache Mahout 0.1 released</h3>
+<p>The Apache Lucene project is pleased to announce the release of Apache Mahout 0.1.
+ Apache Mahout is a subproject of Apache Lucene with the goal of delivering scalable
+ machine learning algorithm implementations under the Apache license. The first public
+ release includes implementations for clustering, classification,
+ collaborative filtering and evolutionary programming.
+ </p>
+<p>
+ Highlights include:
+ <ul>
+
+<li>Taste Collaborative Filtering</li>
+
+<li>Several distributed clustering implementations: k-Means, Fuzzy k-Means, Dirchlet, Mean-Shift and Canopy</li>
+
+<li>Distributed Naive Bayes and Complementary Naive Bayes classification implementations</li>
+
+<li>Distributed fitness function implementation for the Watchmaker evolutionary programming library</li>
+
+<li>Most implementations are built on top of Apache Hadoop (http://hadoop.apache.org) for scalability</li>
+
+</ul>
+
+</p>
+<p>Details on what's included can be found in the <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12310751&styleName=Html&version=12312976">release notes</a>.
+ </p>
+<p>Downloads are available from the <a href="http://www.apache.org/dyn/closer.cgi/lucene/mahout/">Apache Mirrors</a>
+</p>
+<a name="N10054"></a><a name="09+February+2009+-+Lucene+at+ApacheCon+Europe+2009+in+Amsterdam"></a>
<h3 class="boxed">09 February 2009 - Lucene at ApacheCon Europe 2009 in Amsterdam</h3>
<p>
@@ -260,7 +292,7 @@
</ul>
-<a name="N10074"></a><a name="22+July+2008+-+Lucene+at+ApacheCon+New+Orleans"></a>
+<a name="N1009D"></a><a name="22+July+2008+-+Lucene+at+ApacheCon+New+Orleans"></a>
<h3 class="boxed">22 July 2008 - Lucene at ApacheCon New Orleans</h3>
<p>
@@ -282,13 +314,13 @@
<li>An <a href="http://us.apachecon.com/c/acus2008/schedule/2008/11/05">entire day of Lucene sessions</a>, including a talk on Mahout by Mahout committer Grant Ingersoll, on November 5th</li>
</ul>
-<a name="N100A2"></a><a name="4+April+2008+-+Mahout+-+Now+with+more+Taste%21"></a>
+<a name="N100CB"></a><a name="4+April+2008+-+Mahout+-+Now+with+more+Taste%21"></a>
<h3 class="boxed">4 April 2008 - Mahout - Now with more Taste!</h3>
<p>We are pleased to announce that the Taste Collaborative Filtering (<a href="http://taste.sf.net">Taste on SourceForge</a>) has donated it's codebase to the Mahout project. In the coming weeks and months we will work to bring it into Mahout and then make it run on Hadoop, bringing truly large scale collaborative filtering capabilities to our users.</p>
-<a name="N100B0"></a><a name="16+March+2008+-+Google+Summer+Of+Code+Projects"></a>
+<a name="N100D9"></a><a name="16+March+2008+-+Google+Summer+Of+Code+Projects"></a>
<h3 class="boxed">16 March 2008 - Google Summer Of Code Projects</h3>
<p>The ASF is in the process of creating projects for Google's annual Summer of Code Project. Mahout has a number of people willing to be mentors, so if you are a student interested in working on machine learning algorithms using Hadoop, then please check out the ASF <a href="http://wiki.apache.org/general/SummerOfCode2008">Summer of Code</a> wiki page.</p>
-<a name="N100BE"></a><a name="22+January+2008+-+Mahout+launches"></a>
+<a name="N100E7"></a><a name="22+January+2008+-+Mahout+launches"></a>
<h3 class="boxed">22 January 2008 - Mahout launches</h3>
<p>The <a href="http://lucene.apache.org">Lucene PMC</a> announces the creation of the Mahout subproject.</p>
</div>
Modified: lucene/mahout/site/publish/releases.html
URL: http://svn.apache.org/viewvc/lucene/mahout/site/publish/releases.html?rev=763817&r1=763816&r2=763817&view=diff
==============================================================================
--- lucene/mahout/site/publish/releases.html (original)
+++ lucene/mahout/site/publish/releases.html Thu Apr 9 21:39:21 2009
@@ -181,6 +181,9 @@
<li>
<a href="#Official">Official Release</a>
</li>
+<li>
+<a href="#future">Future Releases</a>
+</li>
</ul>
</li>
</ul>
@@ -193,10 +196,15 @@
<p>Information on Mahout Downloads and Releases.</p>
<a name="N10019"></a><a name="Official"></a>
<h3 class="boxed">Official Release</h3>
+<p>The latest Mahout release is available for download at: <a href="http://www.apache.org/dyn/closer.cgi/lucene/mahout/0.1/">http://www.apache.org/dyn/closer.cgi/lucene/mahout/</a>
+</p>
+<p>System Requirements are detailed
+ <a href="systemrequirements.html">here</a>.</p>
+<a name="N1002C"></a><a name="future"></a>
+<h3 class="boxed">Future Releases</h3>
<p>Official releases are usually created when the <a href="whoweare.html">developers</a> feel there are
- sufficient changes, improvements and bug fixes to warrant a release.
- Due to the voluntary nature of Mahout, no releases are scheduled in advance (for the most part). System Requirements are detailed
- <a href="systemrequirements.html">here</a>.</p>
+ sufficient changes, improvements and bug fixes to warrant a release.
+ </p>
</div>
Modified: lucene/mahout/site/publish/systemrequirements.html
URL: http://svn.apache.org/viewvc/lucene/mahout/site/publish/systemrequirements.html?rev=763817&r1=763816&r2=763817&view=diff
==============================================================================
--- lucene/mahout/site/publish/systemrequirements.html (original)
+++ lucene/mahout/site/publish/systemrequirements.html Thu Apr 9 21:39:21 2009
@@ -192,7 +192,7 @@
The latest Lucene <a href="releases.html">release</a> has the following minimum requirements:
<ul>
-<li>Java 1.5.x or greater.</li>
+<li>Java 1.6.x or greater.</li>
<li>ANT 1.7.0 or greater.</li>
Modified: lucene/mahout/site/publish/taste.html
URL: http://svn.apache.org/viewvc/lucene/mahout/site/publish/taste.html?rev=763817&r1=763816&r2=763817&view=diff
==============================================================================
--- lucene/mahout/site/publish/taste.html (original)
+++ lucene/mahout/site/publish/taste.html Thu Apr 9 21:39:21 2009
@@ -340,7 +340,7 @@
<ul>
<li>
-<a href="http://java.sun.com/j2se/1.5.0/index.jsp">Java / J2SE 5.0</a>
+<a href="http://java.sun.com/j2se/1.5.0/index.jsp">Java / J2SE 6.0</a>
</li>
</ul>
@@ -349,8 +349,9 @@
<ul>
<li>
-<a href="http://ant.apache.org/">Apache Ant</a> 1.5 or later,
- if you want to build from source or build examples.</li>
+<a href="http://ant.apache.org/">Apache Ant</a> 1.5 or later and <a href="http://maven.apache.org">Maven</a>
+ 2.0.10 or later, if you want to build from source or build examples. (Mac users note that even OS X 10.5
+ ships with Maven 2.0.6, which will not work.)</li>
<li>Taste web applications require a <a href="http://java.sun.com/products/servlet/index.jsp">Servlet 2.3+</a>
container, such as
@@ -367,15 +368,16 @@
</div>
-<a name="N100F9"></a><a name="demo"></a>
+<a name="N100FD"></a><a name="demo"></a>
<h2 class="boxed">Demo</h2>
<div class="section">
<p>To build and run the demo, follow the instructions below, which are written for Unix-like operating systems:</p>
<ol>
+<li>Obtain a copy of the Mahout distribution, either from SVN or as a downloaded archive.</li>
+
<li>Download the "1 Million MovieLens Dataset" from
<a href="http://www.grouplens.org/">http://www.grouplens.org/</a>.</li>
-
<li>Unpack the archive and copy <span class="codefrag">movies.dat</span> and <span class="codefrag">ratings.dat</span> to
<span class="codefrag">trunk/taste-web/src/main/resources/org/apache/mahout/cf/taste/example/grouplens</span> under the Mahout distribution
@@ -383,20 +385,28 @@
<li>Navigate to the directory where you unpacked the Mahout distribution, and navigate to <span class="codefrag">trunk</span>.</li>
-<li>mvn install -- Install Mahout core to your local repository</li>
+<li>Run <span class="codefrag">mvn install</span>, which builds and installs Mahout core to your local repository</li>
-<li>cd taste-web</li>
+<li>
+<span class="codefrag">cd taste-web</span>
+</li>
-<li>cp ../examples/target/grouplens.jar ./lib -- If you are using a different recommender, just add it to the lib directory</li>
+<li>
+<span class="codefrag">cp ../examples/target/grouplens.jar ./lib</span>
+</li>
+
+<li>Edit <span class="codefrag">recommender.properties</span> and fill in the <span class="codefrag">recommender.class</span>:
+ <span class="codefrag">recommender.class=org.apache.mahout.cf.taste.example.grouplens.GroupLensRecommender</span>
-<li>Edit recommender.properties and fill in the recommender.class value with the GroupLensRecommender, i.e.<ul>
-<li>recommender.class=org.apache.mahout.cf.taste.example.grouplens.GroupLensRecommender</li>
-</ul>
</li>
-<li>mvn package</li>
+<li>
+<span class="codefrag">mvn package</span>
+</li>
-<li>mvn jetty:run-war - You may need to give Maven more memory: In bash shell, do export MAVEN_OPTS=-Xmx1024M</li>
+<li>
+<span class="codefrag">mvn jetty:run-war</span>. You may need to give Maven more memory: in a bash shell, <span class="codefrag">export MAVEN_OPTS=-Xmx1024M</span>
+</li>
<li>Get recommendations by accessing the web application in your browser:<br>
@@ -424,16 +434,17 @@
</div>
-<a name="N10156"></a><a name="examples"></a>
+<a name="N1016D"></a><a name="examples"></a>
<h2 class="boxed">Examples</h2>
<div class="section">
-<a name="N1015B"></a><a name="User-based+Recommender"></a>
+<a name="N10172"></a><a name="User-based+Recommender"></a>
<h3 class="boxed">User-based Recommender</h3>
<p>User-based recommenders are the "original", conventional style of recommender system. They can produce good
recommendations when tweaked properly; they are not necessarily the fastest recommender systems and
are thus suitable for small data sets (roughly, less than a million ratings). We'll start with an example of this.</p>
<p>First, create a <span class="codefrag">DataModel</span> of some kind. Here, we'll use a simple on based
-on data in a file:</p>
+on data in a file. The file should be in CSV format, with lines of the form <span class="codefrag">userID,itemID,prefValue</span>
+(e.g. "AB39505,290002,3.5"):</p>
<pre>DataModel model = new FileDataModel(new File("data.txt"));
</pre>
<p>We'll use the PearsonCorrelationSimilarity implementation of <span class="codefrag">UserSimilarity</span> as our user
@@ -455,7 +466,7 @@
<pre>List<RecommendedItem> recommendations =
cachingRecommender.recommend("1234", 10);
</pre>
-<a name="N1018E"></a><a name="Item-based+Recommender"></a>
+<a name="N101A8"></a><a name="Item-based+Recommender"></a>
<h3 class="boxed">Item-based Recommender</h3>
<p>We could have created an item-based recommender instead. Item-based recommender base recommendation
not on user similarity, but on item similarity. In theory these are about the same approach to the
@@ -485,7 +496,7 @@
List<RecommendedItem> recommendations =
cachingRecommender.recommend("1234", 10);
</pre>
-<a name="N101B5"></a><a name="Slope-One+Recommender"></a>
+<a name="N101CF"></a><a name="Slope-One+Recommender"></a>
<h3 class="boxed">Slope-One Recommender</h3>
<p>This is a simple yet effective <span class="codefrag">Recommender</span> and we present another example to
round out the list:</p>
@@ -497,14 +508,14 @@
</div>
-<a name="N101C5"></a><a name="integration"></a>
+<a name="N101DF"></a><a name="integration"></a>
<h2 class="boxed">Integration with your application</h2>
<div class="section">
-<a name="N101CA"></a><a name="Direct"></a>
+<a name="N101E4"></a><a name="Direct"></a>
<h3 class="boxed">Direct</h3>
<p>You can create a <span class="codefrag">Recommender</span>, as shown above, wherever you like in your Java application, and use it. This
includes simple Java applications or GUI applications, server applications, and J2EE web applications.</p>
-<a name="N101D6"></a><a name="Standalone+server"></a>
+<a name="N101F0"></a><a name="Standalone+server"></a>
<h3 class="boxed">Standalone server</h3>
<p>Taste can also be run as an external server, which may be the only option for non-Java applications.
A Taste Recommender can be exposed as a web application via <span class="codefrag">org.apach.mahout.cf.taste.web.RecommenderServlet</span>,
@@ -514,26 +525,42 @@
<p>To deploy your <span class="codefrag">Recommender</span> as an external server:</p>
<ol>
-<li>Create an implementation of <span class="codefrag">org.apache.mahout.cf.taste.recommender.Recommender</span>.</li>
-
+<li>Obtain a copy of the Mahout distribution, either from SVN or as a downloaded archive.</li>
+
+<li>Create an implementation of <span class="codefrag">org.apache.mahout.cf.taste.recommender.Recommender</span> (must have a no-arg constructor).</li>
<li>Compile it and create a JAR file containing your implementation.</li>
-<li>Build a WAR file that will run your Recommender as a web application:<br>
+<li>Navigate to the directory where you unpacked the Mahout distribution, and navigate to <span class="codefrag">trunk</span>.</li>
+
+<li>Run <span class="codefrag">mvn install</span>, which builds and installs Mahout core to your local repository</li>
+
+<li>
+<span class="codefrag">cd taste-web</span>
+</li>
+
+<li>Copy your .jar file: <span class="codefrag">cp [your .jar file] ./lib</span>
+</li>
+
+<li>Edit <span class="codefrag">recommender.properties</span> and fill in the <span class="codefrag">recommender.class</span> with your Recommender clas:
+ <span class="codefrag">recommender.class=[your recommender class]</span>
-<span class="codefrag">ant -Dmy-recommender.jar=yourJARfile.jar -Dmy-recommender-class=com.foo.YourRecommender build-server</span>
</li>
-<li>Follow from the "Install Tomcat" step above under <a href="#demo">Demo</a>.</li>
+<li>
+<span class="codefrag">mvn package</span>
+</li>
+
+<li>Your .war file is now available in the build directory as <span class="codefrag">mahout-taste-webapp.war</span> (which can be renamed).</li>
</ol>
</div>
-<a name="N10206"></a><a name="performance"></a>
+<a name="N10240"></a><a name="performance"></a>
<h2 class="boxed">Performance</h2>
<div class="section">
-<a name="N1020B"></a><a name="Runtime+Performance"></a>
+<a name="N10245"></a><a name="Runtime+Performance"></a>
<h3 class="boxed">Runtime Performance</h3>
<p>The more data you give Taste, the better. Though Taste is designed for performance, you will undoubtedly run into
performance issues at some point. For best results, consider using the following commad-line flags to your JVM:</p>
@@ -583,7 +610,7 @@
<span class="codefrag">MySQLJDBCDataModel</span>.</li>
</ul>
-<a name="N10256"></a><a name="Algorithm+Performance%3A+Which+One+Is+Best%3F"></a>
+<a name="N10290"></a><a name="Algorithm+Performance%3A+Which+One+Is+Best%3F"></a>
<h3 class="boxed">Algorithm Performance: Which One Is Best?</h3>
<p>There is no right answer; it depends on your data, your application, environment, and performance needs.
Taste provides the building blocks from which you can construct the best <span class="codefrag">Recommender</span> for your
@@ -604,7 +631,7 @@
</div>
-<a name="N1026F"></a><a name="useful"></a>
+<a name="N102A9"></a><a name="useful"></a>
<h2 class="boxed">Useful Links</h2>
<div class="section">
<p>You'll want to look at these packages too, which offer more algorithms and approaches that you
Modified: lucene/mahout/site/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewvc/lucene/mahout/site/src/documentation/content/xdocs/index.xml?rev=763817&r1=763816&r2=763817&view=diff
==============================================================================
--- lucene/mahout/site/src/documentation/content/xdocs/index.xml (original)
+++ lucene/mahout/site/src/documentation/content/xdocs/index.xml Thu Apr 9 21:39:21 2009
@@ -17,6 +17,25 @@
<section id="Mahout News">
<title>Mahout News</title>
+ <section>
+ <title>07 April 2009 - Apache Mahout 0.1 released</title>
+ <p>The Apache Lucene project is pleased to announce the release of Apache Mahout 0.1.
+ Apache Mahout is a subproject of Apache Lucene with the goal of delivering scalable
+ machine learning algorithm implementations under the Apache license. The first public
+ release includes implementations for clustering, classification,
+ collaborative filtering and evolutionary programming.
+ </p><p>
+ Highlights include:
+ <ul>
+ <li>Taste Collaborative Filtering</li>
+ <li>Several distributed clustering implementations: k-Means, Fuzzy k-Means, Dirchlet, Mean-Shift and Canopy</li>
+ <li>Distributed Naive Bayes and Complementary Naive Bayes classification implementations</li>
+ <li>Distributed fitness function implementation for the Watchmaker evolutionary programming library</li>
+ <li>Most implementations are built on top of Apache Hadoop (http://hadoop.apache.org) for scalability</li>
+ </ul>
+ </p>
+ <p>Details on what's included can be found in the <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12310751&styleName=Html&version=12312976">release notes</a>.
+ </p><p>Downloads are available from the <a href="http://www.apache.org/dyn/closer.cgi/lucene/mahout/">Apache Mirrors</a></p></section>
<section>
<title>09 February 2009 - Lucene at ApacheCon Europe 2009 in Amsterdam</title>
<p>
Modified: lucene/mahout/site/src/documentation/content/xdocs/releases.xml
URL: http://svn.apache.org/viewvc/lucene/mahout/site/src/documentation/content/xdocs/releases.xml?rev=763817&r1=763816&r2=763817&view=diff
==============================================================================
--- lucene/mahout/site/src/documentation/content/xdocs/releases.xml (original)
+++ lucene/mahout/site/src/documentation/content/xdocs/releases.xml Thu Apr 9 21:39:21 2009
@@ -9,11 +9,15 @@
<section id="Downloads"><title>Downloads and Releases</title>
<p>Information on Mahout Downloads and Releases.</p>
<section id="Official"><title>Official Release</title>
- <p>Official releases are usually created when the <a href="whoweare.html">developers</a> feel there are
- sufficient changes, improvements and bug fixes to warrant a release.
- Due to the voluntary nature of Mahout, no releases are scheduled in advance (for the most part). System Requirements are detailed
- <a href="systemrequirements.html">here</a>.</p>
+ <p>The latest Mahout release is available for download at: <a href="http://www.apache.org/dyn/closer.cgi/lucene/mahout/0.1/">http://www.apache.org/dyn/closer.cgi/lucene/mahout/</a></p>
+ <p>System Requirements are detailed
+ <a href="systemrequirements.html">here</a>.</p>
</section>
+ <section id="future"><title>Future Releases</title>
+ <p>Official releases are usually created when the <a href="whoweare.html">developers</a> feel there are
+ sufficient changes, improvements and bug fixes to warrant a release.
+ </p>
+ </section>
</section>
Modified: lucene/mahout/site/src/documentation/content/xdocs/systemrequirements.xml
URL: http://svn.apache.org/viewvc/lucene/mahout/site/src/documentation/content/xdocs/systemrequirements.xml?rev=763817&r1=763816&r2=763817&view=diff
==============================================================================
--- lucene/mahout/site/src/documentation/content/xdocs/systemrequirements.xml (original)
+++ lucene/mahout/site/src/documentation/content/xdocs/systemrequirements.xml Thu Apr 9 21:39:21 2009
@@ -13,7 +13,7 @@
<p>
The latest Lucene <a href="releases.html">release</a> has the following minimum requirements:
<ul>
- <li>Java 1.5.x or greater.</li>
+ <li>Java 1.6.x or greater.</li>
<li>ANT 1.7.0 or greater.</li>
<li>JUnit 3.8.1 if you wish to run the unit tests.</li>
<li>CPU, Disk and Memory requirements are based on the many choices made in implementing Mahout (document size, number of documents, and number of hits retrieved to name a few.)</li>