Skip to content

Commit bd546cf

Browse files
author
Johannes Ballé
committed
Added blurb to README.md.
1 parent 2acdf14 commit bd546cf

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
This project contains data compression ops and layers for TensorFlow. The
2-
project website is at https://tensorflow.github.io/compression.
2+
project website is at
3+
[tensorflow.github.io/compression](https://tensorflow.github.io/compression).
4+
5+
What does this library do, you ask?
6+
7+
In a nutshell, you can use it to build your own ML models with optimized lossy
8+
data compression built in. It's useful to find storage-efficient representations
9+
of your data (features, examples, images, etc.) while only sacrificing a tiny
10+
fraction of model performance. It can compress any floating point tensor to a
11+
much smaller sequence of bits.
12+
13+
For an introduction to lossy data compression with machine learning, take a look
14+
at @jonycgn's
15+
[talk on Learned Image Compression](https://www.youtube.com/watch?v=x_q7cZviXkY).
316

417
# Quick start
518

@@ -35,7 +48,7 @@ import tensorflow_compression as tfc
3548
## Example model
3649

3750
The [examples directory](https://github.com/tensorflow/compression/tree/master/examples)
38-
directory contains an implementation of the image compression model described
51+
contains an implementation of the image compression model described
3952
in:
4053

4154
> "End-to-end optimized image compression"<br />

0 commit comments

Comments
 (0)