[
https://issues.apache.org/jira/browse/MAHOUT-1827?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Shane Curcuru updated MAHOUT-1827:
----------------------------------
Labels: documentation patch (was: )
Status: Patch Available (was: Open)
Index: trunk/content/developers/how-to-contribute.mdtext
===================================================================
--- trunk/content/developers/how-to-contribute.mdtext (revision 1738310)
+++ trunk/content/developers/how-to-contribute.mdtext (working copy)
@@ -7,19 +7,19 @@
of ways to contribute!
<a name="HowToContribute-BeInvolved"></a>
-## Be Involved
+## Get Involved
-Contributors should join the [Mahout mailing
lists](/general/mailing-lists,-irc-and-archives.html). In particular:
+Discussions at Apache happen on the mailing list. To get involved, you should
join the [Mahout mailing lists](/general/mailing-lists,-irc-and-archives.html).
In particular:
* The **user list** (to help others)
* The **development list** (to join discussions of changes) -- This is the
best place
-to understand where we are headed.
+to understand where the project is headed.
* The **commit list** (to see changes as they are made)
Please keep discussions about Mahout on list so that everyone benefits.
Emailing individual committers with questions about specific Mahout issues
is discouraged. See
[http://people.apache.org/~hossman/#private_q](http://people.apache.org/~hossman/#private_q)
-.
+. Apache has a number of [email tips for contributors][1] as well.
<a name="HowToContribute-WhattoWorkOn?"></a>
## What to Work On?
@@ -34,7 +34,7 @@
for making changes to the code. Mahout is a pretty big beast at this
point, so changes, especially from non-committers, need to be evolutionary
not revolutionary since it is often very difficult to evaluate the merits
-of a very large patch. Think small, at least to start\!
+of a very large patch. Think small, at least to start!
Beyond JIRA, hang out on the dev@ mailing list. That's where we discuss
what we are working on in the internals and where you can get a sense of
@@ -43,7 +43,9 @@
Also, documentation is a great way to familiarize yourself with the code
and is always a welcome addition to the codebase and this website. Feel free
to contribute texts and tutorials! Committers will make sure they are added
-to this website.
+to this website, and we have a [guide for making website updates][2].
+We also have a [wide variety of books and slides][3] for learning more about
+machine learning algorithms.
If you are interested in working towards being a committer, [general
guidelines are available online](/developers/how-to-become-a-committer.html).
@@ -88,8 +90,8 @@
- Be sure to adhere to the following points:
- All public classes and methods should have informative Javadoc
comments.
- - Code should be formatted according to the official
-
[conventions](http://www.oracle.com/technetwork/java/codeconventions-150003.pdf),
+ - Code should be formatted according to standard
+ [Java coding
conventions](http://www.oracle.com/technetwork/java/codeconventions-150003.pdf),
with two exceptions:
- indent two spaces per level, not four.
- lines can be 120 characters, not 80.
@@ -102,7 +104,7 @@
- ie. MAHOUT-xxxx: < JIRA-Issue-Description >
6. Committers and other members of the Mahout community can then comment on
the Pull Request. Be sure to watch for comments, respond and make any
necessary changes.
-Please be patient. Committers are busy people too. If no one responds to your
Pull Request after a few days, please make friendly reminders. Please
+Please be patient. Committers are busy people too. If no one responds to your
Pull Request after a few days, please make friendly reminders on the mailing
list. Please
incorporate other's suggestions into into your changes if you think they're
reasonable. Finally, remember that even changes that are not committed are
useful to the community.
<a name="HowToContribute-UnitTests"></a>
@@ -140,3 +142,8 @@
effort to improve the docs/tests for an issue, that helps even more.
For more information see [Handling GitHub
PRs](http://mahout.apache.org/developers/github.html).
+
+
+ [1]: http://www.apache.org/dev/contrib-email-tips
+ [2]: http://mahout.apache.org/developers/how-to-update-the-website.html
+ [3]: http://mahout.apache.org/general/books-tutorials-and-talks.html
\ No newline at end of file
Index: trunk/content/index.mdtext
===================================================================
--- trunk/content/index.mdtext (revision 1738310)
+++ trunk/content/index.mdtext (working copy)
@@ -1,10 +1,10 @@
<h1>What is Apache Mahout?</h1>
-<h2>The Apache Mahout™ project's goal is to build an environment for quickly
creating scalable performant machine learning applications.
+<h2>Apache Mahout™ software provides an environment for easily creating
scalable and performant machine learning applications using a variety of data
sources.
</h2>
<div class="highlights">
<a href="http://mahout.apache.org/general/downloads.html";><img
src="http://mahout.apache.org/images/download-mahout.png"/></a>
<h4>Latest release version 0.11.2 has</h4>
- <h6>Mahout Samsara Environment</h3>
+ <h6>Apache Mahout Samsara Environment includes</h3>
<ul>
<li>Distributed Algebraic optimizer</li>
<li>R-Like DSL Scala API</li>
@@ -12,11 +12,11 @@
<li>Ops are extensions to Scala</li>
<li>IScala REPL based interactive shell</li>
<li>Integrates with compatible libraries like MLLib</li>
- <li>Run on distributed Spark and H2O</li>
+ <li>Runs on distributed Spark and H2O</li>
<li>fastutil to speed up sparse matrix and vector computations</li>
- <li>Flink in progress</li>
+ <li>Flink data source in progress</li>
</ul>
- <h6>Mahout Samsara based Algorithms</h6>
+ <h6>Apache Mahout Samsara Algorithms included</h6>
<ul>
<li>Stochastic Singular Value Decomposition (ssvd, dssvd)</li>
<li>Stochastic Principal Component Analysis (spca, dspca)</li>
@@ -27,25 +27,37 @@
<li>Distributed and in-core</li>
</ul>
</div>
- <p>The three major components of Mahout are an environment for building
scalable algorithms, many new Scala + Spark and H2O (Apache Flink in progress)
algorithms, and Mahout's mature Hadoop MapReduce algorithms.</p>
+ <p>**Apache Mahout software** includes three major features:</p>
+ <ul>
+ <li>A simple and extensible programming environment and framework for
accessing data and algorithims</li>
+ <li>A wide variety of premade algorithms for Scala + Spark, H2O, and
soon Apache Flink</li>
+ <li>Mahout's mature Hadoop MapReduce algorithms</li>
+ </ul>
+ <p>Read an [Overview of programming a Mahout MapReduce job][1],
+learn [How To Contribute to Mahout][2],
+[report an issue, bug, or suggestion][3] in our JIRA,
+see the [Samsara bindings for Scala and Spark][4],
+and [contact us on our mailing lists][5].
+</p>
+
<h4>**12 Mar 2016 - Apache Mahout 0.11.2 released**</h4>
- <p>**Apache Mahout introduces a new math environment we call**
[**Samsara**](http://mahout.apache.org/users/sparkbindings/home.html),
+ <p>**Apache Mahout introduces a new math environment called**
[**Samsara**](http://mahout.apache.org/users/sparkbindings/home.html),
for its theme of universal renewal. It reflects a fundamental rethinking
of how scalable machine learning
algorithms are built and customized. Mahout-Samsara is here to help people
create their own math while providing
some off-the-shelf algorithm implementations. At its core are general
linear algebra and statistical operations
along with the data structures to support them. You can use is as a library
or customize it in Scala with Mahout-specific extensions
that look something like R.
- Mahout-Samsara comes with an interactive shell that runs distributed
operations on a Spark cluster.
+ Mahout-Samsara comes with an interactive shell that runs distributed
operations on an Apache Spark cluster.
This make prototyping or task submission much easier and allows users to
customize algorithms with
a whole new degree of freedom.</p>
<p>[**Mahout
Algorithms**](http://mahout.apache.org/users/basics/algorithms.html) include
many new
implementations built for speed on Mahout-Samsara. They run on Spark 1.3+
and some on H2O, which means as
- much as a 10x speed increase. You’ll find robust matrix decomposition
algorithms as well as a **[Naive Bayes][1]**
+ much as a 10x speed increase. You’ll find robust matrix decomposition
algorithms as well as a **[Naive Bayes][6]**
classifier and collaborative filtering. The new spark-itemsimilarity
enables the next generation of **[cooccurrence
- recommenders][2]** that can use entire user click streams and context in
making recommendations.</p>
+ recommenders][7]** that can use entire user click streams and context in
making recommendations.</p>
- <p>Visit our [release
notes](http://mahout.apache.org/general/release-notes.html) page for details.
Interested in helping? Join the <a
href="https://mahout.apache.org/general/mailing-lists,-irc-and-archives.html";>Mailing
lists</a>.</p>
+ <p>Our [release notes](http://mahout.apache.org/general/release-notes.html)
have details. Interested in helping? Join the <a
href="https://mahout.apache.org/general/mailing-lists,-irc-and-archives.html";>Mailing
lists</a>.</p>
# Mahout News
@@ -82,10 +94,15 @@
#### 9 Oct 2011 - Mahout in Action released
-The book Mahout in Action is available in print. Sean Owen, Robin Anil, Ted
Dunning and Ellen Friedman thank the community (especially those who were
reviewers) for input during the process and hope it is enjoyable.
+The book *Mahout in Action* is available in print. Sean Owen, Robin Anil, Ted
Dunning and Ellen Friedman thank the community (especially those who were
reviewers) for input during the process and hope it is enjoyable.
-Find it at your favorite bookstore, or [order print and eBook copies from
Manning](http://manning.com/owen/) -- use discount code "mahout37" for 37% off.
+Find *Mahout in Action* at your favorite bookstore, or [order print and eBook
copies from Manning](http://manning.com/owen/) -- use discount code "mahout37"
for 37% off.
- [1]: http://mahout.apache.org/users/algorithms/spark-naive-bayes.html
- [2]: http://mahout.apache.org/users/algorithms/intro-cooccurrence-spark.html
\ No newline at end of file
+ [1]: http://mahout.apache.org/users/basics/quickstart.html
+ [2]: http://mahout.apache.org/developers/how-to-contribute.html
+ [3]: http://mahout.apache.org/developers/issue-tracker.html
+ [4]: http://mahout.apache.org/users/sparkbindings/home.html
+ [5]: http://mahout.apache.org/general/mailing-lists,-irc-and-archives.html
+ [6]: http://mahout.apache.org/users/algorithms/spark-naive-bayes.html
+ [7]: http://mahout.apache.org/users/algorithms/intro-cooccurrence-spark.html
\ No newline at end of file
> Suggested changes to homepage, how to contribute
> ------------------------------------------------
>
> Key: MAHOUT-1827
> URL: https://issues.apache.org/jira/browse/MAHOUT-1827
> Project: Mahout
> Issue Type: Documentation
> Components: Documentation
> Reporter: Shane Curcuru
> Priority: Minor
> Labels: patch, documentation
>
> See attached patch(es). Feel free to modify as needed for your style guide.
> I tried to not change any meanings (not being a Mahout user!) but just to
> include helpful links and slightly easier to understand introductions.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
![http://mahout.apache.org/images/download-mahout.png"/](http://mahout.apache.org/images/download-mahout.png"/){kind=link}