Skip to content

Commit 2bef688

Browse files
author
Johannes Ballé
committed
Small adjustments to documentation.
1 parent e73e655 commit 2bef688

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# TensorFlow data compression tools
1+
# TensorFlow data compression library
22

33
This package contains data compression ops and layers for TensorFlow.
44

@@ -47,11 +47,11 @@ tensor values are good enough for practical purposes, the training phase must
4747
be used to balance the quality of the approximation with the entropy, by
4848
adding an entropy term to the training loss, as in the following example.
4949

50-
Here, we use the entropy bottleneck to compress the latent representation of
51-
an autoencoder. The data vectors `x` in this case are 4D tensors in
52-
`'channels_last'` format (for example, 16x16 pixel grayscale images).
53-
5450
### Compiling
51+
52+
*Please note*: You need TensorFlow 1.9 (or the master branch as of May 2018)
53+
or later.
54+
5555
First, compile the custom ops needed by TensorFlow.
5656
```shell
5757
cd compression
@@ -60,15 +60,19 @@ chmod +x compile.sh
6060
cd ..
6161
```
6262

63-
To make sure the compilation and library imports succeed, try running the two tests.
63+
To make sure the compilation and library imports succeed, try running the two
64+
tests.
6465
```
6566
python compression/python/ops/coder_ops_test.py
6667
python compression/python/layers/entropybottleneck_test.py
6768
```
6869

69-
7070
### Training
7171

72+
Here, we use the entropy bottleneck to compress the latent representation of
73+
an autoencoder. The data vectors `x` in this case are 4D tensors in
74+
`'channels_last'` format (for example, 16x16 pixel grayscale images).
75+
7276
```python
7377
# Build autoencoder.
7478
x = tf.placeholder(tf.float32, shape=[None, 16, 16, 1])

0 commit comments

Comments
 (0)