Documentation updates for release 2.8.1.

Johannes Ballé · copybara-github · commit 8531c6996027 · 2022-03-02T11:41:30.000-08:00
PiperOrigin-RevId: 431990216
Change-Id: Ib2a0d85f41c70d145a9c5ea805a911165050ef6c
diff --git a/docs/api_docs/python/tfc.md b/docs/api_docs/python/tfc.md
@@ -122,6 +122,10 @@ Data compression in TensorFlow.
 
 [`round_st(...)`](./tfc/round_st.md): Straight-through round with optional quantization offset.
 
+[`run_length_gamma_decode(...)`](./tfc/run_length_gamma_decode.md): Decodes `data` using run-length and Elias gamma coding.
+
+[`run_length_gamma_encode(...)`](./tfc/run_length_gamma_encode.md): Encodes `data` using run-length and Elias gamma coding.
+
 [`same_padding_for_kernel(...)`](./tfc/same_padding_for_kernel.md): Determine correct amount of padding for `same` convolution.
 
 [`soft_round(...)`](./tfc/soft_round.md): Differentiable approximation to round().
diff --git a/docs/api_docs/python/tfc/ContinuousBatchedEntropyModel.md b/docs/api_docs/python/tfc/ContinuousBatchedEntropyModel.md
@@ -594,7 +594,7 @@ A JSON-serializable Python dict.
 
 <h3 id="get_weights"><code>get_weights</code></h3>
 
-<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L340-L341">View source</a>
+<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L341-L342">View source</a>
 
 <pre class="devsite-click-to-copy prettyprint lang-py tfo-signature-link">
 <code>get_weights()
@@ -658,7 +658,7 @@ A `tf.Tensor` containing the quantized values.
 
 <h3 id="set_weights"><code>set_weights</code></h3>
 
-<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L343-L348">View source</a>
+<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L344-L349">View source</a>
 
 <pre class="devsite-click-to-copy prettyprint lang-py tfo-signature-link">
 <code>set_weights(
diff --git a/docs/api_docs/python/tfc/ContinuousIndexedEntropyModel.md b/docs/api_docs/python/tfc/ContinuousIndexedEntropyModel.md
@@ -618,7 +618,7 @@ Returns the configuration of the entropy model.
 
 <h3 id="get_weights"><code>get_weights</code></h3>
 
-<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L340-L341">View source</a>
+<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L341-L342">View source</a>
 
 <pre class="devsite-click-to-copy prettyprint lang-py tfo-signature-link">
 <code>get_weights()
@@ -678,7 +678,7 @@ A `tf.Tensor` containing the quantized values.
 
 <h3 id="set_weights"><code>set_weights</code></h3>
 
-<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L343-L348">View source</a>
+<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L344-L349">View source</a>
 
 <pre class="devsite-click-to-copy prettyprint lang-py tfo-signature-link">
 <code>set_weights(
diff --git a/docs/api_docs/python/tfc/GDN.md b/docs/api_docs/python/tfc/GDN.md
@@ -682,9 +682,7 @@ may also be zero-argument callables which create a loss tensor.
 `**kwargs`
 </td>
 <td>
-Additional keyword arguments for backward compatibility.
-Accepted values:
-  inputs - Deprecated, will be automatically inferred.
+Used for backwards compatibility only.
 </td>
 </tr>
 </table>
diff --git a/docs/api_docs/python/tfc/LocationScaleIndexedEntropyModel.md b/docs/api_docs/python/tfc/LocationScaleIndexedEntropyModel.md
@@ -543,7 +543,7 @@ Returns the configuration of the entropy model.
 
 <h3 id="get_weights"><code>get_weights</code></h3>
 
-<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L340-L341">View source</a>
+<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L341-L342">View source</a>
 
 <pre class="devsite-click-to-copy prettyprint lang-py tfo-signature-link">
 <code>get_weights()
@@ -614,7 +614,7 @@ A `tf.Tensor` containing the quantized values.
 
 <h3 id="set_weights"><code>set_weights</code></h3>
 
-<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L343-L348">View source</a>
+<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L344-L349">View source</a>
 
 <pre class="devsite-click-to-copy prettyprint lang-py tfo-signature-link">
 <code>set_weights(
diff --git a/docs/api_docs/python/tfc/SignalConv1D.md b/docs/api_docs/python/tfc/SignalConv1D.md
@@ -893,9 +893,7 @@ may also be zero-argument callables which create a loss tensor.
 `**kwargs`
 </td>
 <td>
-Additional keyword arguments for backward compatibility.
-Accepted values:
-  inputs - Deprecated, will be automatically inferred.
+Used for backwards compatibility only.
 </td>
 </tr>
 </table>
diff --git a/docs/api_docs/python/tfc/SignalConv2D.md b/docs/api_docs/python/tfc/SignalConv2D.md
@@ -893,9 +893,7 @@ may also be zero-argument callables which create a loss tensor.
 `**kwargs`
 </td>
 <td>
-Additional keyword arguments for backward compatibility.
-Accepted values:
-  inputs - Deprecated, will be automatically inferred.
+Used for backwards compatibility only.
 </td>
 </tr>
 </table>
diff --git a/docs/api_docs/python/tfc/SignalConv3D.md b/docs/api_docs/python/tfc/SignalConv3D.md
@@ -893,9 +893,7 @@ may also be zero-argument callables which create a loss tensor.
 `**kwargs`
 </td>
 <td>
-Additional keyword arguments for backward compatibility.
-Accepted values:
-  inputs - Deprecated, will be automatically inferred.
+Used for backwards compatibility only.
 </td>
 </tr>
 </table>
diff --git a/docs/api_docs/python/tfc/SoftRound.md b/docs/api_docs/python/tfc/SoftRound.md
@@ -403,9 +403,7 @@ may also be zero-argument callables which create a loss tensor.
 `**kwargs`
 </td>
 <td>
-Additional keyword arguments for backward compatibility.
-Accepted values:
-  inputs - Deprecated, will be automatically inferred.
+Used for backwards compatibility only.
 </td>
 </tr>
 </table>
diff --git a/docs/api_docs/python/tfc/SoftRoundConditionalMean.md b/docs/api_docs/python/tfc/SoftRoundConditionalMean.md
@@ -403,9 +403,7 @@ may also be zero-argument callables which create a loss tensor.
 `**kwargs`
 </td>
 <td>
-Additional keyword arguments for backward compatibility.
-Accepted values:
-  inputs - Deprecated, will be automatically inferred.
+Used for backwards compatibility only.
 </td>
 </tr>
 </table>
diff --git a/docs/api_docs/python/tfc/UniversalBatchedEntropyModel.md b/docs/api_docs/python/tfc/UniversalBatchedEntropyModel.md
@@ -489,7 +489,7 @@ with `compression=False` or with `stateless=True`.
 
 <h3 id="get_weights"><code>get_weights</code></h3>
 
-<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L340-L341">View source</a>
+<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L341-L342">View source</a>
 
 <pre class="devsite-click-to-copy prettyprint lang-py tfo-signature-link">
 <code>get_weights()
@@ -500,7 +500,7 @@ with `compression=False` or with `stateless=True`.
 
 <h3 id="set_weights"><code>set_weights</code></h3>
 
-<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L343-L348">View source</a>
+<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L344-L349">View source</a>
 
 <pre class="devsite-click-to-copy prettyprint lang-py tfo-signature-link">
 <code>set_weights(
diff --git a/docs/api_docs/python/tfc/UniversalIndexedEntropyModel.md b/docs/api_docs/python/tfc/UniversalIndexedEntropyModel.md
@@ -540,7 +540,7 @@ with `compression=False` or with `stateless=True`.
 
 <h3 id="get_weights"><code>get_weights</code></h3>
 
-<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L340-L341">View source</a>
+<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L341-L342">View source</a>
 
 <pre class="devsite-click-to-copy prettyprint lang-py tfo-signature-link">
 <code>get_weights()
@@ -551,7 +551,7 @@ with `compression=False` or with `stateless=True`.
 
 <h3 id="set_weights"><code>set_weights</code></h3>
 
-<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L343-L348">View source</a>
+<a target="_blank" href="https://github.com/tensorflow/compression/tree/master/tensorflow_compression/python/entropy_models/continuous_base.py#L344-L349">View source</a>
 
 <pre class="devsite-click-to-copy prettyprint lang-py tfo-signature-link">
 <code>set_weights(
diff --git a/docs/api_docs/python/tfc/Y4MDataset.md b/docs/api_docs/python/tfc/Y4MDataset.md
@@ -2772,37 +2772,29 @@ distribution of `init_dist` needs to be resampled into a dataset with
 `target_dist` distribution.
 
 ```
->>> import collections
->>> initial_dist = [0.5, 0.5]
->>> target_dist = [0.6, 0.4]
+>>> initial_dist = [0.6, 0.4]
 >>> num_classes = len(initial_dist)
->>> num_samples = 100000
+>>> num_samples = 1000
 >>> data_np = np.random.choice(num_classes, num_samples, p=initial_dist)
 >>> dataset = tf.data.Dataset.from_tensor_slices(data_np)
->>> x = collections.defaultdict(int)
->>> for i in dataset:
-...   x[i.numpy()] += 1
 ```
 
 The value of `x` will be close to `{0: 50000, 1: 50000}` as per the
 `initial_dist` distribution.
 
 ```
->>> dataset = dataset.rejection_resample(
-...    class_func=lambda x: x % 2,
+>>> target_dist = [0.5, 0.5]
+>>> resampled_dataset = dataset.rejection_resample(
+...    class_func=lambda x: x,
 ...    target_dist=target_dist,
 ...    initial_dist=initial_dist)
+>>> resampled_dataset = resampled_dataset.map(
+...     lambda class_func_result, data: data)
 ```
 
-```
->>> y = collections.defaultdict(int)
->>> for i in dataset:
-...   cls, _ = i
-...   y[cls.numpy()] += 1
-```
 
-The value of `y` will be now be close to `{0: 75000, 1: 50000}` thus
-satisfying the `target_dist` distribution.
+The value distribution of classes in the resampled_distribution will be now
+be close to the target distribution.
 
 <!-- Tabular view -->
  <table class="responsive fixed orange">
diff --git a/docs/api_docs/python/tfc/all_symbols.md b/docs/api_docs/python/tfc/all_symbols.md
@@ -51,6 +51,8 @@
 *  <a href="../tfc/pmf_to_quantized_cdf.md"><code>tfc.pmf_to_quantized_cdf</code></a>
 *  <a href="../tfc/quantization_offset.md"><code>tfc.quantization_offset</code></a>
 *  <a href="../tfc/round_st.md"><code>tfc.round_st</code></a>
+*  <a href="../tfc/run_length_gamma_decode.md"><code>tfc.run_length_gamma_decode</code></a>
+*  <a href="../tfc/run_length_gamma_encode.md"><code>tfc.run_length_gamma_encode</code></a>
 *  <a href="../tfc/same_padding_for_kernel.md"><code>tfc.same_padding_for_kernel</code></a>
 *  <a href="../tfc/soft_round.md"><code>tfc.soft_round</code></a>
 *  <a href="../tfc/soft_round_conditional_mean.md"><code>tfc.soft_round_conditional_mean</code></a>
diff --git a/docs/api_docs/python/tfc/run_length_gamma_decode.md b/docs/api_docs/python/tfc/run_length_gamma_decode.md
@@ -0,0 +1,78 @@
+description: Decodes data using run-length and Elias gamma coding.
+
+<div itemscope itemtype="http://developers.google.com/ReferenceObject">
+<meta itemprop="name" content="tfc.run_length_gamma_decode" />
+<meta itemprop="path" content="Stable" />
+</div>
+
+# tfc.run_length_gamma_decode
+
+<!-- Insert buttons and diff -->
+
+<table class="tfo-notebook-buttons tfo-api nocontent" align="left">
+
+</table>
+
+
+
+Decodes `data` using run-length and Elias gamma coding.
+
+<pre class="devsite-click-to-copy prettyprint lang-py tfo-signature-link">
+<code>tfc.run_length_gamma_decode(
+    code, shape, name=None
+)
+</code></pre>
+
+
+
+<!-- Placeholder for "Used in" -->
+
+This is the inverse operation to `RunLengthGammaEncode`. The shape of the tensor
+that was encoded must be known by the caller.
+
+<!-- Tabular view -->
+ <table class="responsive fixed orange">
+<colgroup><col width="214px"><col></colgroup>
+<tr><th colspan="2"><h2 class="add-link">Args</h2></th></tr>
+
+<tr>
+<td>
+`code`
+</td>
+<td>
+A `Tensor` of type `string`.
+An encoded scalar string as returned by `RunLengthGammaEncode`.
+</td>
+</tr><tr>
+<td>
+`shape`
+</td>
+<td>
+A `Tensor` of type `int32`.
+An int32 vector giving the shape of the encoded data.
+</td>
+</tr><tr>
+<td>
+`name`
+</td>
+<td>
+A name for the operation (optional).
+</td>
+</tr>
+</table>
+
+
+
+<!-- Tabular view -->
+ <table class="responsive fixed orange">
+<colgroup><col width="214px"><col></colgroup>
+<tr><th colspan="2"><h2 class="add-link">Returns</h2></th></tr>
+<tr class="alt">
+<td colspan="2">
+A `Tensor` of type `int32`.
+An int32 tensor of decoded values, with shape `shape`.
+</td>
+</tr>
+
+</table>
+
diff --git a/docs/api_docs/python/tfc/run_length_gamma_encode.md b/docs/api_docs/python/tfc/run_length_gamma_encode.md
@@ -0,0 +1,66 @@
+description: Encodes data using run-length and Elias gamma coding.
+
+<div itemscope itemtype="http://developers.google.com/ReferenceObject">
+<meta itemprop="name" content="tfc.run_length_gamma_encode" />
+<meta itemprop="path" content="Stable" />
+</div>
+
+# tfc.run_length_gamma_encode
+
+<!-- Insert buttons and diff -->
+
+<table class="tfo-notebook-buttons tfo-api nocontent" align="left">
+
+</table>
+
+
+
+Encodes `data` using run-length and Elias gamma coding.
+
+<pre class="devsite-click-to-copy prettyprint lang-py tfo-signature-link">
+<code>tfc.run_length_gamma_encode(
+    data, name=None
+)
+</code></pre>
+
+
+
+<!-- Placeholder for "Used in" -->
+
+
+<!-- Tabular view -->
+ <table class="responsive fixed orange">
+<colgroup><col width="214px"><col></colgroup>
+<tr><th colspan="2"><h2 class="add-link">Args</h2></th></tr>
+
+<tr>
+<td>
+`data`
+</td>
+<td>
+A `Tensor` of type `int32`. An int32 tensor of values to be encoded.
+</td>
+</tr><tr>
+<td>
+`name`
+</td>
+<td>
+A name for the operation (optional).
+</td>
+</tr>
+</table>
+
+
+
+<!-- Tabular view -->
+ <table class="responsive fixed orange">
+<colgroup><col width="214px"><col></colgroup>
+<tr><th colspan="2"><h2 class="add-link">Returns</h2></th></tr>
+<tr class="alt">
+<td colspan="2">
+A `Tensor` of type `string`. An encoded scalar string.
+</td>
+</tr>
+
+</table>
+
