<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.  See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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

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.
-->

# [Apache PredictionIO](http://predictionio.apache.org)

[![Build
Status](https://api.travis-ci.org/apache/incubator-predictionio.svg?branch=develop)](https://travis-ci.org/apache/incubator-predictionio)

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.apache.org!


## Table of contents
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Bugs and Feature Requests](#bugs-and-feature-requests)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [Community](#community)


## Installation

A few installation options available.

*   [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.apache.org/templates/recommendation/quickstart/)
    Guide
*   [Similiar Product Engine Template Quick
    Start](http://predictionio.apache.org/templates/similarproduct/quickstart/)
    Guide
*   [Classification Engine Template Quick
    Start](http://predictionio.apache.org/templates/classification/quickstart/)
    Guide


## Bugs and Feature Requests

Use [Apache JIRA](https://issues.apache.org/jira/browse/PIO) to report bugs or request new features.

## Documentation

Documentation, included in this repo in the `docs/manual` directory, is built
with [Middleman](http://middlemanapp.com/) and publicly hosted at
[predictionio.apache.org](http://predictionio.apache.org/).

Interested in helping with our documentation? Read [Contributing
Documentation](http://predictionio.apache.org/community/contribute-documentation/).


## Community

Keep track of development and community news.

*   Subscribe to the user mailing list <mailto:user-subscribe@predictionio.apache.org>
    and the dev mailing list <mailto:dev-subscribe@predictionio.apache.org>
*   Follow [@predictionio](https://twitter.com/predictionio) on Twitter.


## Contributing

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.apache.org//community/projects/).


## License

Apache PredictionIO is under [Apache 2
license](http://www.apache.org/licenses/LICENSE-2.0.html).