[PIO-135] Remove incubating status Git URLs still pending updates
Project: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/commit/e6ea7dd2 Tree: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/tree/e6ea7dd2 Diff: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/diff/e6ea7dd2 Branch: refs/heads/livedoc Commit: e6ea7dd2888564ae9b3242647cbf07af6287a3ee Parents: 6be4ab5 Author: Donald Szeto <[email protected]> Authored: Fri Oct 20 22:38:41 2017 -0700 Committer: Donald Szeto <[email protected]> Committed: Fri Oct 20 22:38:41 2017 -0700 ---------------------------------------------------------------------- CONTRIBUTING.md | 8 ++-- DISCLAIMER | 7 ---- Dockerfile | 2 +- LICENSE.txt | 2 +- NOTICE.txt | 2 +- PMC.md | 6 +-- README.md | 34 +++++++-------- RELEASE.md | 12 +++--- assembly/build.sbt | 2 +- build.sbt | 4 +- conf/pio-env.sh.template | 2 +- .../predictionio/controller/package.scala | 2 +- .../predictionio/workflow/WorkflowUtils.scala | 2 +- data/README.md | 2 +- docs/manual/bower.json | 11 ++--- docs/manual/config.rb | 10 +---- docs/manual/data/nav/main.yml | 6 +-- docs/manual/helpers/application_helpers.rb | 2 +- docs/manual/source/algorithm/index.html.md | 2 +- docs/manual/source/appintegration/index.html.md | 8 ++-- docs/manual/source/cli/index.html.md | 4 +- .../source/community/contribute-code.html.md | 42 +++++++++---------- .../community/contribute-documentation.html.md | 6 +-- .../source/community/contribute-sdk.html.md | 14 +++---- .../source/community/contribute-webhook.html.md | 12 +++--- docs/manual/source/community/index.html.md | 6 +-- docs/manual/source/community/projects.html.md | 2 +- docs/manual/source/customize/dase.html.md.erb | 24 +++++------ docs/manual/source/customize/index.html.md | 2 +- .../source/customize/troubleshooting.html.md | 8 ++-- .../datacollection/analytics-ipynb.html.md.erb | 4 +- .../analytics-zeppelin.html.md.erb | 4 +- .../source/datacollection/batchimport.html.md | 2 +- .../source/datacollection/eventapi.html.md | 10 ++--- .../datacollection/eventmodel.html.md.erb | 4 +- docs/manual/source/datacollection/index.html.md | 2 +- .../source/datacollection/webhooks.html.md.erb | 2 +- docs/manual/source/demo/community.html.md | 4 +- docs/manual/source/demo/index.html.md.erb | 4 +- docs/manual/source/demo/tapster.html.md | 44 ++++++++++---------- .../source/demo/textclassification.html.md.erb | 14 +++---- docs/manual/source/gallery/templates.yaml | 12 +++--- docs/manual/source/index.html.md.erb | 12 +++--- docs/manual/source/install/index.html.md.erb | 14 +++---- .../source/install/install-linux.html.md.erb | 12 +++--- .../install/install-sourcecode.html.md.erb | 8 ++-- .../source/install/install-vagrant.html.md.erb | 4 +- .../source/partials/_action_call.html.slim | 2 +- docs/manual/source/partials/_footer.html.slim | 15 +++---- docs/manual/source/partials/_header.html.slim | 4 +- .../shared/datacollection/_parquet.html.md.erb | 2 +- docs/manual/source/robots.txt | 2 +- docs/manual/source/sdk/java.html.md.erb | 2 +- docs/manual/source/sdk/php.html.md.erb | 2 +- docs/manual/source/sdk/ruby.html.md.erb | 2 +- docs/manual/source/support/index.html.md.erb | 12 +++--- docs/manual/source/tryit/index.html.slim | 2 +- docs/scaladoc/rootdoc.txt | 2 +- .../scala-parallel-classification/README.md | 2 +- .../README.md | 2 +- .../scala-parallel-recommendation/README.md | 2 +- .../scala-parallel-similarproduct/README.md | 2 +- tests/Dockerfile.base | 2 +- tests/README.md | 2 +- tests/docker-files/env-conf/pio-env.sh | 3 +- .../engines/recommendation-engine/README.md | 2 +- tests/pio_tests/scenarios/eventserver_test.py | 5 +-- tests/pio_tests/utils.py | 2 +- 68 files changed, 224 insertions(+), 249 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c90021a..b4217d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,14 +15,14 @@ See the License for the specific language governing permissions and limitations under the License. --> -Thank you for your interest in contributing to Apache PredictionIO (incubating). +Thank you for your interest in contributing to Apache PredictionIO. Our mission is to enable developers to build scalable machine learning applications easily. Here is how you can help with the project development. If you have any question regarding development at anytime, please free to subscribe and post to -the Development Mailing List <mailto:[email protected]>. +the Development Mailing List <mailto:[email protected]>. For code contribution, please follow guidelines at -http://predictionio.incubator.apache.org/community/contribute-code/. +http://predictionio.apache.org/community/contribute-code/. For documentation contribution, please follow guidelines at -http://predictionio.incubator.apache.org/community/contribute-documentation/. +http://predictionio.apache.org/community/contribute-documentation/. http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/DISCLAIMER ---------------------------------------------------------------------- diff --git a/DISCLAIMER b/DISCLAIMER deleted file mode 100644 index e433132..0000000 --- a/DISCLAIMER +++ /dev/null @@ -1,7 +0,0 @@ -Apache PredictionIO is an effort undergoing incubation at The Apache Software -Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of -all newly accepted projects until a further review indicates that the -infrastructure, communications, and decision making process have stabilized in a -manner consistent with other successful ASF projects. While incubation status is -not necessarily a reflection of the completeness or stability of the code, it -does indicate that the project has yet to be fully endorsed by the ASF. http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/Dockerfile ---------------------------------------------------------------------- diff --git a/Dockerfile b/Dockerfile index 2a7e9c2..23e409c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -18,7 +18,7 @@ # WARNING: THIS DOCKERFILE IS NOT INTENDED FOR PRODUCTION USE OR DEPLOYMENT. AT # THIS POINT, THIS IS ONLY INTENDED FOR USE IN AUTOMATED TESTS. IF YOU # ARE LOOKING TO DEPLOY PREDICTIONIO WITH DOCKER, PLEASE REFER TO -# http://predictionio.incubator.apache.org/community/projects/#docker-installation-for-predictionio +# http://predictionio.apache.org/community/projects/#docker-installation-for-predictionio FROM predictionio/pio-testing-base http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/LICENSE.txt ---------------------------------------------------------------------- diff --git a/LICENSE.txt b/LICENSE.txt index 37ee893..f29befc 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -205,7 +205,7 @@ ================================================================================ PredictionIO Subcomponents: -The Apache PredictionIO (incubating) project contains subcomponents with +The Apache PredictionIO project contains subcomponents with separate copyright notices and license terms. Your use of the source code for these subcomponents is subject to the terms and conditions of the following licenses. http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/NOTICE.txt ---------------------------------------------------------------------- diff --git a/NOTICE.txt b/NOTICE.txt index 5ca3335..04a03f3 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -1,4 +1,4 @@ -Apache PredictionIO (incubating) +Apache PredictionIO Copyright 2016 The Apache Software Foundation This product includes software developed at http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/PMC.md ---------------------------------------------------------------------- diff --git a/PMC.md b/PMC.md index 1a6eb06..06a8e87 100644 --- a/PMC.md +++ b/PMC.md @@ -27,7 +27,7 @@ signing key. 1. `git checkout -b release/0.11.0` 2. Replace all `0.11.0-SNAPSHOT` in the code tree to `0.11.0-incubating`. 3. `git commit -am "Prepare 0.11.0-incubating-rc1"` - 4. `git tag -am "Apache PredictionIO (incubating) 0.11.0-rc1" v0.11.0-incubating-rc1` + 4. `git tag -am "Apache PredictionIO 0.11.0-rc1" v0.11.0-incubating-rc1` 4. If you have not done so, use SVN to checkout https://dist.apache.org/repos/dist/dev/incubator/predictionio. This is the area for staging release candidates for voting. @@ -75,9 +75,9 @@ Nexus. 15. Send out e-mail for voting on PredictionIO dev mailing list. ``` - Subject: [VOTE] Apache PredictionIO (incubating) 0.11.0 Release (RC1) + Subject: [VOTE] Apache PredictionIO 0.11.0 Release (RC1) - This is the vote for 0.11.0 of Apache PredictionIO (incubating). + This is the vote for 0.11.0 of Apache PredictionIO. The vote will run for at least 72 hours and will close on Apr 7th, 2017. http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 73f5896..6fcccda 100644 --- a/README.md +++ b/README.md @@ -15,18 +15,18 @@ See the License for the specific language governing permissions and limitations under the License. --> -# [Apache PredictionIO (incubating)](http://predictionio.incubator.apache.org) +# [Apache PredictionIO](http://predictionio.apache.org) [](https://travis-ci.org/apache/incubator-predictionio) -Apache PredictionIO (incubating) is an open source machine learning framework +Apache PredictionIO is an open source machine learning framework for developers, data scientists, and end users. It supports event collection, deployment of algorithms, evaluation, querying predictive results via REST APIs. It is based on scalable open source services like Hadoop, HBase (and other DBs), Elasticsearch, Spark and implements what is called a Lambda Architecture. -To get started, check out http://predictionio.incubator.apache.org! +To get started, check out http://predictionio.apache.org! ## Table of contents @@ -42,23 +42,23 @@ To get started, check out http://predictionio.incubator.apache.org! A few installation options available. -* [Installing Apache PredictionIO (incubating) from Source - Code](http://predictionio.incubator.apache.org/install/install-sourcecode/) -* [Installing Apache PredictionIO (incubating) with - Docker](http://predictionio.incubator.apache.org/community/projects/#docker-installation-for-predictionio) +* [Installing Apache PredictionIO from Source + Code](http://predictionio.apache.org/install/install-sourcecode/) +* [Installing Apache PredictionIO with + Docker](http://predictionio.apache.org/community/projects/#docker-installation-for-predictionio) (community contributed) ## Quick Start * [Recommendation Engine Template Quick - Start](http://predictionio.incubator.apache.org/templates/recommendation/quickstart/) + Start](http://predictionio.apache.org/templates/recommendation/quickstart/) Guide * [Similiar Product Engine Template Quick - Start](http://predictionio.incubator.apache.org/templates/similarproduct/quickstart/) + Start](http://predictionio.apache.org/templates/similarproduct/quickstart/) Guide * [Classification Engine Template Quick - Start](http://predictionio.incubator.apache.org/templates/classification/quickstart/) + Start](http://predictionio.apache.org/templates/classification/quickstart/) Guide @@ -70,30 +70,30 @@ Use [Apache JIRA](https://issues.apache.org/jira/browse/PIO) to report bugs or r Documentation, included in this repo in the `docs/manual` directory, is built with [Middleman](http://middlemanapp.com/) and publicly hosted at -[predictionio.incubator.apache.org](http://predictionio.incubator.apache.org/). +[predictionio.apache.org](http://predictionio.apache.org/). Interested in helping with our documentation? Read [Contributing -Documentation](http://predictionio.incubator.apache.org/community/contribute-documentation/). +Documentation](http://predictionio.apache.org/community/contribute-documentation/). ## Community Keep track of development and community news. -* Subscribe to the user mailing list <mailto:[email protected]> - and the dev mailing list <mailto:[email protected]> +* Subscribe to the user mailing list <mailto:[email protected]> + and the dev mailing list <mailto:[email protected]> * Follow [@predictionio](https://twitter.com/predictionio) on Twitter. ## Contributing -Read the [Contribute Code](http://predictionio.incubator.apache.org/community/contribute-code/) page. +Read the [Contribute Code](http://predictionio.apache.org/community/contribute-code/) page. You can also list your projects on the [Community Project -page](http://predictionio.incubator.apache.org//community/projects/). +page](http://predictionio.apache.org//community/projects/). ## License -Apache PredictionIO (incubating) is under [Apache 2 +Apache PredictionIO is under [Apache 2 license](http://www.apache.org/licenses/LICENSE-2.0.html). http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/RELEASE.md ---------------------------------------------------------------------- diff --git a/RELEASE.md b/RELEASE.md index f94b3a6..2f396d1 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -17,7 +17,7 @@ limitations under the License. # Release Notes and News -**Note:** For upgrade instructions please refer to [this page](http://predictionio.incubator.apache.org/resources/upgrade/). +**Note:** For upgrade instructions please refer to [this page](http://predictionio.apache.org/resources/upgrade/). ## Version History @@ -128,7 +128,7 @@ Oct 7, 2016 - Make SSL optional - Merge ActionML fork - - First Apache PredictionIO (incubating) release + - First Apache PredictionIO release ### 0.9.7-aml (ActionML fork) @@ -198,7 +198,7 @@ Release Notes - Channels in the Event Server - Spark 1.3+ support (upgrade to Spark 1.3+ required) -- [Webhook Connector](http://predictionio.incubator.apache.org/community/contribute-webhook/) support +- [Webhook Connector](http://predictionio.apache.org/community/contribute-webhook/) support - Engine and Event Servers now by default bind to 0.0.0.0 - Many documentation improvements @@ -217,9 +217,9 @@ March 4th, 2015 Release Notes -- [E-Commerce Recommendation Template](http://predictionio.incubator.apache.org/gallery/template-gallery#recommender-systems) which includes 1) out-of-stock items support 2) new user recommendation 3) unseen items only -- [Complementary Purchase Template](http://predictionio.incubator.apache.org/gallery/template-gallery#unsupervised-learning) for shopping cart recommendation -- [Lead Scoring Template](http://predictionio.incubator.apache.org/gallery/template-gallery#classification) predicts the probability of an user will convert in the current session +- [E-Commerce Recommendation Template](http://predictionio.apache.org/gallery/template-gallery#recommender-systems) which includes 1) out-of-stock items support 2) new user recommendation 3) unseen items only +- [Complementary Purchase Template](http://predictionio.apache.org/gallery/template-gallery#unsupervised-learning) for shopping cart recommendation +- [Lead Scoring Template](http://predictionio.apache.org/gallery/template-gallery#classification) predicts the probability of an user will convert in the current session - `pio-start-all`, `pio-stop-all` commands to start and stop all PredictionIO related services ### 0.8.6 http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/assembly/build.sbt ---------------------------------------------------------------------- diff --git a/assembly/build.sbt b/assembly/build.sbt index 79fc3ab..c8080b6 100644 --- a/assembly/build.sbt +++ b/assembly/build.sbt @@ -33,7 +33,7 @@ version in Rpm := version.value.replace("-", "_") rpmRelease := "1" rpmVendor := "apache" rpmGroup := Some("Applications/System") -rpmUrl := Some("http://predictionio.incubator.apache.org/";) +rpmUrl := Some("http://predictionio.apache.org/";) rpmLicense := Some("Apache License Version 2.0") maintainerScripts in Rpm := maintainerScriptsAppendFromFile((maintainerScripts in Rpm).value)( http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/build.sbt ---------------------------------------------------------------------- diff --git a/build.sbt b/build.sbt index a02bdd9..c172aaa 100644 --- a/build.sbt +++ b/build.sbt @@ -266,7 +266,7 @@ pioUnidoc := { IO.read(baseDirectory.value / "docs" / "scaladoc" / "api-docs.js")) } -homepage := Some(url("http://predictionio.incubator.apache.org";)) +homepage := Some(url("http://predictionio.apache.org";)) pomExtra := { <parent> @@ -283,7 +283,7 @@ pomExtra := { <developer> <id>donald</id> <name>Donald Szeto</name> - <url>http://predictionio.incubator.apache.org</url> + <url>http://predictionio.apache.org</url> <email>[email protected]</email> </developer> </developers> http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/conf/pio-env.sh.template ---------------------------------------------------------------------- diff --git a/conf/pio-env.sh.template b/conf/pio-env.sh.template index a96e4bd..16ebcd3 100644 --- a/conf/pio-env.sh.template +++ b/conf/pio-env.sh.template @@ -53,7 +53,7 @@ PIO_FS_TMPDIR=$PIO_FS_BASEDIR/tmp # storage facilities. Default values are shown below. # # For more information on storage configuration please refer to -# http://predictionio.incubator.apache.org/system/anotherdatastore/ +# http://predictionio.apache.org/system/anotherdatastore/ # Storage Repositories http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/core/src/main/scala/org/apache/predictionio/controller/package.scala ---------------------------------------------------------------------- diff --git a/core/src/main/scala/org/apache/predictionio/controller/package.scala b/core/src/main/scala/org/apache/predictionio/controller/package.scala index 88d55b2..0c88fe6 100644 --- a/core/src/main/scala/org/apache/predictionio/controller/package.scala +++ b/core/src/main/scala/org/apache/predictionio/controller/package.scala @@ -26,7 +26,7 @@ package org.apache.predictionio * * == The DASE Paradigm == * The building blocks together form the DASE paradigm. Learn more about DASE - * [[http://predictionio.incubator.apache.org/customize/ here]]. + * [[http://predictionio.apache.org/customize/ here]]. * * == Types of Building Blocks == * Depending on the problem you are solving, you would need to pick appropriate http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/core/src/main/scala/org/apache/predictionio/workflow/WorkflowUtils.scala ---------------------------------------------------------------------- diff --git a/core/src/main/scala/org/apache/predictionio/workflow/WorkflowUtils.scala b/core/src/main/scala/org/apache/predictionio/workflow/WorkflowUtils.scala index 9a75415..bc1dbef 100644 --- a/core/src/main/scala/org/apache/predictionio/workflow/WorkflowUtils.scala +++ b/core/src/main/scala/org/apache/predictionio/workflow/WorkflowUtils.scala @@ -292,7 +292,7 @@ object WorkflowUtils extends Logging { "Since 0.8.4, the 'params' field is required in engine.json" + " in order to specify parameters for DataSource, Preparator or" + " Serving.\n" + - "Please go to http://predictionio.incubator.apache.org/resources/upgrade/"; + + "Please go to http://predictionio.apache.org/resources/upgrade/"; + " for detailed instruction of how to change engine.json.") sys.exit(1) } http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/data/README.md ---------------------------------------------------------------------- diff --git a/data/README.md b/data/README.md index 4d46e99..5f31197 100644 --- a/data/README.md +++ b/data/README.md @@ -17,7 +17,7 @@ limitations under the License. ## Data Collection API -Please refer to the documentation site - [Collecting Data through REST/SDKs](http://predictionio.incubator.apache.org/datacollection/eventapi/). +Please refer to the documentation site - [Collecting Data through REST/SDKs](http://predictionio.apache.org/datacollection/eventapi/). ## For Development Use only: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/bower.json ---------------------------------------------------------------------- diff --git a/docs/manual/bower.json b/docs/manual/bower.json index 8b2564e..f8bab3b 100644 --- a/docs/manual/bower.json +++ b/docs/manual/bower.json @@ -1,13 +1,8 @@ { - "name": "predictionio.incubator.apache.org", - "version": "2.0.0", - "authors": [ - "David Singer <[email protected]>", - "Donald Szeto <[email protected]>" - ], - "description": "Apache PredictionIO (incubating) Documentation", + "name": "predictionio.apache.org", + "description": "Apache PredictionIO Documentation", "license": "Apache-2.0", - "homepage": "predictionio.incubator.apache.org", + "homepage": "predictionio.apache.org", "ignore": [ "**/.*", "node_modules", http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/config.rb ---------------------------------------------------------------------- diff --git a/docs/manual/config.rb b/docs/manual/config.rb index 74628f0..26d4b65 100644 --- a/docs/manual/config.rb +++ b/docs/manual/config.rb @@ -46,7 +46,7 @@ set :markdown, sprockets.append_path File.join root, 'bower_components' # Sitemap -set :url_root, '//predictionio.incubator.apache.org' +set :url_root, '//predictionio.apache.org' activate :search_engine_sitemap, exclude_attr: 'hidden' # Development Settings @@ -61,7 +61,7 @@ end # Build Settings configure :build do set :scheme, 'https' - set :host, 'predictionio.incubator.apache.org' + set :host, 'predictionio.apache.org' set :port, 80 Slim::Engine.set_options pretty: false, sort_attrs: false activate :asset_hash @@ -86,12 +86,6 @@ configure :build do end end -# S3 Sync -activate :s3_sync do |s3_sync| - s3_sync.bucket = 'predictionio.incubator.apache.org' - s3_sync.prefer_gzip = false -end - # Hacks # Engine Template Gallery generation http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/data/nav/main.yml ---------------------------------------------------------------------- diff --git a/docs/manual/data/nav/main.yml b/docs/manual/data/nav/main.yml index aa9ce58..6973e39 100644 --- a/docs/manual/data/nav/main.yml +++ b/docs/manual/data/nav/main.yml @@ -1,10 +1,10 @@ root: - - body: 'Apache PredictionIO⢠(incubating) Documentation' + body: 'Apache PredictionIO⢠Documentation' url: '/' children: - - body: 'Welcome to Apache PredictionIO (incubating)' + body: 'Welcome to Apache PredictionIO' url: '/' - body: 'Getting Started' @@ -14,7 +14,7 @@ root: body: 'A Quick Intro' url: '/start/' - - body: 'Installing Apache PredictionIO (incubating)' + body: 'Installing Apache PredictionIO' url: '/install/' - body: 'Downloading an Engine Template' http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/helpers/application_helpers.rb ---------------------------------------------------------------------- diff --git a/docs/manual/helpers/application_helpers.rb b/docs/manual/helpers/application_helpers.rb index c606536..67d0b3a 100644 --- a/docs/manual/helpers/application_helpers.rb +++ b/docs/manual/helpers/application_helpers.rb @@ -71,7 +71,7 @@ module ApplicationHelpers return current_page.data.title end else - return "Welcome to Apache PredictionIO (incubating) Documentation!" + return "Welcome to Apache PredictionIO Documentation!" end end http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/algorithm/index.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/algorithm/index.html.md b/docs/manual/source/algorithm/index.html.md index 49163a3..925708b 100644 --- a/docs/manual/source/algorithm/index.html.md +++ b/docs/manual/source/algorithm/index.html.md @@ -20,7 +20,7 @@ limitations under the License. --> An engine can virtually call any algorithm in the Algorithm class. Apache -PredictionIO (incubating) currently offers native support to [Spark +PredictionIO currently offers native support to [Spark MLlib](http://spark.apache.org/docs/latest/mllib-guide.html) machine learning library. It is being used by some of the engine templates in the [template gallery](/gallery/template-gallery). http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/appintegration/index.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/appintegration/index.html.md b/docs/manual/source/appintegration/index.html.md index e22aff8..a087318 100644 --- a/docs/manual/source/appintegration/index.html.md +++ b/docs/manual/source/appintegration/index.html.md @@ -19,21 +19,21 @@ See the License for the specific language governing permissions and limitations under the License. --> -Apache PredictionIO (incubating) is designed as a machine learning server that +Apache PredictionIO is designed as a machine learning server that integrates with your applications on production environments. A web or mobile app normally: -1. Send event data to Apache PredictionIO (incubating)'s Event Server for model +1. Send event data to Apache PredictionIO's Event Server for model training 2. Send dynamic queries to deployed engine(s) to retrieve predicted results - ## Sending Event Data -Apache PredictionIO (incubating)'s Event Server receives event data from your +Apache PredictionIO's Event Server receives event data from your application. The data can be used by engines as training data to build preditive models. http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/cli/index.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/cli/index.html.md b/docs/manual/source/cli/index.html.md index 3735348..2c74282 100644 --- a/docs/manual/source/cli/index.html.md +++ b/docs/manual/source/cli/index.html.md @@ -21,7 +21,7 @@ limitations under the License. ##Overview -Interaction with Apache PredictionIO (incubating) is done through the command +Interaction with Apache PredictionIO is done through the command line interface. It follows the format of: ```pio <command> [options] <args>...``` @@ -29,7 +29,7 @@ line interface. It follows the format of: You can run ```pio help``` to see a list of all available commands and ```pio help <command>``` to see details of the command. -Apache PredictionIO (incubating) commands can be separated into the following +Apache PredictionIO commands can be separated into the following three categories. ##General Commands http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/community/contribute-code.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/community/contribute-code.html.md b/docs/manual/source/community/contribute-code.html.md index d295427..7bce756 100644 --- a/docs/manual/source/community/contribute-code.html.md +++ b/docs/manual/source/community/contribute-code.html.md @@ -19,13 +19,13 @@ See the License for the specific language governing permissions and limitations under the License. --> -Thank you for your interest in contributing to Apache PredictionIO (incubating). +Thank you for your interest in contributing to Apache PredictionIO. Our mission is to enable developers to build scalable machine learning applications easily. Here is how you can help with the project development. If you have any question regarding development at anytime, please free to -[subscribe](mailto:[email protected]) and post to +[subscribe](mailto:[email protected]) and post to the [Development Mailing -List](mailto:[email protected]). +List](mailto:[email protected]). ## Areas in Need of Help @@ -55,15 +55,15 @@ bug fixes will follow a different path. Before adding new features into JIRA, please check that the feature does not currently exist in JIRA. 1. To propose a new feature, simply - [subscribe](mailto:[email protected]) and post - your proposal to [Apache PredictionIO (incubating) Development Mailing List] - (mailto:[email protected]). + [subscribe](mailto:[email protected]) and post + your proposal to [Apache PredictionIO Development Mailing List] + (mailto:[email protected]). 2. Discuss with the community and the core development team on what needs to be done, and lay down concrete plans on deliverables. 3. Once solid plans are made, start creating tickets in the [issue tracker] (https://issues.apache.org/jira/browse/PIO). 4. Work side by side with other developers using Apache PredictionIO - (incubating) Development Mailing List as primary mode of communication. You + Development Mailing List as primary mode of communication. You never know if someone else has a better idea. ;) ### Adding ticket to JIRA @@ -113,18 +113,18 @@ information. ## Getting Started -Apache PredictionIO (incubating) relies heavily on the [git flow methodology]( +Apache PredictionIO relies heavily on the [git flow methodology]( http://nvie.com/posts/a-successful-git-branching-model/). Please make sure you read and understand it before you start your development. By default, cloning -Apache PredictionIO (incubating) will put you in the *develop* branch, which in +Apache PredictionIO will put you in the *develop* branch, which in most cases is where all the latest development go to. NOTE: For core development, please follow the [Scala Style Guide](http://docs.scala-lang.org/style/). -### Create a Fork of the Apache PredictionIO (incubating) Repository +### Create a Fork of the Apache PredictionIO Repository 1. Start by creating a GitHub account if you do not already have one. -2. Go to [Apache PredictionIO (incubating)âs GitHub +2. Go to [Apache PredictionIOâs GitHub mirror](https://github.com/PredictionIO/PredictionIO) and fork it to your own account. 3. Clone your fork to your local machine. @@ -132,7 +132,7 @@ NOTE: For core development, please follow the [Scala Style Guide](http://docs.sc If you need additional help, please refer to https://help.github.com/articles/fork-a-repo/. -### Building Apache PredictionIO (incubating) from Source +### Building Apache PredictionIO from Source After the previous section, you should have a copy of Apache PredictionIO (incubating) in your local machine ready to be built. @@ -144,16 +144,16 @@ After the previous section, you should have a copy of Apache PredictionIO ### Setting Up the Environment -Apache PredictionIO (incubating) relies on 3rd party software to perform its +Apache PredictionIO relies on 3rd party software to perform its tasks. To set them up, simply follow this [documentation]( -http://predictionio.incubator.apache.org/install/install-sourcecode/#installing-dependencies). +http://predictionio.apache.org/install/install-sourcecode/#installing-dependencies). ### Start Hacking -You should have a Apache PredictionIO (incubating) development environment by +You should have a Apache PredictionIO development environment by now. Happy hacking! -## Anatomy of Apache PredictionIO (incubating) Code Tree +## Anatomy of Apache PredictionIO Code Tree The following describes each directoryâs purpose. @@ -168,22 +168,22 @@ Configuration files that are used by both a source tree and binary distribution. ### core -Core Apache PredictionIO (incubating) code that provides the DASE controller +Core Apache PredictionIO code that provides the DASE controller API, core data structures, and workflow creation and management code. ### data -Apache PredictionIO (incubating) Event Server, and backend-agnostic storage +Apache PredictionIO Event Server, and backend-agnostic storage layer for event store and metadata store. ### docs -Source code for http://predictionio.incubator.apache.org site, and any other +Source code for http://predictionio.apache.org site, and any other documentation support files. ### examples -Complete code examples showing Apache PredictionIO (incubating)'s application. +Complete code examples showing Apache PredictionIO's application. ### sbt @@ -195,6 +195,6 @@ Storage implementations. ### tools -Tools for running Apache PredictionIO (incubating). Contains primarily the CLI +Tools for running Apache PredictionIO. Contains primarily the CLI (command-line interface) and its supporting code, and the experimental evaluation dashboard. http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/community/contribute-documentation.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/community/contribute-documentation.html.md b/docs/manual/source/community/contribute-documentation.html.md index aac0403..b06fd69 100644 --- a/docs/manual/source/community/contribute-documentation.html.md +++ b/docs/manual/source/community/contribute-documentation.html.md @@ -21,7 +21,7 @@ limitations under the License. ## How to Write Documentation -You can help improve the Apache PredictionIO (incubating) documentation by +You can help improve the Apache PredictionIO documentation by submitting tutorials, writing how-tos, fixing errors, and adding missing information. You can edit any page live on [GitHub](https://github.com/apache/incubator-predictionio) by clicking the @@ -37,7 +37,7 @@ release. ## Installing Locally -Apache PredictionIO (incubating) documentation uses +Apache PredictionIO documentation uses [Middleman](http://middlemanapp.com/) and is hosted on Apache. [Gems](http://rubygems.org/) are managed with [Bundler](http://bundler.io/). @@ -190,7 +190,7 @@ NOTE: Files must end with a `.erb` extension to be processed as ERB. ## Going Live For Apache project committers, pushing to the `livedoc` branch of PredictionIO ASF git will update -http://predictionio.incubator.apache.org in about 10 minutes. +http://predictionio.apache.org in about 10 minutes. Make sure the **apache.org** remote is attached to your `incubator-predictionio` repo, and if not, add it: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/community/contribute-sdk.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/community/contribute-sdk.html.md b/docs/manual/source/community/contribute-sdk.html.md index a4a6fc0..e0011a6 100644 --- a/docs/manual/source/community/contribute-sdk.html.md +++ b/docs/manual/source/community/contribute-sdk.html.md @@ -20,13 +20,13 @@ limitations under the License. --> A SDK should provide convenient methods for client applications to easily -record users' behaviors in Apache PredictionIO (incubating)'s Event Server and +record users' behaviors in Apache PredictionIO's Event Server and also query recommendations from the ML Engines. Therefore, a SDK typically has 2 corresponding clients: `Event Client` and `Engine Client`. The following guideline bases on the REST API provided by Apache PredictionIO (incubating)'s Event Client which details can be found -[here](http://predictionio.incubator.apache.org/datacollection/eventapi/). +[here](http://predictionio.apache.org/datacollection/eventapi/). ## Event Client Because the Event Server has only 1 connection point, the `Event Client` @@ -37,7 +37,7 @@ following rules. (e.g. http://localhost:7070/events.json?accessKey=1234567890) - **Request**: `POST` + JSON data. Please refer to the [Event Creation API] -(http://predictionio.incubator.apache.org/datacollection/eventapi/) for the details +(http://predictionio.apache.org/datacollection/eventapi/) for the details on the fields of the JSON data object. - **Response**: @@ -134,7 +134,7 @@ support the following 7 shorthand operations: ``` Again, please refer to the [API documentation] -(http://predictionio.incubator.apache.org/datacollection/eventapi/) for explanations +(http://predictionio.apache.org/datacollection/eventapi/) for explanations on the reversed events like `$set`, `$unset` or `$delete`. INFO: The `eventTime` is optional but it is recommended that the client @@ -145,7 +145,7 @@ sending the event to the server. ## Engine Client `Engine Client`'s main job is to retrieve recommendation or prediction results -from Apache PredictionIO (incubating)'s Engines. It has only a few rules on the +from Apache PredictionIO's Engines. It has only a few rules on the request and response type. - **URL**: `<base URL>/queries.json` (e.g. http://localhost:8000/queries.json) @@ -180,7 +180,7 @@ request and response type. + **Failure**: status code `400` e.g. fail to parse the query. The formats of JSON objects in both the request and response must be defined by -the Apache PredictionIO (incubating)'s Engine and are different across +the Apache PredictionIO's Engine and are different across applications. The above examples are taken from the Recommendation Engine template in which the query and prediction results are defined as following. @@ -197,7 +197,7 @@ case class PredictedResult( ## Testing Your SDK -You can set up a local host Apache PredictionIO (incubating) environment to test +You can set up a local host Apache PredictionIO environment to test your SDK. However, it is hard to set it up online to test your SDK automatically using services like Travis CI. In that case, you should consider using these lightweight [mock servers] http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/community/contribute-webhook.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/community/contribute-webhook.html.md b/docs/manual/source/community/contribute-webhook.html.md index 6eb70bc..774adbe 100644 --- a/docs/manual/source/community/contribute-webhook.html.md +++ b/docs/manual/source/community/contribute-webhook.html.md @@ -180,9 +180,9 @@ private[predictionio] object ExampleJsonConnector extends JsonConnector { ``` You can find the complete example in [the GitHub -repo](https://github.com/apache/incubator-predictionio/blob/develop/data/src/main/scala/io/prediction/data/webhooks/examplejson/ExampleJsonConnector.scala) +repo](https://github.com/apache/incubator-predictionio/blob/develop/data/src/main/scala/org/apache/predictionio/data/webhooks/examplejson/ExampleJsonConnector.scala) and how to write [tests for the -connector](https://github.com/apache/incubator-predictionio/blob/develop/data/src/test/scala/io/prediction/data/webhooks/examplejson/ExampleJsonConnectorSpec.scala). +connector](https://github.com/apache/incubator-predictionio/blob/develop/data/src/test/scala/org/apache/predictionio/data/webhooks/examplejson/ExampleJsonConnectorSpec.scala). Please put the connector code in a separate directory for each site. For example, code for segmentio connector should be in @@ -198,9 +198,9 @@ data/src/test/scala/org.apache.predictionio/data/webhooks/segmentio/ ``` **For form-submission data**, you can find the comple example [the GitHub -repo](https://github.com/apache/incubator-predictionio/blob/develop/data/src/main/scala/io/prediction/data/webhooks/exampleform/ExampleFormConnector.scala) +repo](https://github.com/apache/incubator-predictionio/blob/develop/data/src/main/scala/org/apache/predictionio/data/webhooks/exampleform/ExampleFormConnector.scala) and how to write [tests for the -connector](https://github.com/apache/incubator-predictionio/blob/develop/data/src/test/scala/io/prediction/data/webhooks/exampleform/ExampleFormConnectorSpec.scala). +connector](https://github.com/apache/incubator-predictionio/blob/develop/data/src/test/scala/org/apache/predictionio/data/webhooks/exampleform/ExampleFormConnectorSpec.scala). ## 2. Integrate the Connector into Event Server @@ -208,7 +208,7 @@ connector](https://github.com/apache/incubator-predictionio/blob/develop/data/sr Once we have the connector implemented, we can add this to the EventServer so we can collect real-time data. Add the connector to [`WebhooksConnectors` object]( -https://github.com/apache/incubator-predictionio/blob/develop/data/src/main/scala/io/prediction/data/api/WebhooksConnectors.scala): +https://github.com/apache/incubator-predictionio/blob/develop/data/src/main/scala/org/apache/predictionio/data/api/WebhooksConnectors.scala): ```scala @@ -242,6 +242,6 @@ For `FormConnector`, the URL doesn't have `.json`. For example, http://<EVENT SERVER URL>/webhooks/mailchimp?accessKey=<YOUR_ACCESS_KEY>&channel=<CHANNEL_NAME> ``` -That's it. Once you re-compile Apache PredictionIO (incubating), you can send +That's it. Once you re-compile Apache PredictionIO, you can send the ExampleJson data to the following URL and the data will be stored to the App of the corresponding Access Key. http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/community/index.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/community/index.html.md b/docs/manual/source/community/index.html.md index 5d48ef9..3af182f 100644 --- a/docs/manual/source/community/index.html.md +++ b/docs/manual/source/community/index.html.md @@ -21,13 +21,13 @@ limitations under the License. ## User Mailing List -This list is for users of Apache PredictionIO (incubating) to ask questions, +This list is for users of Apache PredictionIO to ask questions, share knowledge, and discuss issues. Do send mail to this list with usage and configuration questions and problems. Also, please send questions to this list to verify your problem before filing issues in JIRA. -[Subscribe](mailto:[email protected]) to our User Mailing List. -[Unsubscribe](mailto:[email protected]) from our User Mailing List. +[Subscribe](mailto:[email protected]) to our User Mailing List. +[Unsubscribe](mailto:[email protected]) from our User Mailing List. ## Twitter http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/community/projects.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/community/projects.html.md b/docs/manual/source/community/projects.html.md index 00f88a9..7c35dbf 100644 --- a/docs/manual/source/community/projects.html.md +++ b/docs/manual/source/community/projects.html.md @@ -22,7 +22,7 @@ limitations under the License. Here you will find great projects contributed by the Apache PredictionIO (incubating) community. Stay tuned. -INFO: If you have built a Apache PredictionIO (incubating)-related project, we +INFO: If you have built a Apache PredictionIO-related project, we would love to showcase it to the community! Simply edit [this page](https://github.com/apache/incubator-predictionio/blob/livedoc/docs/manual/source/community/projects.html.md) and submit a pull request. http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/customize/dase.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/manual/source/customize/dase.html.md.erb b/docs/manual/source/customize/dase.html.md.erb index 89c75ea..c06d86c 100644 --- a/docs/manual/source/customize/dase.html.md.erb +++ b/docs/manual/source/customize/dase.html.md.erb @@ -27,7 +27,7 @@ DataSource reads and selects useful data from the Event Store (data store of the ## readTraining() -You need to implment readTraining() of [PDataSource](https://predictionio.incubator.apache.org/api/current/#org.apache.predictionio.controller.PDataSource), where you can use the [PEventStore Engine API](https://predictionio.incubator.apache.org/api/current/#org.apache.predictionio.data.store.PEventStore$) to read the events and create the TrainingData based on the events. +You need to implment readTraining() of [PDataSource](https://predictionio.apache.org/api/current/#org.apache.predictionio.controller.PDataSource), where you can use the [PEventStore Engine API](https://predictionio.apache.org/api/current/#org.apache.predictionio.data.store.PEventStore$) to read the events and create the TrainingData based on the events. The following code example reads user "view" and "buy" item events, filters specific type of events for future processing and returns TrainingData accordingly. @@ -64,9 +64,9 @@ class DataSource(val dsp: DataSourceParams) ## Using PEventStore Engine API -Please see [Event Server Overview](https://predictionio.incubator.apache.org/datacollection/) to understand [EventAPI](https://predictionio.incubator.apache.org/datacollection/eventapi/) and [event modeling](https://predictionio.incubator.apache.org/datacollection/eventmodel/). +Please see [Event Server Overview](https://predictionio.apache.org/datacollection/) to understand [EventAPI](https://predictionio.apache.org/datacollection/eventapi/) and [event modeling](https://predictionio.apache.org/datacollection/eventmodel/). -With [PEventStore Engine API](https://predictionio.incubator.apache.org/api/current/#org.apache.predictionio.data.store.PEventStore$), you can easily read different events in DataSource and get the information you need. +With [PEventStore Engine API](https://predictionio.apache.org/api/current/#org.apache.predictionio.data.store.PEventStore$), you can easily read different events in DataSource and get the information you need. For example, let's say you have events like the following: @@ -117,7 +117,7 @@ Then following code could read these events and extract the properties field of If you have used special events `$set/$unset/$delete` setting entity's properties, you can retrieve it with `PEventStore.aggregateProperties()`. -Please see [event modeling](https://predictionio.incubator.apache.org/datacollection/eventmodel/) to understand usage of special `$set/$unset/$delete` events. +Please see [event modeling](https://predictionio.apache.org/datacollection/eventmodel/) to understand usage of special `$set/$unset/$delete` events. For example, the following code show how you could retrieve properties of the "item" entities: @@ -163,7 +163,7 @@ A few example usages of Preparator: ## prepare() -You need to implement the `prepare()` method of [PPrepartor](https://predictionio.incubator.apache.org/api/current/#org.apache.predictionio.controller.PPreparator) to perform such tasks. +You need to implement the `prepare()` method of [PPrepartor](https://predictionio.apache.org/api/current/#org.apache.predictionio.controller.PPreparator) to perform such tasks. Example: @@ -177,21 +177,21 @@ The two methods of the Algorithm class are train() and predict(): ## train() train() is responsible for training a predictive model. It is called when you -run `pio train`. Apache PredictionIO (incubating) will store this model. +run `pio train`. Apache PredictionIO will store this model. ## predict() predict() is responsible for using this model to make prediction. It is called when you send a JSON query to the engine. Note that predict() is called in real time. -Apache PredictionIO (incubating) supports two types of algorithms: +Apache PredictionIO supports two types of algorithms: -- **[P2LAlgorithm](https://predictionio.incubator.apache.org/api/current/#org.apache.predictionio.controller.P2LAlgorithm)**: trains a Model which does not contain RDD -- **[PAlgorithm](https://predictionio.incubator.apache.org/api/current/#org.apache.predictionio.controller.PAlgorithm)**: trains a Model which contains RDD +- **[P2LAlgorithm](https://predictionio.apache.org/api/current/#org.apache.predictionio.controller.P2LAlgorithm)**: trains a Model which does not contain RDD +- **[PAlgorithm](https://predictionio.apache.org/api/current/#org.apache.predictionio.controller.PAlgorithm)**: trains a Model which contains RDD ## P2LAlgorithm For `P2LAlgorithm`, the Model is automatically serialized and persisted by -Apache PredictionIO (incubating) after training. +Apache PredictionIO after training. Implementing `IPersistentModel` and `IPersistentModelLoader` is optional for P2LAlgorithm. @@ -213,7 +213,7 @@ Example: ## using LEventStore Engine API in predict() -You may use [LEventStore.findByEntity()](https://predictionio.incubator.apache.org/api/current/#org.apache.predictionio.data.store.LEventStore$) to retrieve events of a specific entity. For example, retrieve recent events of the user specified in the query) and use these recent events to make prediction in real time. +You may use [LEventStore.findByEntity()](https://predictionio.apache.org/api/current/#org.apache.predictionio.data.store.LEventStore$) to retrieve events of a specific entity. For example, retrieve recent events of the user specified in the query) and use these recent events to make prediction in real time. For example, the following code reads the recent 10 view events of `query.user`: @@ -253,7 +253,7 @@ Example: ## serve() -You need to implement the serve() method of the class [LServing](https://predictionio.incubator.apache.org/api/current/#org.apache.predictionio.controller.LServing). The serve() method processes predicted result. It is also responsible for combining multiple predicted results into one if you have more than one predictive model. +You need to implement the serve() method of the class [LServing](https://predictionio.apache.org/api/current/#org.apache.predictionio.controller.LServing). The serve() method processes predicted result. It is also responsible for combining multiple predicted results into one if you have more than one predictive model. Example: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/customize/index.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/customize/index.html.md b/docs/manual/source/customize/index.html.md index 5f36ddb..3fd26f7 100644 --- a/docs/manual/source/customize/index.html.md +++ b/docs/manual/source/customize/index.html.md @@ -44,7 +44,7 @@ customize the final returned results. An Evaluation Metric quantifies prediction accuracy with a numerical score. It can be used for comparing algorithms or algorithm parameter settings. -> Apache PredictionIO (incubating) helps you modularize these components so you +> Apache PredictionIO helps you modularize these components so you can build, for example, several Serving components for an Engine. You will be able to choose which one to be deployed when you create an Engine. http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/customize/troubleshooting.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/customize/troubleshooting.html.md b/docs/manual/source/customize/troubleshooting.html.md index 68717ba..4d18835 100644 --- a/docs/manual/source/customize/troubleshooting.html.md +++ b/docs/manual/source/customize/troubleshooting.html.md @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -Apache PredictionIO (incubating) provides the following features to help you +Apache PredictionIO provides the following features to help you debug engines during development cycle. ## Stop Training between Stages @@ -134,8 +134,8 @@ After run `pio deploy`, you can access the engine status page by go to same URL ## pio-shell -Apache PredictionIO (incubating) also provides `pio-shell` in which you can -easily access Apache PredictionIO (incubating) API, Spark context and Spark API +Apache PredictionIO also provides `pio-shell` in which you can +easily access Apache PredictionIO API, Spark context and Spark API for quickly testing code or debugging purposes. To bring up the shell, simply run: @@ -145,7 +145,7 @@ $ pio-shell --with-spark ``` (`pio-shell` is available inside `bin/` directory of installed Apache -PredictionIO (incubating) directory, you should be able to access it if you have +PredictionIO directory, you should be able to access it if you have added PredictionIO/bin into your environment variable `PATH`) Note that the Spark context is available as variable `sc` inside the shell. http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/datacollection/analytics-ipynb.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/manual/source/datacollection/analytics-ipynb.html.md.erb b/docs/manual/source/datacollection/analytics-ipynb.html.md.erb index a843cbd..b6168a0 100644 --- a/docs/manual/source/datacollection/analytics-ipynb.html.md.erb +++ b/docs/manual/source/datacollection/analytics-ipynb.html.md.erb @@ -21,7 +21,7 @@ limitations under the License. [IPython Notebook](http://ipython.org/notebook.html) is a very powerful interactive computational environment, and with -[Apache PredictionIO (incubating)](http://predictionio.incubator.apache.org), +[Apache PredictionIO](http://predictionio.apache.org), [PySpark](http://spark.apache.org/docs/latest/api/python/) and [Spark SQL](https://spark.apache.org/sql/), you can easily analyze your collected events when you are developing or tuning your engine. @@ -48,7 +48,7 @@ If you see a error appearing in the console like this: [E 10:07:53.901 NotebookApp] Please use `%pylab inline` or `%matplotlib inline` in the notebook itself. ``` -Then you can use the following command. +Then you can use the following command. ``` PYSPARK_DRIVER_PYTHON=ipython PYSPARK_DRIVER_PYTHON_OPTS="notebook --`%pylab inline`" $SPARK_HOME/bin/pyspark http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/datacollection/analytics-zeppelin.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/manual/source/datacollection/analytics-zeppelin.html.md.erb b/docs/manual/source/datacollection/analytics-zeppelin.html.md.erb index 1d6e39c..42306f2 100644 --- a/docs/manual/source/datacollection/analytics-zeppelin.html.md.erb +++ b/docs/manual/source/datacollection/analytics-zeppelin.html.md.erb @@ -21,7 +21,7 @@ limitations under the License. [Apache Zeppelin](http://zeppelin-project.org/) is an interactive computational environment built on Apache Spark like the IPython Notebook. With [Apache -PredictionIO (incubating)](http://predictionio.incubator.apache.org) and [Spark +PredictionIO](http://predictionio.apache.org) and [Spark SQL](https://spark.apache.org/sql/), you can easily analyze your collected events when you are developing or tuning your engine. @@ -29,7 +29,7 @@ events when you are developing or tuning your engine. The following instructions assume that you have the command `sbt` accessible in your shell's search path. Alternatively, you can use the `sbt` command that -comes with Apache PredictionIO (incubating) at `$PIO_HOME/sbt/sbt`. +comes with Apache PredictionIO at `$PIO_HOME/sbt/sbt`. <%= partial 'shared/datacollection/parquet' %> http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/datacollection/batchimport.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/datacollection/batchimport.html.md b/docs/manual/source/datacollection/batchimport.html.md index cb81812..d7cd26a 100644 --- a/docs/manual/source/datacollection/batchimport.html.md +++ b/docs/manual/source/datacollection/batchimport.html.md @@ -46,7 +46,7 @@ import. ## Use SDK to Prepare Batch Input File -Some of the Apache PredictionIO (incubating) SDKs also provides FileExporter +Some of the Apache PredictionIO SDKs also provides FileExporter client. You may use them to prepare the JSON file as described above. The FileExporter creates event in the same way as EventClient except that the events are written to a JSON file instead of being sent to EventSever. The written JSON http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/datacollection/eventapi.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/datacollection/eventapi.html.md b/docs/manual/source/datacollection/eventapi.html.md index 98a4d64..e71fbda 100644 --- a/docs/manual/source/datacollection/eventapi.html.md +++ b/docs/manual/source/datacollection/eventapi.html.md @@ -24,10 +24,10 @@ limitations under the License. application can send data to it through its **Event API** with HTTP requests or with `EventClient`s of PredictionIO's SDKs. -INFO: All Apache PredictionIO (incubating)-compliant engines support accessing +INFO: All Apache PredictionIO-compliant engines support accessing the Event Store (i.e. the data store of Event Server) through [Apache -PredictionIO (incubating)'s Storage -API](http://predictionio.incubator.apache.org/api/current/index.html#org.apache.predictionio.data.storage.package). +PredictionIO's Storage +API](http://predictionio.apache.org/api/current/index.html#org.apache.predictionio.data.storage.package). ## Launching the Event Server @@ -39,7 +39,7 @@ than 30 seconds) after HBase is started for its initialization to complete before starting the Event Server. -Everything about Apache PredictionIO (incubating) can be done through the `pio` +Everything about Apache PredictionIO can be done through the `pio` command. Please add PIO binary command path to to your `PATH` first. Assuming PredictionIO is installed at `/home/yourname/PredictionIO/`, you can run @@ -99,7 +99,7 @@ to use the Event API. You should see something like the following output: ### Creating Your First Event You may connect to the Event Server with HTTP request or by using one of many -**Apache PredictionIO (incubating) SDKs**. +**Apache PredictionIO SDKs**. For example, the following shows how one can create an event involving a single entity. Replace the value of `accessKey` by the *Access Key* generated for your App. http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/datacollection/eventmodel.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/manual/source/datacollection/eventmodel.html.md.erb b/docs/manual/source/datacollection/eventmodel.html.md.erb index bc5fabb..814f6b2 100644 --- a/docs/manual/source/datacollection/eventmodel.html.md.erb +++ b/docs/manual/source/datacollection/eventmodel.html.md.erb @@ -104,7 +104,7 @@ For example, setting entity `user-1`'s properties `birthday` and `address`: } ``` -**Note** that the properties values of the entity will be aggregated based on these special events and the eventTime. The state of the entity is different depending on the time you are looking at the data. In engine's DataSource, you can use [PEventStore.aggregateProperties() API](https://predictionio.incubator.apache.org/api/current/#org.apache.predictionio.data.store.PEventStore$) to retrieve the state of entity's properties (based on time). +**Note** that the properties values of the entity will be aggregated based on these special events and the eventTime. The state of the entity is different depending on the time you are looking at the data. In engine's DataSource, you can use [PEventStore.aggregateProperties() API](https://predictionio.apache.org/api/current/#org.apache.predictionio.data.store.PEventStore$) to retrieve the state of entity's properties (based on time). NOTE: Although it doesn't hurt to import duplicated special events for an entity (exactly same properties) into event server (it just means that the entity changes to the same state as before and new duplicated event provides no new information about the user), it could waste storage space. @@ -240,7 +240,7 @@ NOTE: Note that you should quote the entire URL by using single or double quotes You should see all events being created for this user-2. -Now, let's retrieve the user-2's properties using the [PEventStore API](https://predictionio.incubator.apache.org/api/current/#org.apache.predictionio.data.store.PEventStore$). +Now, let's retrieve the user-2's properties using the [PEventStore API](https://predictionio.apache.org/api/current/#org.apache.predictionio.data.store.PEventStore$). First, start `pio-shell` by running: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/datacollection/index.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/datacollection/index.html.md b/docs/manual/source/datacollection/index.html.md index ecac173..4e1917a 100644 --- a/docs/manual/source/datacollection/index.html.md +++ b/docs/manual/source/datacollection/index.html.md @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -Apache PredictionIO (incubating) offers an Event Server that collects data in an +Apache PredictionIO offers an Event Server that collects data in an event-based style via a RESTful API. By default, Event Server uses Apache HBase as data store. http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/datacollection/webhooks.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/manual/source/datacollection/webhooks.html.md.erb b/docs/manual/source/datacollection/webhooks.html.md.erb index ba53a87..58eb0cf 100644 --- a/docs/manual/source/datacollection/webhooks.html.md.erb +++ b/docs/manual/source/datacollection/webhooks.html.md.erb @@ -21,6 +21,6 @@ limitations under the License. Webhooks are used to collects data for your application from multiple channels automatically. -Apache PredictionIO (incubating) offers webhook connectors for Segment.io and MailChimp +Apache PredictionIO offers webhook connectors for Segment.io and MailChimp (backend only). Several users also have expressed interest in Magento, Shopify and KeenIO so we'd be happy to help if anyone wishes to implement these. http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/demo/community.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/demo/community.html.md b/docs/manual/source/demo/community.html.md index ece646f..f41d879 100644 --- a/docs/manual/source/demo/community.html.md +++ b/docs/manual/source/demo/community.html.md @@ -1,5 +1,5 @@ --- -title: Demo Tutorials with Apache PredictionIO (incubating) +title: Demo Tutorials with Apache PredictionIO --- <!-- @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -Here is a list of demo tutorials for Apache PredictionIO (incubating). +Here is a list of demo tutorials for Apache PredictionIO. INFO: If you want to showcase your demo app here, simply edit [this page](https://github.com/apache/incubator-predictionio/blob/livedoc/docs/manual/source/community/showcase.html.md) http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/demo/index.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/manual/source/demo/index.html.md.erb b/docs/manual/source/demo/index.html.md.erb index 533c845..bb2a859 100644 --- a/docs/manual/source/demo/index.html.md.erb +++ b/docs/manual/source/demo/index.html.md.erb @@ -22,9 +22,9 @@ limitations under the License. ## Current Demos [Tapster](/demo/tapster/) - A Tinder like Rails application using Apache -PredictionIO (incubating). +PredictionIO. ## Contribute -Interested in writing a demo? Contact us at <%= mail_to '[email protected]' %>. +Interested in writing a demo? Contact us at <%= mail_to '[email protected]' %>. http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/demo/tapster.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/demo/tapster.html.md b/docs/manual/source/demo/tapster.html.md index 93213c3..d0573a4 100644 --- a/docs/manual/source/demo/tapster.html.md +++ b/docs/manual/source/demo/tapster.html.md @@ -23,7 +23,7 @@ limitations under the License. In this demo, we will show you how to build a Tinder-style web application (named "Tapster") recommending comics to users based on their likes/dislikes of episodes interactively. -The demo will use [Similar Product Template](https://predictionio.incubator.apache.org/templates/similarproduct/quickstart/). Similar Product Template is a great choice if you want to make recommendations based on immediate user activities or for new users with limited history. It uses MLLib Alternating Least Squares (ALS) recommendation algorithm, a [Collaborative filtering](http://en.wikipedia.org/wiki/Recommender_system#Collaborative_filtering) (CF) algorithm commonly used for recommender systems. These techniques aim to fill in the missing entries of a user-item association matrix. Users and products are described by a small set of latent factors that can be used to predict missing entries. A layman's interpretation of Collaborative Filtering is "People who like this comic, also like these comics." +The demo will use [Similar Product Template](https://predictionio.apache.org/templates/similarproduct/quickstart/). Similar Product Template is a great choice if you want to make recommendations based on immediate user activities or for new users with limited history. It uses MLLib Alternating Least Squares (ALS) recommendation algorithm, a [Collaborative filtering](http://en.wikipedia.org/wiki/Recommender_system#Collaborative_filtering) (CF) algorithm commonly used for recommender systems. These techniques aim to fill in the missing entries of a user-item association matrix. Users and products are described by a small set of latent factors that can be used to predict missing entries. A layman's interpretation of Collaborative Filtering is "People who like this comic, also like these comics." All the code and data is on GitHub at: [github.com/PredictionIO/Demo-Tapster](https://github.com/PredictionIO/Demo-Tapster). @@ -84,10 +84,10 @@ $rails server  -## Apache PredictionIO (incubating) Setup +## Apache PredictionIO Setup -### Install Apache PredictionIO (incubating) -Follow the installation instructions [here](http://predictionio.incubator.apache.org/install/) or simply run: +### Install Apache PredictionIO +Follow the installation instructions [here](http://predictionio.apache.org/install/) or simply run: ``` $ bash -c "$(curl -s https://raw.githubusercontent.com/apache/incubator-predictionio/master/bin/install.sh)" @@ -97,7 +97,7 @@ $ bash -c "$(curl -s https://raw.githubusercontent.com/apache/incubator-predicti ### Create a New App -You will need to create a new app on Apache PredictionIO (incubating) to house +You will need to create a new app on Apache PredictionIO to house the Tapster demo. You can do this with: ``` @@ -191,7 +191,7 @@ Once everything is installed, start the event server by running: `$ pio eventser  -INFO: You can check the status of Apache PredictionIO (incubating) at any time +INFO: You can check the status of Apache PredictionIO at any time by running: `$ pio status` ALERT: If your laptop goes to sleep you might manually need to restart HBase with: @@ -202,10 +202,10 @@ $ ./stop-hbase.sh $ ./start-hbase.sh ``` -The key event we are importing into Apache PredictionIO (incubating) event +The key event we are importing into Apache PredictionIO event server is the "Like" event (for example, user X likes episode Y). -We will send this data to Apache PredictionIO (incubating) by executing `$ rake +We will send this data to Apache PredictionIO by executing `$ rake import:predictionio` command. [View on GitHub](https://github.com/PredictionIO/Demo-Tapster/blob/master/lib/tasks/import/predictionio.rake) @@ -224,7 +224,7 @@ You can set these values in the `.env` file located in the application root dire The next part of the script loops through each line of the `data/user_list.csv` file and returns an array of unique user and episode IDs. Once we have those we -can send the data to Apache PredictionIO (incubating) like this. +can send the data to Apache PredictionIO like this. First the users: @@ -278,7 +278,7 @@ end ``` In total the script takes about 4 minutes to run on a basic laptop. At this -point all the data is now imported to Apache PredictionIO (incubating). +point all the data is now imported to Apache PredictionIO.  @@ -294,7 +294,7 @@ $ pio train -- --driver-memory 4g  Using the --driver-memory option to limit the memory used by Apache PredictionIO -(incubating). Without this Apache PredictionIO (incubating) can consume too much +(incubating). Without this Apache PredictionIO can consume too much memory leading to a crash. You can adjust the 4g up or down depending on your system specs. @@ -311,19 +311,19 @@ two so you can log the live interaction (likes) events into Apache PredictionIO (incubating) event server and query the engine server for recommendation. -## Connect Demo app with Apache PredictionIO (incubating) +## Connect Demo app with Apache PredictionIO ### Overview -On a high level the application keeps a record of each like and dislike. It uses jQuery to send an array of both likes and dislikes to the server on each click. The server then queries Apache PredictionIO (incubating) for a similar episode which is relayed to jQuery and displayed to the user. +On a high level the application keeps a record of each like and dislike. It uses jQuery to send an array of both likes and dislikes to the server on each click. The server then queries Apache PredictionIO for a similar episode which is relayed to jQuery and displayed to the user. Data flow: - The user likes an episode. -- Tapster sends the "Like" event to Apache PredictionIO (incubating) event +- Tapster sends the "Like" event to Apache PredictionIO event server. -- Tapster queries Apache PredictionIO (incubating) engine with all the episodes +- Tapster queries Apache PredictionIO engine with all the episodes the user has rated (likes and dislikes) in this session. -- Apache PredictionIO (incubating) returns 1 recommended episode. +- Apache PredictionIO returns 1 recommended episode. ### JavaScript All the important code lives in `app/assets/javascripts/application.js` [View on GitHub](https://github.com/PredictionIO/Demo-Tapster/blob/master/app/assets/javascripts/application.js) @@ -331,7 +331,7 @@ All the important code lives in `app/assets/javascripts/application.js` [View on Most of this file is just handlers for click things, displaying the loading dialog and other such things. The most important function is to query the Rails server for results from Apache -PredictionIO (incubating). +PredictionIO. ``` // Query the server for a comic based on previous likes. See episodes#query. @@ -388,7 +388,7 @@ def query end ``` -On the first line we make a connection to Apache PredictionIO (incubating). You +On the first line we make a connection to Apache PredictionIO. You will need to set the `PIO_ENGINE_URL`. This can be done in the `.env` file. The default URL is: http://localhost:8000. @@ -401,19 +401,19 @@ If the user has likes then we can send that data to Apache PredictionIO We also blacklist the dislikes so that they are not returned. -With our response from Apache PredictionIO (incubating) itâs just a matter of +With our response from Apache PredictionIO itâs just a matter of looking it up in the database and rendering that object as JSON. Once the response is sent to the browser JavaScript is used to replace the existing comic and hide the loading message. -Thats it. Youâre done! If Ruby is not your language of choice check out our other [SDKs](http://predictionio.incubator.apache.org/sdk/) and remember you can always interact with the Event Server though itâs native JSON API. +Thats it. Youâre done! If Ruby is not your language of choice check out our other [SDKs](http://predictionio.apache.org/sdk/) and remember you can always interact with the Event Server though itâs native JSON API. ## Links Source code is on GitHub at: [github.com/PredictionIO/Demo-Tapster](https://github.com/PredictionIO/Demo-Tapster) ## Conclusion -Love this tutorial and Apache PredictionIO (incubating)? Both are open source +Love this tutorial and Apache PredictionIO? Both are open source (Apache 2 License). [Fork](https://github.com/PredictionIO/Demo-Tapster) this demo and build upon it. If you produce something cool shoot us an email and we will link to it from here. @@ -423,6 +423,6 @@ our other documenation) live in the main repo [here](https://github.com/apache/incubator-predictionio/blob/livedoc/docs/manual/source/demo/tapster.html.md). Our documentation is in the `livedoc` branch. Find out how to contribute documentation at -http://predictionio.incubator.apache.org/community/contribute-documentation/]. +http://predictionio.apache.org/community/contribute-documentation/]. We ♥ pull requests! http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/demo/textclassification.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/manual/source/demo/textclassification.html.md.erb b/docs/manual/source/demo/textclassification.html.md.erb index 9830d3d..a2b36bf 100644 --- a/docs/manual/source/demo/textclassification.html.md.erb +++ b/docs/manual/source/demo/textclassification.html.md.erb @@ -32,8 +32,8 @@ The purpose of this tutorial is to illustrate how you can go about doing this us ## Prerequisites Before getting started, please make sure that you have the latest version of -Apache PredictionIO (incubating) -[installed](http://predictionio.incubator.apache.org/install/). We emphasize +Apache PredictionIO +[installed](http://predictionio.apache.org/install/). We emphasize here that this is an engine template written in **Scala** and can be more generally thought of as an SBT project containing all the necessary components. @@ -61,7 +61,7 @@ Here category is the model's class assignment for this new text document (i.e. t `{category : String}`. -This is used in the evaluation stage when estimating the performance of your predictive model (how well does the model predict categories). Please refer to the [following tutorial](https://predictionio.incubator.apache.org/customize/) for a more detailed explanation of how your engine will interact with your web application, as well as an in depth-overview of DASE. +This is used in the evaluation stage when estimating the performance of your predictive model (how well does the model predict categories). Please refer to the [following tutorial](https://predictionio.apache.org/customize/) for a more detailed explanation of how your engine will interact with your web application, as well as an in depth-overview of DASE. ## Quick Start @@ -208,7 +208,7 @@ Only the latter commands are listed as these are some of the more commonly modified values. See the [Spark documentation](https://spark.apache.org/docs/latest/spark-standalone.html) and the [PredictionIO -FAQ's](http://predictionio.incubator.apache.org/resources/faq/) for more +FAQ's](http://predictionio.apache.org/resources/faq/) for more information. **Note:** We recommend you set your driver memory to `1G` or `2G` as the data size when dealing with text can be very large. @@ -497,7 +497,7 @@ The last and final object implemented in this class simply creates a Map with ke The algorithm components in this engine, `NBAlgorithm` and `LRAlgorithm`, actually follows a very general form. Firstly, a parameter class must again be initialized to feed in the corresponding Algorithm model parameters. For example, NBAlgorithm incorporates NBAlgorithmParams which holds the appropriate additive smoothing parameter lambda for the Naive Bayes model. -The main class of interest in this component is the class that extends [P2LAlgorithm](https://predictionio.incubator.apache.org/api/current/#org.apache.predictionio.controller.P2LAlgorithm). This class must implement a method named train which will output your predictive model (as a concrete object, this will be implemented via a Scala class). It must also implement a predict method that transforms a query to an appropriate feature vector, and uses this to predict with the fitted model. The vectorization function is implemented by a PreparedData object, and the categorization (prediction) is handled by an instance of the NBModel implementation. Again, this demonstrates the facility with which different models can be incorporated into PredictionIO's DASE architecture. +The main class of interest in this component is the class that extends [P2LAlgorithm](https://predictionio.apache.org/api/current/#org.apache.predictionio.controller.P2LAlgorithm). This class must implement a method named train which will output your predictive model (as a concrete object, this will be implemented via a Scala class). It must also implement a predict method that transforms a query to an appropriate feature vector, and uses this to predict with the fitted model. The vectorization function is implemented by a PreparedData object, and the categorization (prediction) is handled by an instance of the NBModel implementation. Again, this demonstrates the facility with which different models can be incorporated into PredictionIO's DASE architecture. The model class itself will be discussed in the following section, however, turn your attention to the TextManipulationEngine object defined in the script `Engine.scala`. You can see here that the engine is initialized by specifying the DataSource, Preparator, and Serving classes, as well as a Map of algorithm names to Algorithm classes. This tells the engine which algorithms to run. In practice, you can have as many statistical learning models as you'd like, you simply have to implement a new algorithm component to do this. However, this general design form will persist, and the main meat of the work should be in the implementation of your model class. @@ -607,7 +607,7 @@ To use the alternative multinomial logistic regression algorithm change your `en ## Serving: Delivering the Final Prediction -The serving component is the final stage in the engine, and in a sense, the most important. This is the final stage in which you combine the results obtained from the different models you choose to run. The Serving class extends the [LServing](https://predictionio.incubator.apache.org/api/current/#org.apache.predictionio.controller.LServing) class which must implement a method called serve. This takes a query and an associated sequence of predicted results, which contains the predicted results from the different algorithms that are implemented in your engine, and combines the results to yield a final prediction. It is this final prediction that you will receive after sending a query. +The serving component is the final stage in the engine, and in a sense, the most important. This is the final stage in which you combine the results obtained from the different models you choose to run. The Serving class extends the [LServing](https://predictionio.apache.org/api/current/#org.apache.predictionio.controller.LServing) class which must implement a method called serve. This takes a query and an associated sequence of predicted results, which contains the predicted results from the different algorithms that are implemented in your engine, and combines the results to yield a final prediction. It is this final prediction that you will receive after sending a query. For example, you could choose to slightly modify the implementation to return class probabilities coming from a mixture of model estimates for class probabilities, or any other technique you could conceive for combining your results. The default engine setting has this set to yield the label from the model predicting with greater confidence. @@ -617,7 +617,7 @@ For example, you could choose to slightly modify the implementation to return cl A predictive model needs to be evaluated to see how it will generalize to future observations. PredictionIO uses cross-validation to perform model performance metric estimates needed to assess your particular choice of model. The script `Evaluation.scala` available with the engine template exemplifies what a usual evaluator setup will look like. First, you must define an appropriate metric. In the engine template, since the topic is text classification, the default metric implemented is category accuracy. - Second you must define an evaluation object (i.e. extends the class [Evaluation](https://predictionio.incubator.apache.org/api/current/#org.apache.predictionio.controller.Evaluation)). + Second you must define an evaluation object (i.e. extends the class [Evaluation](https://predictionio.apache.org/api/current/#org.apache.predictionio.controller.Evaluation)). Here, you must specify the actual engine and metric components that are to be used for the evaluation. In the engine template, the specified engine is the TextManipulationEngine object, and metric, Accuracy. Lastly, you must specify the parameter values that you want to test in the cross validation. You see in the following block of code: ```scala http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/gallery/templates.yaml ---------------------------------------------------------------------- diff --git a/docs/manual/source/gallery/templates.yaml b/docs/manual/source/gallery/templates.yaml index 4642bf6..3c607c3 100644 --- a/docs/manual/source/gallery/templates.yaml +++ b/docs/manual/source/gallery/templates.yaml @@ -125,7 +125,7 @@ status: stable pio_min_version: 0.10.0-incubating apache_pio_convesion_required: "already compatible" - support_link: '<a href="http://predictionio.incubator.apache.org/support/";>Apache PredictionIO mailing lists</a>' + support_link: '<a href="http://predictionio.apache.org/support/";>Apache PredictionIO mailing lists</a>' - template: name: E-Commerce Recommendation @@ -146,7 +146,7 @@ status: alpha pio_min_version: 0.10.0-incubating apache_pio_convesion_required: "already compatible" - support_link: '<a href="http://predictionio.incubator.apache.org/support/";>Apache PredictionIO mailing lists</a>' + support_link: '<a href="http://predictionio.apache.org/support/";>Apache PredictionIO mailing lists</a>' - template: name: Similar Product @@ -160,7 +160,7 @@ status: stable pio_min_version: 0.10.0-incubating apache_pio_convesion_required: "already compatible" - support_link: '<a href="http://predictionio.incubator.apache.org/support/";>Apache PredictionIO mailing lists</a>' + support_link: '<a href="http://predictionio.apache.org/support/";>Apache PredictionIO mailing lists</a>' - template: name: E-Commerce Recommendation (Java) @@ -181,7 +181,7 @@ status: alpha pio_min_version: 0.9.3 apache_pio_convesion_required: "requires conversion" - support_link: '<a href="http://predictionio.incubator.apache.org/support/";>Apache PredictionIO mailing lists</a>' + support_link: '<a href="http://predictionio.apache.org/support/";>Apache PredictionIO mailing lists</a>' - template: name: Product Ranking @@ -293,7 +293,7 @@ status: stable pio_min_version: 0.9.2 apache_pio_convesion_required: "already compatible" - support_link: '<a href="http://predictionio.incubator.apache.org/support/";>Apache PredictionIO mailing lists</a>' + support_link: '<a href="http://predictionio.apache.org/support/";>Apache PredictionIO mailing lists</a>' - template: name: Classification @@ -683,7 +683,7 @@ status: stable pio_min_version: 0.9.2 apache_pio_convesion_required: "already compatible" - support_link: '<a href="http://predictionio.incubator.apache.org/support/";>Apache PredictionIO mailing lists</a>' + support_link: '<a href="http://predictionio.apache.org/support/";>Apache PredictionIO mailing lists</a>' - template: name: Linear Regression BFGS http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/e6ea7dd2/docs/manual/source/index.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/manual/source/index.html.md.erb b/docs/manual/source/index.html.md.erb index 077999c..ba76ac8 100644 --- a/docs/manual/source/index.html.md.erb +++ b/docs/manual/source/index.html.md.erb @@ -1,6 +1,6 @@ --- -title: Welcome to Apache PredictionIO⢠(incubating)! -description: Apache PredictionIO⢠(incubating) Open Source Machine Learning Server +title: Welcome to Apache PredictionIOâ¢! +description: Apache PredictionIO⢠Open Source Machine Learning Server --- <!-- @@ -20,9 +20,9 @@ See the License for the specific language governing permissions and limitations under the License. --> -## What is Apache PredictionIO (incubating)? +## What is Apache PredictionIO? -Apache PredictionIO (incubating) is an **open source Machine Learning Server** +Apache PredictionIO is an **open source Machine Learning Server** built on top of a state-of-the-art open source stack for developers and data scientists to create predictive engines for any machine learning task. It lets you: @@ -40,7 +40,7 @@ scientists to create predictive engines for any machine learning task. It lets y into your engine; * simplify data infrastructure management. -Apache PredictionIO (incubating) can be [installed](/install/) as a full machine +Apache PredictionIO can be [installed](/install/) as a full machine learning stack, bundled with **Apache Spark**, **MLlib**, **HBase**, **Spray** and **Elasticsearch**, which simplifies and accelerates scalable machine learning infrastructure management. @@ -65,7 +65,7 @@ Foundation are on GitHub ## Licensing -Apache PredictionIO (incubating) is licensed under the Apache License, Version +Apache PredictionIO is licensed under the Apache License, Version 2.0. See [LICENSE](https://github.com/apache/incubator-predictionio/blob/master/LICENSE.txt) for the full license text.
