Skip to content

Commit

Permalink
Merge branch 'livedoc' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
shimamoto committed Sep 11, 2018
2 parents 18fa9b7 + 52a0891 commit 3f637e5
Show file tree
Hide file tree
Showing 7 changed files with 60 additions and 23 deletions.
2 changes: 1 addition & 1 deletion docs/manual/data/nav/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ root:
body: 'Event Server Plugin'
url: '/datacollection/plugin/'
-
body: 'Choosing an Algorithm(s)'
body: 'Choosing an Algorithm'
url: '#'
children:
-
Expand Down
6 changes: 3 additions & 3 deletions docs/manual/source/community/contribute-sdk.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ See the License for the specific language governing permissions and
limitations under the License.
-->

A SDK should provide convenient methods for client applications to easily
record users' behaviors in Apache PredictionIO's Event Server and
also query recommendations from the ML Engines. Therefore, a SDK typically has 2
A SDK should provide convenient methods for client applications to easily record
users' behaviors in Apache PredictionIO's Event Server and also query
recommendations from machine learning 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's
Expand Down
4 changes: 1 addition & 3 deletions docs/manual/source/demo/community.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,7 @@ URL: http:https://nogoodgamez.com

Beer recommendation app built by [Victor Leung](https://twitter.com/victorleungtw).

URL: http:https://ontappapp.com/

Writeup: http:https://victorleungtw.com/prediction-io/
Writeup: https://medium.com/@victorleungtw/beer-recommendation-engine-using-predictionio-36488ea0c50d


## Yelpio
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/source/evaluation/index.html.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: ML Tuning and Evaluation
title: Tuning and Evaluation
---

<!--
Expand Down
11 changes: 5 additions & 6 deletions docs/manual/source/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ learning stack, bundled with **Apache Spark**, **MLlib**, **HBase**, **Spray**
and **Elasticsearch**, which simplifies and accelerates scalable machine
learning infrastructure management.

| Getting Started | Developer Guides | ML Education and Usage | PredictionIO SDKs |
| --------------- | ---------------- | ---------------------- | ----------------- |
| [Quick Intro](/start/) | [System Architecture](/system/) | [Comics Recommendation](/demo/tapster/) | [Java](/sdk/java/) |
| Getting Started | Developer Guides | Machine Learning Education and Usage | PredictionIO SDKs |
| --------------- | ---------------- | ------------------------------------ | ----------------- |
| [Quick Intro](/start/) | [System Architecture](/system/) | [Demo: Recommending Comics](/demo/tapster/) | [Java](/sdk/java/) |
| [Installation Guide](/install/) | [Event Server Overview](/datacollection/) | [Text Classification](/demo/textclassification/) | [PHP](/sdk/php/) |
| [Downloading Template](/start/download/) | [Collecting Data](/datacollection/eventapi/) | [Community Contributed Demo](/demo/community/) | [Python](/sdk/python/) |
| [Deploying an Engine](/start/deploy/) | [Learning DASE](/customize/) |[Dimensionality Reduction](/machinelearning/dimensionalityreduction/)| [Ruby](/sdk/ruby/) |
Expand All @@ -59,9 +59,8 @@ learning infrastructure management.

## Release Notes

A summary of the changes in each release before migrating to Apache Software
Foundation are on GitHub
[here](https://github.com/PredictionIO/PredictionIO/blob/master/RELEASE.md).
A summary of changes in each release can be found
[here](https://github.com/apache/predictionio/blob/master/RELEASE.md).

## Licensing

Expand Down
54 changes: 47 additions & 7 deletions docs/manual/source/install/install-sourcecode.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,41 @@ building against
* Hadoop 2.7.3
* Elasticsearch 5.5.2

Download binary release from an [Apache mirror](https://www.apache.org/dyn/closer.cgi/predictionio/<%=
data.versions.pio %>/apache-predictionio-<%= data.versions.pio %>-bin.tar.gz)
and verify the release.
Download [binary release from an Apache
mirror](https://www.apache.org/dyn/closer.lua/predictionio/<%= data.versions.pio
%>/apache-predictionio-<%= data.versions.pio %>-bin.tar.gz) and verify the
release with the corresponding
[signature](https://archive.apache.org/dist/predictionio/<%=
data.versions.pio %>/apache-predictionio-<%= data.versions.pio
%>-bin.tar.gz.asc) and
[checksum](https://archive.apache.org/dist/predictionio/<%=
data.versions.pio %>/apache-predictionio-<%= data.versions.pio
%>-bin.tar.gz.sha512).

### Verifying Release

Verify binary/source release using [signatures and checksums]
(https://www.apache.org/dist/predictionio/<%= data.versions.pio %>/)
and [project release KEYS](https://www.apache.org/dist/predictionio/KEYS).

```
$ gpg --import KEYS
$ gpg --verify apache-predictionio-<%= data.versions.pio %>.tar.gz.asc apache-predictionio-<%= data.versions.pio %>.tar.gz
```

You should see something like this.

```
gpg: Signature made Tue Sep 26 22:55:22 2017 PDT
gpg: using RSA key 7E2363D84719A8F4
gpg: Good signature from "Chan Lee <chanlee@apache.org>" [ultimate]
```

For further information, the [official guide from
Apache](https://www.apache.org/info/verification.html) has the most up-to-date
and complete information.

### Installation

Extract the binary distribution and proceed to
[Installing Dependencies](#installing-dependencies).
Expand All @@ -45,10 +77,14 @@ $ tar zxvf apache-predictionio-<%= data.versions.pio %>.tar.gz

## Downloading Source Code

Download Apache PredictionIO source <%= data.versions.pio %> from an
[Apache mirror](https://www.apache.org/dyn/closer.cgi/predictionio/<%=
data.versions.pio %>/apache-predictionio-<%= data.versions.pio %>.tar.gz) and
verify the release.
Download [source release from an Apache
mirror](https://www.apache.org/dyn/closer.cgi/predictionio/<%= data.versions.pio
%>/apache-predictionio-<%= data.versions.pio %>.tar.gz) and verify the release
with the corresponding
[signature](https://archive.apache.org/dist/predictionio/<%= data.versions.pio
%>/apache-predictionio-<%= data.versions.pio %>.tar.gz.asc) and
[checksum](https://archive.apache.org/dist/predictionio/<%= data.versions.pio
%>/apache-predictionio-<%= data.versions.pio %>.tar.gz.sha512).

### Verifying Release

Expand All @@ -69,6 +105,10 @@ gpg: using RSA key 7E2363D84719A8F4
gpg: Good signature from "Chan Lee <chanlee@apache.org>" [ultimate]
```

For further information, the [official guide from
Apache](https://www.apache.org/info/verification.html) has the most up-to-date
and complete information.

## Building

Run the following at the directory where you downloaded the source code to build
Expand Down
4 changes: 2 additions & 2 deletions docs/manual/source/partials/_footer.html.slim
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ footer
= image_tag 'logos/logo-white.png', alt: 'PredictionIO'
span ®
#social-icons-wrapper
a.github-button> href="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/apache/predictionio" data-style="mega" data-count-href="/apache/predictionio/stargazers" data-count-api="/repos/apache/predictionio#stargazers_count" data-count-aria-label="# stargazers on GitHub" aria-label="Star apache/predictionio on GitHub" Star
a.github-button> href="https://github.com/apache/predictionio/fork" data-icon="octicon-git-branch" data-style="mega" data-count-href="/apache/predictionio/network" data-count-api="/repos/apache/predictionio#forks_count" data-count-aria-label="# forks on GitHub" aria-label="Fork apache/predictionio on GitHub" Fork
a.github-button> href="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/apache/predictionio" data-icon="octicon-star" data-show-count="true" aria-label="Star apache/predictionio on GitHub" Star
a.github-button> href="https://github.com/apache/predictionio/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork apache/predictionio on GitHub" Fork
script#github-bjs(async defer src="https://buttons.github.io/buttons.js")
a> href="https://twitter.com/predictionio" target="blank"
= image_tag 'icons/twitter.png', alt: 'PredictionIO on Twitter'
Expand Down

0 comments on commit 3f637e5

Please sign in to comment.