SAMOA-17 Update info in README.md in master branch fixes #12
Project: http://git-wip-us.apache.org/repos/asf/incubator-samoa/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-samoa/commit/131f0b69 Tree: http://git-wip-us.apache.org/repos/asf/incubator-samoa/tree/131f0b69 Diff: http://git-wip-us.apache.org/repos/asf/incubator-samoa/diff/131f0b69 Branch: refs/heads/master Commit: 131f0b69265257fcdc9a088d7cab83d9af7ba446 Parents: f2e2582 Author: abifet <[email protected]> Authored: Tue Mar 17 14:00:13 2015 +0800 Committer: abifet <[email protected]> Committed: Tue Mar 17 14:00:13 2015 +0800 ---------------------------------------------------------------------- README.md | 69 +++++++++++++++++++++++++++++----------------------------- 1 file changed, 35 insertions(+), 34 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/131f0b69/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 4e6293c..66e9985 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,31 @@ <!-- - Copyright (c) 2013 Yahoo! Inc. All Rights Reserved. + Copyright (c) 2013 Yahoo! Inc. All Rights Reserved. - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. See accompanying LICENSE file. + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. See accompanying LICENSE file. --> -[](https://travis-ci.org/yahoo/samoa) +[](https://travis-ci.org/apache/incubator-samoa) -SAMOA: Scalable Advanced Massive Online Analysis. +Apache SAMOA: Scalable Advanced Massive Online Analysis. ================= -SAMOA is a platform for mining on big data streams. +Apache SAMOA is a platform for mining on big data streams. It is a distributed streaming machine learning (ML) framework that contains a programing abstraction for distributed streaming ML algorithms. -SAMOA enables development of new ML algorithms without dealing with +Apache SAMOA enables development of new ML algorithms without dealing with the complexity of underlying streaming processing engines (SPE, such -as Apache Storm and Apache S4). SAMOA also provides extensibility in integrating -new SPEs into the framework. These features allow SAMOA users to develop +as Apache Storm and Apache S4). Apache SAMOA also provides extensibility in integrating +new SPEs into the framework. These features allow Apache SAMOA users to develop distributed streaming ML algorithms once and to execute the algorithms in multiple SPEs, i.e., code the algorithms once and execute them in multiple SPEs. @@ -34,24 +34,25 @@ in multiple SPEs, i.e., code the algorithms once and execute them in multiple SP ###Storm mode Simply clone the repository and install SAMOA. + ```bash -git clone [email protected]:yahoo/samoa.git -cd samoa +git clone http://git.apache.org/incubator-samoa.git +cd incubator-samoa mvn -Pstorm package ``` -The deployable jar for SAMOA will be in `target/SAMOA-Storm-0.0.1-SNAPSHOT.jar`. +The deployable jar for SAMOA will be in `target/SAMOA-Storm-0.3.0-SNAPSHOT.jar`. ###S4 mode If you want to compile SAMOA for S4, you will need to install the S4 dependencies -manually as explained in [Executing SAMOA with Apache S4](../../wiki/Executing-SAMOA-with-Apache-S4). +manually as explained in [Executing SAMOA with Apache S4](http://samoa.incubator.apache.org/documentation/Executing-SAMOA-with-Apache-S4.html). Once the dependencies if needed are installed, you can simply clone the repository and install SAMOA. ```bash -git clone [email protected]:yahoo/samoa.git -cd samoa +git clone http://git.apache.org/incubator-samoa.git +cd incubator-samoa mvn -Ps4 package ``` @@ -60,35 +61,35 @@ mvn -Ps4 package If you want to test SAMOA in a local environment, simply clone the repository and install SAMOA. ```bash -git clone [email protected]:yahoo/samoa.git -cd samoa +git clone http://git.apache.org/incubator-samoa.git +cd incubator-samoa mvn package ``` -The deployable jar for SAMOA will be in `target/SAMOA-Local-0.0.1-SNAPSHOT.jar`. +The deployable jar for SAMOA will be in `target/SAMOA-Local-0.3.0-SNAPSHOT.jar`. ## Documentation -The documentation is intended to give an introduction on how to use SAMOA in the various possible ways. +The documentation is intended to give an introduction on how to use Apache SAMOA in the various possible ways. As a user you can use it to develop new algorithms and test different Distributed Stream Processing Engines. -[Wiki Documentation](http://github.com/yahoo/samoa/wiki) +[Documentation](http://samoa.incubator.apache.org/documentation/Home.html) -[Javadoc](http://yahoo.github.io/samoa/docs/api) +[Javadoc](http://samoa.incubator.apache.org/docs/api/) ## Slides -[](https://speakerdeck.com/gdfm/samoa-a-platform-for-mining-big-data-streams) +[](https://speakerdeck.com/gdfm/samoa-a-platform-for-mining-big-data-streams) -G. De Francisci Morales [SAMOA: A Platform for Mining Big Data Streams](http://melmeric.files.wordpress.com/2013/04/samoa-a-platform-for-mining-big-data-streams.pdf) -Keynote Talk at [RAMSS â13](http://www.ramss.ws/2013/program/): 2nd International Workshop on Real-Time Analysis and Mining of Social Streams WWW, Rio De Janeiro, 2013. +G. De Francisci Morales, A. Bifet [SAMOA: Scalable Advanced Massive Online Analysis](http://jmlr.csail.mit.edu/papers/volume16/morales15a/morales15a.pdf) +Journal of Machine Learning Research, 16(Jan):149â153, 2015. -## SAMOA Developer's Guide +## Apache SAMOA Developer's Guide -<p><a href="http://yahoo.github.io/samoa/SAMOA-Developers-Guide-0-0-1.pdf";><img style="max-width:95%;border:3px solid black;" src="http://yahoo.github.io/samoa/Manual.png"; alt="SAMOA Developer's Guide" height="250"> </a></p> +<p><a href="http://samoa.incubator.apache.org/SAMOA-Developers-Guide-0-0-1.pdf";><img style="max-width:95%;border:3px solid black;" src="http://samoa.incubator.apache.org/Manual.png"; alt="SAMOA Developer's Guide" height="250"> </a></p> ## Contributors -[List of contributors to the SAMOA project](http://yahoo.github.io/samoa/contributors.html) +[List of contributors to the Apache SAMOA project](http://samoa.incubator.apache.org/documentation/Team.html) ## License
![http://yahoo.github.io/samoa/Manual.png"](http://yahoo.github.io/samoa/Manual.png"){kind=link}
![http://samoa.incubator.apache.org/Manual.png"](http://samoa.incubator.apache.org/Manual.png"){kind=link}