|
1 | | -# TensorFlow data compression library |
2 | | - |
3 | 1 | This package contains data compression ops and layers for TensorFlow. |
4 | 2 |
|
| 3 | +# Documentation |
| 4 | + |
| 5 | +All documentation is hosted at https://tensorflow.github.io/compression. |
| 6 | + |
| 7 | +Refer to [the API documentation](https://tensorflow.github.io/compression/docs/api_docs/python/tfc.html) |
| 8 | +for a complete description of the Keras layers and TensorFlow ops this package |
| 9 | +implements. |
| 10 | + |
| 11 | +There's also an introduction to our `EntropyBottleneck` class |
| 12 | +[here](https://tensorflow.github.io/compression/docs/entropy_bottleneck.html), |
| 13 | +and a description of the range coding operators |
| 14 | +[here](https://tensorflow.github.io/compression/docs/range_coding.html). |
| 15 | + |
| 16 | +# Google group |
| 17 | + |
5 | 18 | For usage questions and discussions, please head over to our |
6 | | -[Google group](https://groups.google.com/forum/#!forum/tensorflow-compression)! |
| 19 | +[Google group](https://groups.google.com/forum/#!forum/tensorflow-compression). |
7 | 20 |
|
8 | | -## Prerequisite |
| 21 | +# Quick start |
9 | 22 |
|
10 | 23 | **Please note**: You need TensorFlow 1.9 (or the master branch as of May 2018) |
11 | | -or later. |
| 24 | +or later installed. |
12 | 25 |
|
13 | 26 | To make sure the library imports succeed, try running the unit tests: |
14 | 27 |
|
@@ -44,18 +57,7 @@ python bls2017.py [options] compress original.png compressed.bin |
44 | 57 | python bls2017.py [options] decompress compressed.bin reconstruction.png |
45 | 58 | ``` |
46 | 59 |
|
47 | | -## Documentation |
48 | | - |
49 | | -Refer to [the API documentation](https://tensorflow.github.io/compression/docs/api_docs/python/tfc.html) |
50 | | -for a full description of the Keras layers and TensorFlow ops this package |
51 | | -implements. |
52 | | - |
53 | | -There's also an introduction to our `EntropyBottleneck` class |
54 | | -[here](https://tensorflow.github.io/compression/docs/entropy_bottleneck.html), |
55 | | -and a description of the range coding ops |
56 | | -[here](https://tensorflow.github.io/compression/docs/range_coding.html). |
57 | | - |
58 | | -## Authors |
| 60 | +# Authors |
59 | 61 | Johannes Ballé (github: [jonycgn](https://github.com/jonycgn)), |
60 | 62 | Sung Jin Hwang (github: [ssjhv](https://github.com/ssjhv)), and |
61 | 63 | Nick Johnston (github: [nmjohn](https://github.com/nmjohn)) |
|
0 commit comments