@@ -36,29 +36,31 @@ for a complete description of the classes and functions this package implements.
36
36
## Installation
37
37
38
38
*** Note: Precompiled packages are currently only provided for Linux and
39
- Darwin/Mac OS. To use these packages on Windows, consider using a [ TensorFlow
40
- Docker image] ( https://www.tensorflow.org/install/docker ) and installing
41
- TensorFlow Compression using pip inside the Docker container.***
39
+ Darwin/Mac OS and Python 3.6-3.8. To use these packages on Windows, consider
40
+ using a [ TensorFlow Docker image] ( https://www.tensorflow.org/install/docker ) and
41
+ installing TensorFlow Compression using pip inside the Docker container.***
42
42
43
43
Set up an environment in which you can install precompiled binary Python
44
44
packages using the ` pip ` command. Refer to the
45
45
[ TensorFlow installation instructions] ( https://www.tensorflow.org/install/pip )
46
46
for more information on how to set up such a Python environment.
47
47
48
- The current version of TFC (v2.0) requires TensorFlow v2.4. For versions
49
- compatible with TensorFlow v1 , see our [ previous
48
+ The current version of TensorFlow Compression requires TensorFlow 2. For
49
+ versions compatible with TensorFlow 1 , see our [ previous
50
50
releases] ( https://github.com/tensorflow/compression/releases ) .
51
+ *** Note: Because TFC currently relies on features and fixes designated for
52
+ TF 2.5, the pip package currently depends on tf-nightly packages. Once TF 2.5 is
53
+ released (likely in April 2021), we will resume depending on the stable version
54
+ of TF.***
51
55
52
56
### pip
53
57
54
- To install TF and TFC via ` pip ` , run the following command:
58
+ To install TFC via ` pip ` , run the following command:
55
59
56
60
``` bash
57
- pip install tensorflow-gpu==2.4. * tensorflow- compression==2.0
61
+ pip install tensorflow-compression
58
62
```
59
63
60
- If you don't need GPU support, you can drop the ` -gpu ` part.
61
-
62
64
To test that the installation works correctly, you can run the unit tests with:
63
65
64
66
``` bash
@@ -77,8 +79,8 @@ and then run the `pip install` command inside the Docker container, not on the
77
79
host. For instance, you can use a command line like this:
78
80
79
81
``` bash
80
- docker run tensorflow/tensorflow:2.4.1 bash -c \
81
- " pip install tensorflow-compression==2.0 &&
82
+ docker run tensorflow/tensorflow:nightly bash -c \
83
+ " pip install tensorflow-compression &&
82
84
python -m tensorflow_compression.all_tests"
83
85
```
84
86
@@ -91,13 +93,12 @@ It seems that [Anaconda](https://www.anaconda.com/distribution/) ships its own
91
93
binary version of TensorFlow which is incompatible with our pip package. To
92
94
solve this, always install TensorFlow via ` pip ` rather than ` conda ` . For
93
95
example, this creates an Anaconda environment with Python 3.6 and CUDA
94
- libraries, and then installs TensorFlow and TensorFlow Compression with GPU
95
- support:
96
+ libraries, and then installs TensorFlow and TensorFlow Compression:
96
97
97
98
``` bash
98
- conda create --name ENV_NAME python=3.6 cudatoolkit=10.0 cudnn
99
+ conda create --name ENV_NAME python=3.8 cudatoolkit=10.0 cudnn
99
100
conda activate ENV_NAME
100
- pip install tensorflow-gpu==2.4. * tensorflow- compression==2.0
101
+ pip install tensorflow-compression
101
102
```
102
103
103
104
## Usage
0 commit comments