Skip to content

Commit 7c402f0

Browse files
author
Johannes Ballé
committed
Rearranged landing page, and tweaked page title.
1 parent cc33e43 commit 7c402f0

File tree

2 files changed

+22
-18
lines changed

2 files changed

+22
-18
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,27 @@
1-
# TensorFlow data compression library
2-
31
This package contains data compression ops and layers for TensorFlow.
42

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+
518
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).
720

8-
## Prerequisite
21+
# Quick start
922

1023
**Please note**: You need TensorFlow 1.9 (or the master branch as of May 2018)
11-
or later.
24+
or later installed.
1225

1326
To make sure the library imports succeed, try running the unit tests:
1427

@@ -44,18 +57,7 @@ python bls2017.py [options] compress original.png compressed.bin
4457
python bls2017.py [options] decompress compressed.bin reconstruction.png
4558
```
4659

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
5961
Johannes Ballé (github: [jonycgn](https://github.com/jonycgn)),
6062
Sung Jin Hwang (github: [ssjhv](https://github.com/ssjhv)), and
6163
Nick Johnston (github: [nmjohn](https://github.com/nmjohn))

_config.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
theme: jekyll-theme-cayman
1+
theme: jekyll-theme-cayman
2+
title: TensorFlow/compression
3+
show_downloads: true

0 commit comments

Comments
 (0)