lindong28 commented on code in PR #164:
URL: https://github.com/apache/flink-ml/pull/164#discussion_r1000106258
##########
docs/content/docs/try-flink-ml/java/build-your-own-project.md:
##########
@@ -28,7 +28,7 @@ under the License.
This document provides a quick introduction to using Flink ML. Readers of this
document will be guided to create a simple Flink job that trains a Machine
-Learning Model and use it to provide prediction service.
+Learning Model and uses it to provide prediction service.
## Maven Setup
Review Comment:
Should we also have a Prerequisites section similar to the python
``build-you-own-project.md`?
##########
docs/content/docs/try-flink-ml/python/quick-start.md:
##########
@@ -30,53 +30,56 @@ under the License.
This document provides a quick introduction to using Flink ML. Readers of this
document will be guided to submit a simple Flink job that trains a Machine
-Learning Model and use it to provide prediction service.
+Learning Model and uses it to provide prediction service.
## Prerequisites
-Python version (3.6, 3.7, or 3.8) is required for Flink ML. Please run the
-following command to make sure that it meets the requirements:
+This walkthrough assumes that you have some familiarity with Python, but you
+should be able to follow along even if you come from a different programming
+language.
-```shell
-$ python --version
-# the version printed here must be 3.6, 3.7 or 3.8
-```
+If you want to follow along, you will require a computer with:
+
+- Java 8
+- Maven 3
+- Python 3.6, 3.7 or 3.8
-## Installation of Flink ML Python SDK
+## Install Flink ML Python SDK
+
+{{< stable >}}
Flink ML Python SDK is available in
[PyPi](https://pypi.org/project/apache-flink-ml/) and can be installed as
follows:
-{{< stable >}}
-
```bash
$ python -m pip install apache-flink-ml=={{< version >}}
```
{{< /stable >}} {{< unstable >}}
-```bash
-$ python -m pip install apache-flink-ml
-```
-{{< /unstable >}}
+Please walk through this [guideline]({{< ref "docs/development/building" >}})
to
+build and install Flink ML's Python SDK in your local environment.
-You can also build Flink ML Python SDK from sources by following the
-[development guide]({{< ref "docs/development/building" >}}).
+{{< /unstable >}}
## Run Flink ML example job
After setting up Flink ML Python SDK, you can run a Flink ML example job as
follows.
```shell
-$ python -m pyflink.examples.ml.clustering.kmeans_example
+ML_EXAMPLES_PATH=`python -c "import pyflink.examples.ml as _;
print(_.__path__[0])"`
+python $ML_EXAMPLES_PATH/clustering/kmeans_example.py
Review Comment:
Would it be simpler to do something like this:
```
cd {path_to_flink_ml}
python ./flink-ml-python/pyflink/examples/ml/clustering/kmeans_example.py
```
##########
docs/content/docs/try-flink-ml/java/quick-start.md:
##########
@@ -54,23 +63,17 @@ export FLINK_HOME=`pwd`
available)
### Build Flink ML library
-In order to use Flink ML's CLI you need to have the latest binary distribution
-of Flink ML. You can acquire the distribution by building Flink ML's source
code
-locally with the following command.
-
-```bash
-cd ${path_to_flink_ml}
-mvn clean package -DskipTests
-cd ./flink-ml-dist/target/flink-ml-*-bin/flink-ml*/
-```
+Please walk through this [guideline]({{< ref "docs/development/building" >}})
to
Review Comment:
Would it be more straightforward to use
`docs/development/building/#build-flink-ml-java-sdk` as the reference link?
For released versions, the `build-your-own-project.md` should not require
user to build Flink ML library from source. They should be able to download
jars directly. Could we use the stable/unstable tags to differentiate these two
cases in this README?
##########
docs/content/docs/try-flink-ml/java/quick-start.md:
##########
@@ -54,23 +63,17 @@ export FLINK_HOME=`pwd`
available)
### Build Flink ML library
-In order to use Flink ML's CLI you need to have the latest binary distribution
-of Flink ML. You can acquire the distribution by building Flink ML's source
code
-locally with the following command.
-
-```bash
-cd ${path_to_flink_ml}
-mvn clean package -DskipTests
-cd ./flink-ml-dist/target/flink-ml-*-bin/flink-ml*/
-```
+Please walk through this [guideline]({{< ref "docs/development/building" >}})
to
+build Flink ML's Java SDK.
### Add Flink ML binaries to Flink
You need to copy Flink ML's binary distribution files to Flink's folder for
-proper initialization. Please run the following command from Flink ML's binary
-distribution's folder.
+proper initialization. Please run the following command from Flink ML's root
+folder.
```bash
+cd ./flink-ml-dist/target/flink-ml-*-bin/flink-ml*/
Review Comment:
For master branch where the jars are compiled from source, it might be
better to do this:
```
cd ${path_to_flink_ml}
cp ./flink-ml-dist/target/flink-ml-*-bin/flink-ml*/lib/*.jar $FLINK_HOME/lib/
```
For released branch, we probably want to let users download the jars into
this directory.
##########
docs/content/docs/try-flink-ml/python/quick-start.md:
##########
@@ -30,53 +30,56 @@ under the License.
This document provides a quick introduction to using Flink ML. Readers of this
document will be guided to submit a simple Flink job that trains a Machine
-Learning Model and use it to provide prediction service.
+Learning Model and uses it to provide prediction service.
## Prerequisites
-Python version (3.6, 3.7, or 3.8) is required for Flink ML. Please run the
-following command to make sure that it meets the requirements:
+This walkthrough assumes that you have some familiarity with Python, but you
+should be able to follow along even if you come from a different programming
+language.
-```shell
-$ python --version
-# the version printed here must be 3.6, 3.7 or 3.8
-```
+If you want to follow along, you will require a computer with:
+
+- Java 8
+- Maven 3
+- Python 3.6, 3.7 or 3.8
-## Installation of Flink ML Python SDK
+## Install Flink ML Python SDK
+
+{{< stable >}}
Flink ML Python SDK is available in
[PyPi](https://pypi.org/project/apache-flink-ml/) and can be installed as
follows:
-{{< stable >}}
-
```bash
$ python -m pip install apache-flink-ml=={{< version >}}
```
{{< /stable >}} {{< unstable >}}
-```bash
-$ python -m pip install apache-flink-ml
-```
-{{< /unstable >}}
+Please walk through this [guideline]({{< ref "docs/development/building" >}})
to
Review Comment:
Would it be more straightforward to use
`https://nightlies.apache.org/flink/flink-ml-docs-master/docs/development/building/#build-flink-ml-python-sdk`
as the reference link?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
