Skip to content

Commit 00b4f17

Browse files
author
jballe
committed
Adds tool to update API docs.
Also, updates API docs. PiperOrigin-RevId: 242721120
1 parent 91219d6 commit 00b4f17

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+5198
-1327
lines changed

docs/api_docs/python/index.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# All symbols in TensorFlow/compression
2+
3+
* <a href="./tfc.md"><code>tfc</code></a>
4+
* <a href="./tfc/EntropyBottleneck.md"><code>tfc.EntropyBottleneck</code></a>
5+
* <a href="./tfc/EntropyModel.md"><code>tfc.EntropyModel</code></a>
6+
* <a href="./tfc/GDN.md"><code>tfc.GDN</code></a>
7+
* <a href="./tfc/GaussianConditional.md"><code>tfc.GaussianConditional</code></a>
8+
* <a href="./tfc/IdentityInitializer.md"><code>tfc.IdentityInitializer</code></a>
9+
* <a href="./tfc/LaplacianConditional.md"><code>tfc.LaplacianConditional</code></a>
10+
* <a href="./tfc/LogisticConditional.md"><code>tfc.LogisticConditional</code></a>
11+
* <a href="./tfc/NonnegativeParameterizer.md"><code>tfc.NonnegativeParameterizer</code></a>
12+
* <a href="./tfc/Parameterizer.md"><code>tfc.Parameterizer</code></a>
13+
* <a href="./tfc/RDFTParameterizer.md"><code>tfc.RDFTParameterizer</code></a>
14+
* <a href="./tfc/SignalConv1D.md"><code>tfc.SignalConv1D</code></a>
15+
* <a href="./tfc/SignalConv2D.md"><code>tfc.SignalConv2D</code></a>
16+
* <a href="./tfc/SignalConv3D.md"><code>tfc.SignalConv3D</code></a>
17+
* <a href="./tfc/StaticParameterizer.md"><code>tfc.StaticParameterizer</code></a>
18+
* <a href="./tfc/SymmetricConditional.md"><code>tfc.SymmetricConditional</code></a>
19+
* <a href="./tfc/array_fingerprint.md"><code>tfc.array_fingerprint</code></a>
20+
* <a href="./tfc/array_fingerprint_eager_fallback.md"><code>tfc.array_fingerprint_eager_fallback</code></a>
21+
* <a href="./tfc/check_array_fingerprint.md"><code>tfc.check_array_fingerprint</code></a>
22+
* <a href="./tfc/check_array_fingerprint_eager_fallback.md"><code>tfc.check_array_fingerprint_eager_fallback</code></a>
23+
* <a href="./tfc/deprecated_endpoints.md"><code>tfc.deprecated_endpoints</code></a>
24+
* <a href="./tfc/irdft_matrix.md"><code>tfc.irdft_matrix</code></a>
25+
* <a href="./tfc/lower_bound.md"><code>tfc.lower_bound</code></a>
26+
* <a href="./tfc/pmf_to_quantized_cdf.md"><code>tfc.pmf_to_quantized_cdf</code></a>
27+
* <a href="./tfc/pmf_to_quantized_cdf_eager_fallback.md"><code>tfc.pmf_to_quantized_cdf_eager_fallback</code></a>
28+
* <a href="./tfc/python.md"><code>tfc.python</code></a>
29+
* <a href="./tfc/python/layers.md"><code>tfc.python.layers</code></a>
30+
* <a href="./tfc/python/layers/entropy_models.md"><code>tfc.python.layers.entropy_models</code></a>
31+
* <a href="./tfc/EntropyBottleneck.md"><code>tfc.python.layers.entropy_models.EntropyBottleneck</code></a>
32+
* <a href="./tfc/EntropyModel.md"><code>tfc.python.layers.entropy_models.EntropyModel</code></a>
33+
* <a href="./tfc/GaussianConditional.md"><code>tfc.python.layers.entropy_models.GaussianConditional</code></a>
34+
* <a href="./tfc/LaplacianConditional.md"><code>tfc.python.layers.entropy_models.LaplacianConditional</code></a>
35+
* <a href="./tfc/LogisticConditional.md"><code>tfc.python.layers.entropy_models.LogisticConditional</code></a>
36+
* <a href="./tfc/SymmetricConditional.md"><code>tfc.python.layers.entropy_models.SymmetricConditional</code></a>
37+
* <a href="./tfc/python/layers/gdn.md"><code>tfc.python.layers.gdn</code></a>
38+
* <a href="./tfc/GDN.md"><code>tfc.python.layers.gdn.GDN</code></a>
39+
* <a href="./tfc/python/layers/initializers.md"><code>tfc.python.layers.initializers</code></a>
40+
* <a href="./tfc/IdentityInitializer.md"><code>tfc.python.layers.initializers.IdentityInitializer</code></a>
41+
* <a href="./tfc/python/layers/parameterizers.md"><code>tfc.python.layers.parameterizers</code></a>
42+
* <a href="./tfc/NonnegativeParameterizer.md"><code>tfc.python.layers.parameterizers.NonnegativeParameterizer</code></a>
43+
* <a href="./tfc/Parameterizer.md"><code>tfc.python.layers.parameterizers.Parameterizer</code></a>
44+
* <a href="./tfc/RDFTParameterizer.md"><code>tfc.python.layers.parameterizers.RDFTParameterizer</code></a>
45+
* <a href="./tfc/StaticParameterizer.md"><code>tfc.python.layers.parameterizers.StaticParameterizer</code></a>
46+
* <a href="./tfc/python/layers/signal_conv.md"><code>tfc.python.layers.signal_conv</code></a>
47+
* <a href="./tfc/SignalConv1D.md"><code>tfc.python.layers.signal_conv.SignalConv1D</code></a>
48+
* <a href="./tfc/SignalConv2D.md"><code>tfc.python.layers.signal_conv.SignalConv2D</code></a>
49+
* <a href="./tfc/SignalConv3D.md"><code>tfc.python.layers.signal_conv.SignalConv3D</code></a>
50+
* <a href="./tfc/python/ops.md"><code>tfc.python.ops</code></a>
51+
* <a href="./tfc/python/ops/math_ops.md"><code>tfc.python.ops.math_ops</code></a>
52+
* <a href="./tfc/lower_bound.md"><code>tfc.python.ops.math_ops.lower_bound</code></a>
53+
* <a href="./tfc/upper_bound.md"><code>tfc.python.ops.math_ops.upper_bound</code></a>
54+
* <a href="./tfc/python/ops/padding_ops.md"><code>tfc.python.ops.padding_ops</code></a>
55+
* <a href="./tfc/same_padding_for_kernel.md"><code>tfc.python.ops.padding_ops.same_padding_for_kernel</code></a>
56+
* <a href="./tfc/python/ops/range_coding_ops.md"><code>tfc.python.ops.range_coding_ops</code></a>
57+
* <a href="./tfc/array_fingerprint.md"><code>tfc.python.ops.range_coding_ops.array_fingerprint</code></a>
58+
* <a href="./tfc/array_fingerprint_eager_fallback.md"><code>tfc.python.ops.range_coding_ops.array_fingerprint_eager_fallback</code></a>
59+
* <a href="./tfc/check_array_fingerprint.md"><code>tfc.python.ops.range_coding_ops.check_array_fingerprint</code></a>
60+
* <a href="./tfc/check_array_fingerprint_eager_fallback.md"><code>tfc.python.ops.range_coding_ops.check_array_fingerprint_eager_fallback</code></a>
61+
* <a href="./tfc/deprecated_endpoints.md"><code>tfc.python.ops.range_coding_ops.deprecated_endpoints</code></a>
62+
* <a href="./tfc/pmf_to_quantized_cdf.md"><code>tfc.python.ops.range_coding_ops.pmf_to_quantized_cdf</code></a>
63+
* <a href="./tfc/pmf_to_quantized_cdf_eager_fallback.md"><code>tfc.python.ops.range_coding_ops.pmf_to_quantized_cdf_eager_fallback</code></a>
64+
* <a href="./tfc/range_decode.md"><code>tfc.python.ops.range_coding_ops.range_decode</code></a>
65+
* <a href="./tfc/range_decode_eager_fallback.md"><code>tfc.python.ops.range_coding_ops.range_decode_eager_fallback</code></a>
66+
* <a href="./tfc/range_encode.md"><code>tfc.python.ops.range_coding_ops.range_encode</code></a>
67+
* <a href="./tfc/range_encode_eager_fallback.md"><code>tfc.python.ops.range_coding_ops.range_encode_eager_fallback</code></a>
68+
* <a href="./tfc/unbounded_index_range_decode.md"><code>tfc.python.ops.range_coding_ops.unbounded_index_range_decode</code></a>
69+
* <a href="./tfc/unbounded_index_range_decode_eager_fallback.md"><code>tfc.python.ops.range_coding_ops.unbounded_index_range_decode_eager_fallback</code></a>
70+
* <a href="./tfc/unbounded_index_range_encode.md"><code>tfc.python.ops.range_coding_ops.unbounded_index_range_encode</code></a>
71+
* <a href="./tfc/unbounded_index_range_encode_eager_fallback.md"><code>tfc.python.ops.range_coding_ops.unbounded_index_range_encode_eager_fallback</code></a>
72+
* <a href="./tfc/python/ops/spectral_ops.md"><code>tfc.python.ops.spectral_ops</code></a>
73+
* <a href="./tfc/irdft_matrix.md"><code>tfc.python.ops.spectral_ops.irdft_matrix</code></a>
74+
* <a href="./tfc/range_decode.md"><code>tfc.range_decode</code></a>
75+
* <a href="./tfc/range_decode_eager_fallback.md"><code>tfc.range_decode_eager_fallback</code></a>
76+
* <a href="./tfc/range_encode.md"><code>tfc.range_encode</code></a>
77+
* <a href="./tfc/range_encode_eager_fallback.md"><code>tfc.range_encode_eager_fallback</code></a>
78+
* <a href="./tfc/same_padding_for_kernel.md"><code>tfc.same_padding_for_kernel</code></a>
79+
* <a href="./tfc/unbounded_index_range_decode.md"><code>tfc.unbounded_index_range_decode</code></a>
80+
* <a href="./tfc/unbounded_index_range_decode_eager_fallback.md"><code>tfc.unbounded_index_range_decode_eager_fallback</code></a>
81+
* <a href="./tfc/unbounded_index_range_encode.md"><code>tfc.unbounded_index_range_encode</code></a>
82+
* <a href="./tfc/unbounded_index_range_encode_eager_fallback.md"><code>tfc.unbounded_index_range_encode_eager_fallback</code></a>
83+
* <a href="./tfc/upper_bound.md"><code>tfc.upper_bound</code></a>

docs/api_docs/python/tfc.md

Lines changed: 56 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,37 @@
1-
<div itemscope itemtype="http://developers.google.com/ReferenceObject">
2-
<meta itemprop="name" content="tfc" />
3-
</div>
41

52
# Module: tfc
63

4+
5+
6+
Defined in [`__init__.py`](https://github.com/tensorflow/compression/tree/master/__init__.py).
7+
8+
<!-- Placeholder for "Used in" -->
9+
710
Data compression tools.
811

12+
## Modules
13+
14+
[`python`](./tfc/python.md) module
15+
916
## Classes
1017

1118
[`class EntropyBottleneck`](./tfc/EntropyBottleneck.md): Entropy bottleneck layer.
1219

20+
[`class EntropyModel`](./tfc/EntropyModel.md): Entropy model (base class).
21+
1322
[`class GDN`](./tfc/GDN.md): Generalized divisive normalization layer.
1423

24+
[`class GaussianConditional`](./tfc/GaussianConditional.md): Conditional Gaussian entropy model.
25+
1526
[`class IdentityInitializer`](./tfc/IdentityInitializer.md): Initialize to the identity kernel with the given shape.
1627

28+
[`class LaplacianConditional`](./tfc/LaplacianConditional.md): Conditional Laplacian entropy model.
29+
30+
[`class LogisticConditional`](./tfc/LogisticConditional.md): Conditional logistic entropy model.
31+
1732
[`class NonnegativeParameterizer`](./tfc/NonnegativeParameterizer.md): Object encapsulating nonnegative parameterization as needed for GDN.
1833

19-
[`class Parameterizer`](./tfc/Parameterizer.md): Parameterizer object (abstract base class).
34+
[`class Parameterizer`](./tfc/Parameterizer.md): Parameterization object (abstract base class).
2035

2136
[`class RDFTParameterizer`](./tfc/RDFTParameterizer.md): Object encapsulating RDFT reparameterization.
2237

@@ -26,21 +41,57 @@ Data compression tools.
2641

2742
[`class SignalConv3D`](./tfc/SignalConv3D.md): 3D convolution layer.
2843

29-
[`class StaticParameterizer`](./tfc/StaticParameterizer.md): A parameterization object that always returns a constant tensor.
44+
[`class StaticParameterizer`](./tfc/StaticParameterizer.md): A parameterizer that always returns a constant tensor.
45+
46+
[`class SymmetricConditional`](./tfc/SymmetricConditional.md): Symmetric conditional entropy model.
3047

3148
## Functions
3249

50+
[`array_fingerprint(...)`](./tfc/array_fingerprint.md): Produces fingerprint of the input data.
51+
52+
[`array_fingerprint_eager_fallback(...)`](./tfc/array_fingerprint_eager_fallback.md): This is the slowpath function for Eager mode.
53+
54+
[`check_array_fingerprint(...)`](./tfc/check_array_fingerprint.md): Computes the fingerprint of `input` and checks the computed value against
55+
56+
[`check_array_fingerprint_eager_fallback(...)`](./tfc/check_array_fingerprint_eager_fallback.md): This is the slowpath function for Eager mode.
57+
58+
[`deprecated_endpoints(...)`](./tfc/deprecated_endpoints.md): Decorator for marking endpoints deprecated.
59+
3360
[`irdft_matrix(...)`](./tfc/irdft_matrix.md): Matrix for implementing kernel reparameterization with `tf.matmul`.
3461

3562
[`lower_bound(...)`](./tfc/lower_bound.md): Same as `tf.maximum`, but with helpful gradient for `inputs < bound`.
3663

3764
[`pmf_to_quantized_cdf(...)`](./tfc/pmf_to_quantized_cdf.md): Converts PMF to quantized CDF. This op uses floating-point operations
3865

66+
[`pmf_to_quantized_cdf_eager_fallback(...)`](./tfc/pmf_to_quantized_cdf_eager_fallback.md): This is the slowpath function for Eager mode.
67+
3968
[`range_decode(...)`](./tfc/range_decode.md): Decodes a range-coded `code` into an int32 tensor of shape `shape`.
4069

70+
[`range_decode_eager_fallback(...)`](./tfc/range_decode_eager_fallback.md): This is the slowpath function for Eager mode.
71+
4172
[`range_encode(...)`](./tfc/range_encode.md): Using the provided cumulative distribution functions (CDF) inside `cdf`, returns
4273

74+
[`range_encode_eager_fallback(...)`](./tfc/range_encode_eager_fallback.md): This is the slowpath function for Eager mode.
75+
4376
[`same_padding_for_kernel(...)`](./tfc/same_padding_for_kernel.md): Determine correct amount of padding for `same` convolution.
4477

78+
[`unbounded_index_range_decode(...)`](./tfc/unbounded_index_range_decode.md): This is the reverse op of `UnboundedIndexRangeEncode`, and decodes the range
79+
80+
[`unbounded_index_range_decode_eager_fallback(...)`](./tfc/unbounded_index_range_decode_eager_fallback.md): This is the slowpath function for Eager mode.
81+
82+
[`unbounded_index_range_encode(...)`](./tfc/unbounded_index_range_encode.md): Range encodes unbounded integer `data` using an indexed probability table.
83+
84+
[`unbounded_index_range_encode_eager_fallback(...)`](./tfc/unbounded_index_range_encode_eager_fallback.md): This is the slowpath function for Eager mode.
85+
4586
[`upper_bound(...)`](./tfc/upper_bound.md): Same as `tf.minimum`, but with helpful gradient for `inputs > bound`.
4687

88+
## Other Members
89+
90+
<h3 id="absolute_import"><code>absolute_import</code></h3>
91+
92+
<h3 id="division"><code>division</code></h3>
93+
94+
<h3 id="print_function"><code>print_function</code></h3>
95+
96+
<h3 id="tf_export"><code>tf_export</code></h3>
97+

0 commit comments

Comments
 (0)