yunfengzhou-hub commented on a change in pull request #71: URL: https://github.com/apache/flink-ml/pull/71#discussion_r841038991
########## File path: flink-ml-benchmark/README.md ########## @@ -0,0 +1,172 @@ +# Flink ML Benchmark Getting Started + +This document provides instructions on how to run benchmarks on Flink ML's +stages in a Linux/MacOS environment. + +## Prerequisites + +### Install Flink + +Please make sure Flink 1.14 or higher version has been installed in your local +environment. You can refer to the [local +installation](https://nightlies.apache.org/flink/flink-docs-master/docs/try-flink/local_installation/) +instruction on Flink's document website for how to achieve this. + +### Set Up Flink Environment Variables + +After having installed Flink, please register `$FLINK_HOME` as an environment +variable into your local environment. For example, suppose you have downloaded +Flink 1.14.0 and placed Flink's binary folder under `/usr/local/`, then you need +to run the following command: + +```bash +export FLINK_HOME=`/usr/local/flink-1.14.0` +``` + +Then please run the following command. If this command returns 1.14.0 or a +higher version, then it means that the required Flink environment has been +successfully installed and registered in your local environment. + +```bash +$FLINK_HOME/bin/flink --version +``` + +### Acquire Flink ML Binary Distribution Review comment: Yes it is a better name. I had used `Acquire Flink ML Binary Distribution` because in the long run the more common practice would be to download a binary release instead of building the binary locally. I'll add a TODO here to remind us to add instructions about where to download the binary package. -- 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]
