diff --git a/README.md b/README.md index 88eabdcb12..2312d8699a 100644 --- a/README.md +++ b/README.md @@ -21,34 +21,34 @@ Caution: TFMA may introduce backwards incompatible changes before version 1.0. The recommended way to install TFMA is using the [PyPI package](https://pypi.org/project/tensorflow-model-analysis/): -
+```Shell pip install tensorflow-model-analysis -+``` pip install from https://pypi-nightly.tensorflow.org -
+```Shell pip install -i https://pypi-nightly.tensorflow.org/simple tensorflow-model-analysis -+``` pip install from the HEAD of the git: -
+```Shell pip install git+https://github.com/tensorflow/model-analysis.git#egg=tensorflow_model_analysis -+``` pip install from a released version directly from git: -
+```Shell pip install git+https://github.com/tensorflow/model-analysis.git@v0.21.3#egg=tensorflow_model_analysis -+``` If you have cloned the repository locally, and want to test your local change, pip install from a local folder. -
+```Shell pip install -e $FOLDER_OF_THE_LOCAL_LOCATION -+``` Note that protobuf must be installed correctly for the above option since it is building TFMA from source and it requires protoc and all of its includes