Automated documentation update

PiperOrigin-RevId: 279149682

Author: Conchylicultor

docs/api_docs/python/_toc.yaml

@@ -171,6 +171,8 @@ toc:
     path: /datasets/api_docs/python/tfds/testing/mock_data
   - title: mock_kaggle_api
     path: /datasets/api_docs/python/tfds/testing/mock_kaggle_api
+  - title: RaggedConstant
+    path: /datasets/api_docs/python/tfds/testing/RaggedConstant
   - title: rm_tmp_dir
     path: /datasets/api_docs/python/tfds/testing/rm_tmp_dir
   - title: run_in_graph_and_eager_modes

docs/api_docs/python/index.md

@@ -78,6 +78,7 @@
 *   <a href="./tfds/testing/FeatureExpectationItem.md"><code>tfds.testing.FeatureExpectationItem</code></a>
 *   <a href="./tfds/testing/FeatureExpectationsTestCase.md"><code>tfds.testing.FeatureExpectationsTestCase</code></a>
 *   <a href="./tfds/testing/DatasetBuilderTestCase/failureException.md"><code>tfds.testing.FeatureExpectationsTestCase.failureException</code></a>
+*   <a href="./tfds/testing/RaggedConstant.md"><code>tfds.testing.RaggedConstant</code></a>
 *   <a href="./tfds/testing/SubTestCase.md"><code>tfds.testing.SubTestCase</code></a>
 *   <a href="./tfds/testing/DatasetBuilderTestCase/failureException.md"><code>tfds.testing.SubTestCase.failureException</code></a>
 *   <a href="./tfds/testing/TestCase.md"><code>tfds.testing.TestCase</code></a>

docs/api_docs/python/tfds/_api_cache.json

@@ -183,6 +183,7 @@
     "tfds.testing.FeatureExpectationsTestCase.failureException.args": "tfds.download.DownloadError.args", 
     "tfds.testing.FeatureExpectationsTestCase.failureException.message": "tfds.download.DownloadError.message", 
     "tfds.testing.FeatureExpectationsTestCase.tempfile_cleanup": "tfds.testing.DatasetBuilderTestCase.tempfile_cleanup", 
+    "tfds.testing.RaggedConstant.__new__": "tfds.core.BeamBasedBuilder.__new__", 
     "tfds.testing.SubTestCase.__new__": "tfds.core.BeamBasedBuilder.__new__", 
     "tfds.testing.SubTestCase.failureException": "tfds.testing.DatasetBuilderTestCase.failureException", 
     "tfds.testing.SubTestCase.failureException.__getitem__": "tfds.download.DownloadError.__getitem__", 
@@ -540,6 +541,7 @@
     "tfds.features.Audio.__new__": true, 
     "tfds.features.Audio.decode_batch_example": true, 
     "tfds.features.Audio.decode_example": true, 
+    "tfds.features.Audio.decode_ragged_example": true, 
     "tfds.features.Audio.dtype": true, 
     "tfds.features.Audio.encode_example": true, 
     "tfds.features.Audio.get_serialized_info": true, 
@@ -574,6 +576,7 @@
     "tfds.features.BBoxFeature.__new__": true, 
     "tfds.features.BBoxFeature.decode_batch_example": true, 
     "tfds.features.BBoxFeature.decode_example": true, 
+    "tfds.features.BBoxFeature.decode_ragged_example": true, 
     "tfds.features.BBoxFeature.dtype": true, 
     "tfds.features.BBoxFeature.encode_example": true, 
     "tfds.features.BBoxFeature.get_serialized_info": true, 
@@ -586,6 +589,7 @@
     "tfds.features.ClassLabel.__new__": true, 
     "tfds.features.ClassLabel.decode_batch_example": true, 
     "tfds.features.ClassLabel.decode_example": true, 
+    "tfds.features.ClassLabel.decode_ragged_example": true, 
     "tfds.features.ClassLabel.dtype": true, 
     "tfds.features.ClassLabel.encode_example": true, 
     "tfds.features.ClassLabel.get_serialized_info": true, 
@@ -602,6 +606,7 @@
     "tfds.features.FeatureConnector.__new__": true, 
     "tfds.features.FeatureConnector.decode_batch_example": true, 
     "tfds.features.FeatureConnector.decode_example": true, 
+    "tfds.features.FeatureConnector.decode_ragged_example": true, 
     "tfds.features.FeatureConnector.dtype": true, 
     "tfds.features.FeatureConnector.encode_example": true, 
     "tfds.features.FeatureConnector.get_serialized_info": true, 
@@ -618,6 +623,7 @@
     "tfds.features.FeaturesDict.__new__": true, 
     "tfds.features.FeaturesDict.decode_batch_example": true, 
     "tfds.features.FeaturesDict.decode_example": true, 
+    "tfds.features.FeaturesDict.decode_ragged_example": true, 
     "tfds.features.FeaturesDict.dtype": true, 
     "tfds.features.FeaturesDict.encode_example": true, 
     "tfds.features.FeaturesDict.get_serialized_info": true, 
@@ -633,6 +639,7 @@
     "tfds.features.Image.__new__": true, 
     "tfds.features.Image.decode_batch_example": true, 
     "tfds.features.Image.decode_example": true, 
+    "tfds.features.Image.decode_ragged_example": true, 
     "tfds.features.Image.dtype": true, 
     "tfds.features.Image.encode_example": true, 
     "tfds.features.Image.get_serialized_info": true, 
@@ -649,6 +656,7 @@
     "tfds.features.Sequence.__new__": true, 
     "tfds.features.Sequence.decode_batch_example": true, 
     "tfds.features.Sequence.decode_example": true, 
+    "tfds.features.Sequence.decode_ragged_example": true, 
     "tfds.features.Sequence.dtype": true, 
     "tfds.features.Sequence.encode_example": true, 
     "tfds.features.Sequence.feature": true, 
@@ -662,6 +670,7 @@
     "tfds.features.Tensor.__new__": true, 
     "tfds.features.Tensor.decode_batch_example": true, 
     "tfds.features.Tensor.decode_example": true, 
+    "tfds.features.Tensor.decode_ragged_example": true, 
     "tfds.features.Tensor.dtype": true, 
     "tfds.features.Tensor.encode_example": true, 
     "tfds.features.Tensor.get_serialized_info": true, 
@@ -679,6 +688,7 @@
     "tfds.features.Text.__new__": true, 
     "tfds.features.Text.decode_batch_example": true, 
     "tfds.features.Text.decode_example": true, 
+    "tfds.features.Text.decode_ragged_example": true, 
     "tfds.features.Text.dtype": true, 
     "tfds.features.Text.encode_example": true, 
     "tfds.features.Text.encoder": true, 
@@ -698,6 +708,7 @@
     "tfds.features.Video.__new__": true, 
     "tfds.features.Video.decode_batch_example": true, 
     "tfds.features.Video.decode_example": true, 
+    "tfds.features.Video.decode_ragged_example": true, 
     "tfds.features.Video.dtype": true, 
     "tfds.features.Video.encode_example": true, 
     "tfds.features.Video.feature": true, 
@@ -1108,6 +1119,10 @@
     "tfds.testing.FeatureExpectationsTestCase.tearDownClass": true, 
     "tfds.testing.FeatureExpectationsTestCase.tempfile_cleanup": true, 
     "tfds.testing.FeatureExpectationsTestCase.test_session": true, 
+    "tfds.testing.RaggedConstant": false, 
+    "tfds.testing.RaggedConstant.__init__": true, 
+    "tfds.testing.RaggedConstant.__new__": true, 
+    "tfds.testing.RaggedConstant.build": true, 
     "tfds.testing.SubTestCase": false, 
     "tfds.testing.SubTestCase.MOCK_MONARCH": true, 
     "tfds.testing.SubTestCase.__call__": true, 

docs/api_docs/python/tfds/features/Audio.md

@@ -6,6 +6,7 @@
 <meta itemprop="property" content="__init__"/>
 <meta itemprop="property" content="decode_batch_example"/>
 <meta itemprop="property" content="decode_example"/>
+<meta itemprop="property" content="decode_ragged_example"/>
 <meta itemprop="property" content="encode_example"/>
 <meta itemprop="property" content="get_serialized_info"/>
 <meta itemprop="property" content="get_tensor_info"/>
@@ -102,6 +103,17 @@ graph (in `tf.data.Dataset.map(features.decode_example)`).
 *   <b>`tensor_data`</b>: Tensor or dictionary of tensor, output of the
     tf.data.Dataset object
 
+<h3 id="decode_ragged_example"><code>decode_ragged_example</code></h3>
+
+<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/feature.py">View
+source</a>
+
+```python
+decode_ragged_example(example_data)
+```
+
+See base class for details.
+
 <h3 id="encode_example"><code>encode_example</code></h3>
 
 <a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/audio_feature.py">View

docs/api_docs/python/tfds/features/BBoxFeature.md

@@ -6,6 +6,7 @@
 <meta itemprop="property" content="__init__"/>
 <meta itemprop="property" content="decode_batch_example"/>
 <meta itemprop="property" content="decode_example"/>
+<meta itemprop="property" content="decode_ragged_example"/>
 <meta itemprop="property" content="encode_example"/>
 <meta itemprop="property" content="get_serialized_info"/>
 <meta itemprop="property" content="get_tensor_info"/>
@@ -122,6 +123,17 @@ graph (in `tf.data.Dataset.map(features.decode_example)`).
 *   <b>`tensor_data`</b>: Tensor or dictionary of tensor, output of the
     tf.data.Dataset object
 
+<h3 id="decode_ragged_example"><code>decode_ragged_example</code></h3>
+
+<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/feature.py">View
+source</a>
+
+```python
+decode_ragged_example(example_data)
+```
+
+See base class for details.
+
 <h3 id="encode_example"><code>encode_example</code></h3>
 
 <a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/bounding_boxes.py">View

docs/api_docs/python/tfds/features/ClassLabel.md

@@ -8,6 +8,7 @@
 <meta itemprop="property" content="__init__"/>
 <meta itemprop="property" content="decode_batch_example"/>
 <meta itemprop="property" content="decode_example"/>
+<meta itemprop="property" content="decode_ragged_example"/>
 <meta itemprop="property" content="encode_example"/>
 <meta itemprop="property" content="get_serialized_info"/>
 <meta itemprop="property" content="get_tensor_info"/>
@@ -123,6 +124,17 @@ graph (in `tf.data.Dataset.map(features.decode_example)`).
 *   <b>`tensor_data`</b>: Tensor or dictionary of tensor, output of the
     tf.data.Dataset object
 
+<h3 id="decode_ragged_example"><code>decode_ragged_example</code></h3>
+
+<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/feature.py">View
+source</a>
+
+```python
+decode_ragged_example(example_data)
+```
+
+See base class for details.
+
 <h3 id="encode_example"><code>encode_example</code></h3>
 
 <a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/class_label_feature.py">View

docs/api_docs/python/tfds/features/FeatureConnector.md

@@ -5,6 +5,7 @@
 <meta itemprop="property" content="shape"/>
 <meta itemprop="property" content="decode_batch_example"/>
 <meta itemprop="property" content="decode_example"/>
+<meta itemprop="property" content="decode_ragged_example"/>
 <meta itemprop="property" content="encode_example"/>
 <meta itemprop="property" content="get_serialized_info"/>
 <meta itemprop="property" content="get_tensor_info"/>
@@ -107,6 +108,33 @@ graph (in `tf.data.Dataset.map(features.decode_example)`).
 *   <b>`tensor_data`</b>: Tensor or dictionary of tensor, output of the
     tf.data.Dataset object
 
+<h3 id="decode_ragged_example"><code>decode_ragged_example</code></h3>
+
+<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/feature.py">View
+source</a>
+
+```python
+decode_ragged_example(tfexample_data)
+```
+
+Decode nested features from a tf.RaggedTensor.
+
+This function is used to decode features wrapped in nested
+<a href="../../tfds/features/Sequence.md"><code>tfds.features.Sequence()</code></a>.
+By default, this function apply `decode_batch_example` on the flat values of the
+ragged tensor. For optimization, features can overwrite this method to apply a
+custom batch decoding.
+
+#### Args:
+
+*   <b>`tfexample_data`</b>: `tf.RaggedTensor` inputs containing the nested
+    encoded examples.
+
+#### Returns:
+
+*   <b>`tensor_data`</b>: The decoded `tf.RaggedTensor` or dictionary of tensor,
+    output of the tf.data.Dataset object
+
 <h3 id="encode_example"><code>encode_example</code></h3>
 
 <a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/feature.py">View

docs/api_docs/python/tfds/features/FeaturesDict.md

@@ -10,6 +10,7 @@
 <meta itemprop="property" content="__len__"/>
 <meta itemprop="property" content="decode_batch_example"/>
 <meta itemprop="property" content="decode_example"/>
+<meta itemprop="property" content="decode_ragged_example"/>
 <meta itemprop="property" content="encode_example"/>
 <meta itemprop="property" content="get_serialized_info"/>
 <meta itemprop="property" content="get_tensor_info"/>
@@ -223,6 +224,33 @@ Decode the serialize examples.
 
 *   <b>`example`</b>: Nested `dict` containing the decoded nested examples.
 
+<h3 id="decode_ragged_example"><code>decode_ragged_example</code></h3>
+
+<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/feature.py">View
+source</a>
+
+```python
+decode_ragged_example(tfexample_data)
+```
+
+Decode nested features from a tf.RaggedTensor.
+
+This function is used to decode features wrapped in nested
+<a href="../../tfds/features/Sequence.md"><code>tfds.features.Sequence()</code></a>.
+By default, this function apply `decode_batch_example` on the flat values of the
+ragged tensor. For optimization, features can overwrite this method to apply a
+custom batch decoding.
+
+#### Args:
+
+*   <b>`tfexample_data`</b>: `tf.RaggedTensor` inputs containing the nested
+    encoded examples.
+
+#### Returns:
+
+*   <b>`tensor_data`</b>: The decoded `tf.RaggedTensor` or dictionary of tensor,
+    output of the tf.data.Dataset object
+
 <h3 id="encode_example"><code>encode_example</code></h3>
 
 <a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/features_dict.py">View

docs/api_docs/python/tfds/features/Image.md

@@ -6,6 +6,7 @@
 <meta itemprop="property" content="__init__"/>
 <meta itemprop="property" content="decode_batch_example"/>
 <meta itemprop="property" content="decode_example"/>
+<meta itemprop="property" content="decode_ragged_example"/>
 <meta itemprop="property" content="encode_example"/>
 <meta itemprop="property" content="get_serialized_info"/>
 <meta itemprop="property" content="get_tensor_info"/>
@@ -155,6 +156,33 @@ decode_example(example)
 
 Reconstruct the image from the tf example.
 
+<h3 id="decode_ragged_example"><code>decode_ragged_example</code></h3>
+
+<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/feature.py">View
+source</a>
+
+```python
+decode_ragged_example(tfexample_data)
+```
+
+Decode nested features from a tf.RaggedTensor.
+
+This function is used to decode features wrapped in nested
+<a href="../../tfds/features/Sequence.md"><code>tfds.features.Sequence()</code></a>.
+By default, this function apply `decode_batch_example` on the flat values of the
+ragged tensor. For optimization, features can overwrite this method to apply a
+custom batch decoding.
+
+#### Args:
+
+*   <b>`tfexample_data`</b>: `tf.RaggedTensor` inputs containing the nested
+    encoded examples.
+
+#### Returns:
+
+*   <b>`tensor_data`</b>: The decoded `tf.RaggedTensor` or dictionary of tensor,
+    output of the tf.data.Dataset object
+
 <h3 id="encode_example"><code>encode_example</code></h3>
 
 <a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/image_feature.py">View

docs/api_docs/python/tfds/features/Sequence.md

@@ -8,6 +8,7 @@
 <meta itemprop="property" content="__init__"/>
 <meta itemprop="property" content="decode_batch_example"/>
 <meta itemprop="property" content="decode_example"/>
+<meta itemprop="property" content="decode_ragged_example"/>
 <meta itemprop="property" content="encode_example"/>
 <meta itemprop="property" content="get_serialized_info"/>
 <meta itemprop="property" content="get_tensor_info"/>
@@ -183,6 +184,33 @@ Decode the serialize examples.
 
 *   <b>`example`</b>: Nested `dict` containing the decoded nested examples.
 
+<h3 id="decode_ragged_example"><code>decode_ragged_example</code></h3>
+
+<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/feature.py">View
+source</a>
+
+```python
+decode_ragged_example(tfexample_data)
+```
+
+Decode nested features from a tf.RaggedTensor.
+
+This function is used to decode features wrapped in nested
+<a href="../../tfds/features/Sequence.md"><code>tfds.features.Sequence()</code></a>.
+By default, this function apply `decode_batch_example` on the flat values of the
+ragged tensor. For optimization, features can overwrite this method to apply a
+custom batch decoding.
+
+#### Args:
+
+*   <b>`tfexample_data`</b>: `tf.RaggedTensor` inputs containing the nested
+    encoded examples.
+
+#### Returns:
+
+*   <b>`tensor_data`</b>: The decoded `tf.RaggedTensor` or dictionary of tensor,
+    output of the tf.data.Dataset object
+
 <h3 id="encode_example"><code>encode_example</code></h3>
 
 <a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/sequence_feature.py">View