lindong28 commented on a change in pull request #36: URL: https://github.com/apache/flink-ml/pull/36#discussion_r755746945
########## File path: flink-ml-python/README.md ########## @@ -0,0 +1,20 @@ +Flink ML is a library which provides machine learning (ML) APIs and libraries that simplify the building of machine learning pipelines. It provides a set of standard ML APIs for MLlib developers to implement ML algorithms, as well as libraries of ML algorithms that can be used to build ML pipelines for both training and inference jobs. + +Flink ML is developed under the umbrella of [Apache Flink](https://flink.apache.org/). + +## <a name="build"></a>Python Packaging + +Prerequisites for building apache-flink-ml: + +* Unix-like environment (we use Linux, Mac OS X) +* Python version(3.6, 3.7 or 3.8) is required + +Then go to the root directory of flink-ml-python source code and run this command to build the sdist package of apache-flink-ml: +```bash +cd flink-ml-python; python setup.py sdist; +``` + +The sdist package of apache-flink-ml will be found under ./flink-ml-python/dist/. It could be used for installation, such as: +```bash +python -m pip install dist/*.tar.gz Review comment: Could you update README to specify how to run test cases (similar to the existing README in `flink/flink-python/README.md`)? And we probably also need to compile the python package and run all python unit tests in the Github CI. This could be specified in `.github/workflows/java8-build.yml`. Could you help do this? -- 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: issues-unsubscr...@flink.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org