@@ -37,7 +37,7 @@ for a complete description of the classes and functions this package implements.
3737## Installation
3838
3939*** Note: Precompiled packages are currently only provided for Linux and
40- Darwin/Mac OS and Python 3.6-3.8 . To use these packages on Windows, consider
40+ Darwin/Mac OS and Python 3.6-3.9 . To use these packages on Windows, consider
4141using a [ TensorFlow Docker image] ( https://www.tensorflow.org/install/docker ) and
4242installing TensorFlow Compression using pip inside the Docker container.***
4343
@@ -49,18 +49,13 @@ for more information on how to set up such a Python environment.
4949The current version of TensorFlow Compression requires TensorFlow 2. For
5050versions compatible with TensorFlow 1, see our [ previous
5151releases] ( https://github.com/tensorflow/compression/releases ) .
52- *** Note: Because TFC currently relies on features and fixes designated for
53- TF 2.5, the pip package currently depends on tf-nightly packages. Once TF 2.5 is
54- released (likely in April 2021), we will resume depending on the stable version
55- of TF.***
5652
5753### pip
5854
5955To install TFC via ` pip ` , run the following command:
6056
6157``` bash
62- pip uninstall -y tensorflow
63- pip install tf-nightly==2.5.0.dev20210312 tensorflow-compression
58+ pip install tensorflow-compression
6459```
6560
6661To test that the installation works correctly, you can run the unit tests with:
@@ -81,8 +76,8 @@ and then run the `pip install` command inside the Docker container, not on the
8176host. For instance, you can use a command line like this:
8277
8378``` bash
84- docker run tensorflow/tensorflow:nightly bash -c \
85- " pip install tf-nightly==2.5.0.dev20210312 tensorflow-compression &&
79+ docker run tensorflow/tensorflow:2.5.0 bash -c \
80+ " pip install tensorflow-compression &&
8681 python -m tensorflow_compression.all_tests"
8782```
8883
@@ -94,15 +89,19 @@ the pip package and then run the unit tests to confirm that it works.
9489It seems that [ Anaconda] ( https://www.anaconda.com/distribution/ ) ships its own
9590binary version of TensorFlow which is incompatible with our pip package. To
9691solve this, always install TensorFlow via ` pip ` rather than ` conda ` . For
97- example, this creates an Anaconda environment with Python 3.8 and CUDA
98- libraries, and then installs TensorFlow and TensorFlow Compression:
92+ example, this creates an Anaconda environment with CUDA libraries, and then
93+ installs TensorFlow and TensorFlow Compression:
9994
10095``` bash
101- conda create --name ENV_NAME python=3.8 cudatoolkit=10.0 cudnn
96+ conda create --name ENV_NAME python cudatoolkit cudnn
10297conda activate ENV_NAME
103- pip install tf-nightly==2.5.0.dev20210312 tensorflow-compression
98+ pip install tensorflow-compression
10499```
105100
101+ Depending on the requirements of the ` tensorflow ` pip package, you may need to
102+ pin the CUDA libraries to specific versions. If you aren't using a GPU, CUDA is
103+ of course not necessary.
104+
106105## Usage
107106
108107We recommend importing the library from your Python code as follows:
0 commit comments