Skip to content

Commit b2cf86e

Browse files
Johannes Ballécopybara-github
authored andcommitted
Cleans up namespace and docstrings of C++ ops a little.
PiperOrigin-RevId: 362598794 Change-Id: I20668262eace84c4796e22c542e1ad2918483ad0
1 parent 12fe456 commit b2cf86e

14 files changed

+44
-704
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ the pip package and then run the unit tests to confirm that it works.
9292
It seems that [Anaconda](https://www.anaconda.com/distribution/) ships its own
9393
binary version of TensorFlow which is incompatible with our pip package. To
9494
solve this, always install TensorFlow via `pip` rather than `conda`. For
95-
example, this creates an Anaconda environment with Python 3.6 and CUDA
95+
example, this creates an Anaconda environment with Python 3.8 and CUDA
9696
libraries, and then installs TensorFlow and TensorFlow Compression:
9797

9898
```bash

docs/api_docs/python/tfc.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -92,16 +92,6 @@ Data compression in TensorFlow.
9292

9393
## Functions
9494

95-
[`PmfToQuantizedCdf(...)`](./tfc/PmfToQuantizedCdf.md): Converts PMF to quantized CDF. This op uses floating-point operations
96-
97-
[`RangeDecode(...)`](./tfc/RangeDecode.md): Decodes a range-coded `code` into an int32 tensor of shape `shape`.
98-
99-
[`RangeEncode(...)`](./tfc/RangeEncode.md): Using the provided cumulative distribution functions (CDF) inside `cdf`, returns
100-
101-
[`UnboundedIndexRangeDecode(...)`](./tfc/UnboundedIndexRangeDecode.md): This is the reverse op of `UnboundedIndexRangeEncode`, and decodes the range
102-
103-
[`UnboundedIndexRangeEncode(...)`](./tfc/UnboundedIndexRangeEncode.md): Range encodes unbounded integer `data` using an indexed probability table.
104-
10595
[`estimate_tails(...)`](./tfc/estimate_tails.md): Estimates approximate tail quantiles.
10696

10797
[`irdft_matrix(...)`](./tfc/irdft_matrix.md): Matrix for implementing kernel reparameterization with `tf.matmul`.
@@ -112,13 +102,13 @@ Data compression in TensorFlow.
112102

113103
[`perturb_and_apply(...)`](./tfc/perturb_and_apply.md): Perturbs the inputs of a pointwise function.
114104

115-
[`pmf_to_quantized_cdf(...)`](./tfc/pmf_to_quantized_cdf.md): Converts PMF to quantized CDF. This op uses floating-point operations
105+
[`pmf_to_quantized_cdf(...)`](./tfc/pmf_to_quantized_cdf.md): Converts a PMF into a quantized CDF for range coding.
116106

117107
[`quantization_offset(...)`](./tfc/quantization_offset.md): Computes distribution-dependent quantization offset.
118108

119-
[`range_decode(...)`](./tfc/range_decode.md): Decodes a range-coded `code` into an int32 tensor of shape `shape`.
109+
[`range_decode(...)`](./tfc/range_decode.md): Range-decodes `code` into an int32 tensor of shape `shape`.
120110

121-
[`range_encode(...)`](./tfc/range_encode.md): Using the provided cumulative distribution functions (CDF) inside `cdf`, returns
111+
[`range_encode(...)`](./tfc/range_encode.md): Range encodes integer `data` with a finite alphabet.
122112

123113
[`same_padding_for_kernel(...)`](./tfc/same_padding_for_kernel.md): Determine correct amount of padding for `same` convolution.
124114

@@ -128,7 +118,7 @@ Data compression in TensorFlow.
128118

129119
[`soft_round_inverse(...)`](./tfc/soft_round_inverse.md): Inverse of soft_round().
130120

131-
[`unbounded_index_range_decode(...)`](./tfc/unbounded_index_range_decode.md): This is the reverse op of `UnboundedIndexRangeEncode`, and decodes the range
121+
[`unbounded_index_range_decode(...)`](./tfc/unbounded_index_range_decode.md): Range decodes `encoded` using an indexed probability table.
132122

133123
[`unbounded_index_range_encode(...)`](./tfc/unbounded_index_range_encode.md): Range encodes unbounded integer `data` using an indexed probability table.
134124

docs/api_docs/python/tfc/PmfToQuantizedCdf.md

Lines changed: 0 additions & 84 deletions
This file was deleted.

docs/api_docs/python/tfc/RangeDecode.md

Lines changed: 0 additions & 109 deletions
This file was deleted.

docs/api_docs/python/tfc/RangeEncode.md

Lines changed: 0 additions & 136 deletions
This file was deleted.

0 commit comments

Comments
 (0)