Skip to content

Commit 66228f0

Browse files
Johannes Ballécopybara-github
authored andcommitted
Updates for 2.2 release.
PiperOrigin-RevId: 373692337 Change-Id: Ifc039a21d10d16941a782ca273c3164a31391430
1 parent f9edc94 commit 66228f0

39 files changed

+5472
-650
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -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
4141
using a [TensorFlow Docker image](https://www.tensorflow.org/install/docker) and
4242
installing 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.
4949
The current version of TensorFlow Compression requires TensorFlow 2. For
5050
versions compatible with TensorFlow 1, see our [previous
5151
releases](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

5955
To 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

6661
To 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
8176
host. 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.
9489
It seems that [Anaconda](https://www.anaconda.com/distribution/) ships its own
9590
binary version of TensorFlow which is incompatible with our pip package. To
9691
solve 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
10297
conda 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

108107
We recommend importing the library from your Python code as follows:

build_pip_pkg.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,6 @@ def main(srcdir):
7878
"Intended Audience :: Science/Research",
7979
"License :: OSI Approved :: Apache Software License",
8080
"Programming Language :: Python :: 3",
81-
"Programming Language :: Python :: 3.6",
82-
"Programming Language :: Python :: 3.7",
83-
"Programming Language :: Python :: 3.8",
8481
"Topic :: Scientific/Engineering :: Mathematics",
8582
"Topic :: Software Development :: Libraries :: Python Modules",
8683
"Topic :: Software Development :: Libraries",

docs/api_docs/python/tfc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,12 +90,12 @@ Data compression in TensorFlow.
9090

9191
[`class UniversalIndexedEntropyModel`](./tfc/UniversalIndexedEntropyModel.md): Indexed entropy model model which implements Universal Quantization.
9292

93+
[`class Y4MDataset`](./tfc/Y4MDataset.md): A `tf.Dataset` of Y'CbCr video frames from '.y4m' files.
94+
9395
## Functions
9496

9597
[`estimate_tails(...)`](./tfc/estimate_tails.md): Estimates approximate tail quantiles.
9698

97-
[`irdft_matrix(...)`](./tfc/irdft_matrix.md): Matrix for implementing kernel reparameterization with `tf.matmul`.
98-
9999
[`lower_bound(...)`](./tfc/lower_bound.md): Same as `tf.maximum`, but with helpful gradient for `inputs < bound`.
100100

101101
[`lower_tail(...)`](./tfc/lower_tail.md): Approximates lower tail quantile for range coding.

0 commit comments

Comments
 (0)