Skip to content

Commit 91d8b27

Browse files
rino20tensorflower-gardener
authored andcommitted
Fix compression API README file.
PiperOrigin-RevId: 413862562
1 parent e3bfab8 commit 91d8b27

File tree

1 file changed

+11
-6
lines changed
  • tensorflow_model_optimization/python/core/common/keras/compression

1 file changed

+11
-6
lines changed
Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1-
These APIs are not ready for public usage yet.
1+
# Compression API
22

3-
algorithms/ : end-to-end tests that demonstrate usage of algorithm developer
4-
public API.
3+
These modules implement the TFMOT's Compression APIs. But they are experimental
4+
and are not yet officially supported.
55

6-
algorithm.py : public API for algorithm developer
6+
## Modules
77

8-
internal/ : internal parts of library. These should not be used anywhere outside
9-
this directory.
8+
algorithm.py : The API that algorithm developers can inherit to implement any
9+
custom model compression algorithms.
10+
11+
algorithms/ : Repository of example algorithms that can be used to Compression
12+
API, and corresponding end-to-end tests to demonstrate the usage.
13+
14+
internal/ : Libraries for internal usage.

0 commit comments

Comments
 (0)