@@ -2,9 +2,9 @@ This project contains data compression ops and layers for TensorFlow. The
2
2
project website is at
3
3
[ tensorflow.github.io/compression] ( https://tensorflow.github.io/compression ) .
4
4
5
- You can use this library to build your own ML models with optimized lossy
6
- data compression built in. It's useful to find storage-efficient representations
7
- of your data (features, examples, images, etc.) while only sacrificing a tiny
5
+ You can use this library to build your own ML models with optimized lossy data
6
+ compression built in. It's useful to find storage-efficient representations of
7
+ your data (features, examples, images, etc.) while only sacrificing a tiny
8
8
fraction of model performance. It can compress any floating point tensor to a
9
9
much smaller sequence of bits.
10
10
@@ -22,11 +22,14 @@ at @jonycgn's
22
22
23
23
# Quick start
24
24
25
- ** Please note** : You need TensorFlow 1.9 (or the master branch as of May 2018)
26
- or later installed.
25
+ Install TensorFlow 1.13.
27
26
28
- Clone the repository to a filesystem location of your choice, or download the
29
- ZIP file and unpack it. Then include the root directory in your ` PYTHONPATH `
27
+ ** Please note** : We are currently transitioning to providing pip packages. At
28
+ this point, the master will not work. Make sure to use the released version.
29
+
30
+ Download the
31
+ [ ZIP file for release v1.1] ( https://github.com/tensorflow/compression/releases/tag/v1.1 )
32
+ and unpack it. Then include its root directory in your ` PYTHONPATH `
30
33
environment variable:
31
34
32
35
``` bash
@@ -53,9 +56,9 @@ import tensorflow_compression as tfc
53
56
54
57
## Example model
55
58
56
- The [ examples directory ] ( https://github.com/tensorflow/compression/tree/master/examples )
57
- contains an implementation of the image compression model described
58
- in:
59
+ The
60
+ [ examples directory ] ( https://github.com/tensorflow/ compression/tree/master/examples )
61
+ contains an implementation of the image compression model described in:
59
62
60
63
> "End-to-end optimized image compression"<br />
61
64
> J. Ballé, V. Laparra, E. P. Simoncelli<br />
@@ -110,7 +113,8 @@ python bls2017.py [options] decompress compressed.bin reconstruction.png
110
113
For usage questions and discussions, please head over to our
111
114
[ Google group] ( https://groups.google.com/forum/#!forum/tensorflow-compression ) .
112
115
113
- Refer to [ the API documentation] ( https://tensorflow.github.io/compression/docs/api_docs/python/tfc.html )
116
+ Refer to
117
+ [ the API documentation] ( https://tensorflow.github.io/compression/docs/api_docs/python/tfc.html )
114
118
for a complete description of the Keras layers and TensorFlow ops this package
115
119
implements.
116
120
@@ -120,8 +124,9 @@ and a description of the range coding operators
120
124
[ here] ( https://tensorflow.github.io/compression/docs/range_coding.html ) .
121
125
122
126
# Authors
123
- Johannes Ballé (github: [ jonycgn] ( https://github.com/jonycgn ) ),
124
- Sung Jin Hwang (github: [ ssjhv] ( https://github.com/ssjhv ) ), and
125
- Nick Johnston (github: [ nmjohn] ( https://github.com/nmjohn ) )
127
+
128
+ Johannes Ballé (github: [ jonycgn] ( https://github.com/jonycgn ) ), Sung Jin Hwang
129
+ (github: [ ssjhv] ( https://github.com/ssjhv ) ), and Nick Johnston (github:
130
+ [ nmjohn] ( https://github.com/nmjohn ) )
126
131
127
132
Note that this is not an officially supported Google product.
0 commit comments