Automated documentation update

PiperOrigin-RevId: 281565948

Author: Conchylicultor

docs/api_docs/python/tfds/_api_cache.json

@@ -8,19 +8,25 @@
     "tfds.core.BeamBasedBuilder.BUILDER_CONFIGS": "tfds.core.DatasetBuilder.BUILDER_CONFIGS", 
     "tfds.core.BeamBasedBuilder.SUPPORTED_VERSIONS": "tfds.core.DatasetBuilder.SUPPORTED_VERSIONS", 
     "tfds.core.BeamBasedBuilder.builder_config": "tfds.core.DatasetBuilder.builder_config", 
+    "tfds.core.BeamBasedBuilder.canonical_version": "tfds.core.DatasetBuilder.canonical_version", 
     "tfds.core.BeamBasedBuilder.data_dir": "tfds.core.DatasetBuilder.data_dir", 
     "tfds.core.BeamBasedBuilder.info": "tfds.core.DatasetBuilder.info", 
+    "tfds.core.BeamBasedBuilder.supported_versions": "tfds.core.DatasetBuilder.supported_versions", 
     "tfds.core.BeamBasedBuilder.version": "tfds.core.DatasetBuilder.version", 
+    "tfds.core.BeamBasedBuilder.versions": "tfds.core.DatasetBuilder.versions", 
     "tfds.core.BuilderConfig.__new__": "tfds.core.BeamBasedBuilder.__new__", 
     "tfds.core.DatasetBuilder.__new__": "tfds.core.BeamBasedBuilder.__new__", 
     "tfds.core.DatasetInfo.__new__": "tfds.core.BeamBasedBuilder.__new__", 
     "tfds.core.GeneratorBasedBuilder.BUILDER_CONFIGS": "tfds.core.DatasetBuilder.BUILDER_CONFIGS", 
     "tfds.core.GeneratorBasedBuilder.SUPPORTED_VERSIONS": "tfds.core.DatasetBuilder.SUPPORTED_VERSIONS", 
     "tfds.core.GeneratorBasedBuilder.__new__": "tfds.core.BeamBasedBuilder.__new__", 
     "tfds.core.GeneratorBasedBuilder.builder_config": "tfds.core.DatasetBuilder.builder_config", 
+    "tfds.core.GeneratorBasedBuilder.canonical_version": "tfds.core.DatasetBuilder.canonical_version", 
     "tfds.core.GeneratorBasedBuilder.data_dir": "tfds.core.DatasetBuilder.data_dir", 
     "tfds.core.GeneratorBasedBuilder.info": "tfds.core.DatasetBuilder.info", 
+    "tfds.core.GeneratorBasedBuilder.supported_versions": "tfds.core.DatasetBuilder.supported_versions", 
     "tfds.core.GeneratorBasedBuilder.version": "tfds.core.DatasetBuilder.version", 
+    "tfds.core.GeneratorBasedBuilder.versions": "tfds.core.DatasetBuilder.versions", 
     "tfds.core.Metadata.__contains__": "tfds.core.BeamMetadataDict.__contains__", 
     "tfds.core.Metadata.__eq__": "tfds.core.BeamMetadataDict.__eq__", 
     "tfds.core.Metadata.__ge__": "tfds.core.BeamMetadataDict.__ge__", 
@@ -164,16 +170,22 @@
     "tfds.testing.DummyDatasetSharedGenerator.BUILDER_CONFIGS": "tfds.core.DatasetBuilder.BUILDER_CONFIGS", 
     "tfds.testing.DummyDatasetSharedGenerator.__new__": "tfds.core.BeamBasedBuilder.__new__", 
     "tfds.testing.DummyDatasetSharedGenerator.builder_config": "tfds.core.DatasetBuilder.builder_config", 
+    "tfds.testing.DummyDatasetSharedGenerator.canonical_version": "tfds.core.DatasetBuilder.canonical_version", 
     "tfds.testing.DummyDatasetSharedGenerator.data_dir": "tfds.core.DatasetBuilder.data_dir", 
     "tfds.testing.DummyDatasetSharedGenerator.info": "tfds.core.DatasetBuilder.info", 
+    "tfds.testing.DummyDatasetSharedGenerator.supported_versions": "tfds.core.DatasetBuilder.supported_versions", 
     "tfds.testing.DummyDatasetSharedGenerator.version": "tfds.core.DatasetBuilder.version", 
+    "tfds.testing.DummyDatasetSharedGenerator.versions": "tfds.core.DatasetBuilder.versions", 
     "tfds.testing.DummyMnist.BUILDER_CONFIGS": "tfds.core.DatasetBuilder.BUILDER_CONFIGS", 
     "tfds.testing.DummyMnist.SUPPORTED_VERSIONS": "tfds.core.DatasetBuilder.SUPPORTED_VERSIONS", 
     "tfds.testing.DummyMnist.__new__": "tfds.core.BeamBasedBuilder.__new__", 
     "tfds.testing.DummyMnist.builder_config": "tfds.core.DatasetBuilder.builder_config", 
+    "tfds.testing.DummyMnist.canonical_version": "tfds.core.DatasetBuilder.canonical_version", 
     "tfds.testing.DummyMnist.data_dir": "tfds.core.DatasetBuilder.data_dir", 
     "tfds.testing.DummyMnist.info": "tfds.core.DatasetBuilder.info", 
+    "tfds.testing.DummyMnist.supported_versions": "tfds.core.DatasetBuilder.supported_versions", 
     "tfds.testing.DummyMnist.version": "tfds.core.DatasetBuilder.version", 
+    "tfds.testing.DummyMnist.versions": "tfds.core.DatasetBuilder.versions", 
     "tfds.testing.FeatureExpectationItem.__new__": "tfds.core.BeamBasedBuilder.__new__", 
     "tfds.testing.FeatureExpectationsTestCase.__new__": "tfds.core.BeamBasedBuilder.__new__", 
     "tfds.testing.FeatureExpectationsTestCase.failureException": "tfds.testing.DatasetBuilderTestCase.failureException", 
@@ -227,11 +239,14 @@
     "tfds.core.BeamBasedBuilder.as_dataset": true, 
     "tfds.core.BeamBasedBuilder.builder_config": true, 
     "tfds.core.BeamBasedBuilder.builder_configs": true, 
+    "tfds.core.BeamBasedBuilder.canonical_version": true, 
     "tfds.core.BeamBasedBuilder.data_dir": true, 
     "tfds.core.BeamBasedBuilder.download_and_prepare": true, 
     "tfds.core.BeamBasedBuilder.info": true, 
     "tfds.core.BeamBasedBuilder.name": true, 
+    "tfds.core.BeamBasedBuilder.supported_versions": true, 
     "tfds.core.BeamBasedBuilder.version": true, 
+    "tfds.core.BeamBasedBuilder.versions": true, 
     "tfds.core.BeamMetadataDict": false, 
     "tfds.core.BeamMetadataDict.__contains__": true, 
     "tfds.core.BeamMetadataDict.__eq__": true, 
@@ -281,11 +296,14 @@
     "tfds.core.DatasetBuilder.as_dataset": true, 
     "tfds.core.DatasetBuilder.builder_config": true, 
     "tfds.core.DatasetBuilder.builder_configs": true, 
+    "tfds.core.DatasetBuilder.canonical_version": true, 
     "tfds.core.DatasetBuilder.data_dir": true, 
     "tfds.core.DatasetBuilder.download_and_prepare": true, 
     "tfds.core.DatasetBuilder.info": true, 
     "tfds.core.DatasetBuilder.name": true, 
+    "tfds.core.DatasetBuilder.supported_versions": true, 
     "tfds.core.DatasetBuilder.version": true, 
+    "tfds.core.DatasetBuilder.versions": true, 
     "tfds.core.DatasetInfo": false, 
     "tfds.core.DatasetInfo.__init__": true, 
     "tfds.core.DatasetInfo.__new__": true, 
@@ -321,11 +339,14 @@
     "tfds.core.GeneratorBasedBuilder.as_dataset": true, 
     "tfds.core.GeneratorBasedBuilder.builder_config": true, 
     "tfds.core.GeneratorBasedBuilder.builder_configs": true, 
+    "tfds.core.GeneratorBasedBuilder.canonical_version": true, 
     "tfds.core.GeneratorBasedBuilder.data_dir": true, 
     "tfds.core.GeneratorBasedBuilder.download_and_prepare": true, 
     "tfds.core.GeneratorBasedBuilder.info": true, 
     "tfds.core.GeneratorBasedBuilder.name": true, 
+    "tfds.core.GeneratorBasedBuilder.supported_versions": true, 
     "tfds.core.GeneratorBasedBuilder.version": true, 
+    "tfds.core.GeneratorBasedBuilder.versions": true, 
     "tfds.core.Metadata": false, 
     "tfds.core.Metadata.__contains__": true, 
     "tfds.core.Metadata.__eq__": true, 
@@ -954,11 +975,14 @@
     "tfds.testing.DummyDatasetSharedGenerator.as_dataset": true, 
     "tfds.testing.DummyDatasetSharedGenerator.builder_config": true, 
     "tfds.testing.DummyDatasetSharedGenerator.builder_configs": true, 
+    "tfds.testing.DummyDatasetSharedGenerator.canonical_version": true, 
     "tfds.testing.DummyDatasetSharedGenerator.data_dir": true, 
     "tfds.testing.DummyDatasetSharedGenerator.download_and_prepare": true, 
     "tfds.testing.DummyDatasetSharedGenerator.info": true, 
     "tfds.testing.DummyDatasetSharedGenerator.name": true, 
+    "tfds.testing.DummyDatasetSharedGenerator.supported_versions": true, 
     "tfds.testing.DummyDatasetSharedGenerator.version": true, 
+    "tfds.testing.DummyDatasetSharedGenerator.versions": true, 
     "tfds.testing.DummyMnist": false, 
     "tfds.testing.DummyMnist.BUILDER_CONFIGS": true, 
     "tfds.testing.DummyMnist.SUPPORTED_VERSIONS": true, 
@@ -968,11 +992,14 @@
     "tfds.testing.DummyMnist.as_dataset": true, 
     "tfds.testing.DummyMnist.builder_config": true, 
     "tfds.testing.DummyMnist.builder_configs": true, 
+    "tfds.testing.DummyMnist.canonical_version": true, 
     "tfds.testing.DummyMnist.data_dir": true, 
     "tfds.testing.DummyMnist.download_and_prepare": true, 
     "tfds.testing.DummyMnist.info": true, 
     "tfds.testing.DummyMnist.name": true, 
+    "tfds.testing.DummyMnist.supported_versions": true, 
     "tfds.testing.DummyMnist.version": true, 
+    "tfds.testing.DummyMnist.versions": true, 
     "tfds.testing.FeatureExpectationItem": false, 
     "tfds.testing.FeatureExpectationItem.__init__": true, 
     "tfds.testing.FeatureExpectationItem.__new__": true, 

docs/api_docs/python/tfds/core/BeamBasedBuilder.md

@@ -2,9 +2,12 @@
 <meta itemprop="name" content="tfds.core.BeamBasedBuilder" />
 <meta itemprop="path" content="Stable" />
 <meta itemprop="property" content="builder_config"/>
+<meta itemprop="property" content="canonical_version"/>
 <meta itemprop="property" content="data_dir"/>
 <meta itemprop="property" content="info"/>
+<meta itemprop="property" content="supported_versions"/>
 <meta itemprop="property" content="version"/>
+<meta itemprop="property" content="versions"/>
 <meta itemprop="property" content="__init__"/>
 <meta itemprop="property" content="as_dataset"/>
 <meta itemprop="property" content="download_and_prepare"/>
@@ -71,14 +74,22 @@ Callers must pass arguments as keyword arguments.
 
 <a href="../../tfds/core/BuilderConfig.md"><code>tfds.core.BuilderConfig</code></a> for this builder.
 
+<h3 id="canonical_version"><code>canonical_version</code></h3>
+
 <h3 id="data_dir"><code>data_dir</code></h3>
 
 <h3 id="info"><code>info</code></h3>
 
 <a href="../../tfds/core/DatasetInfo.md"><code>tfds.core.DatasetInfo</code></a> for this builder.
 
+<h3 id="supported_versions"><code>supported_versions</code></h3>
+
 <h3 id="version"><code>version</code></h3>
 
+<h3 id="versions"><code>versions</code></h3>
+
+Versions (canonical + availables), in preference order.
+
 ## Methods
 
 <h3 id="as_dataset"><code>as_dataset</code></h3>

docs/api_docs/python/tfds/core/DatasetBuilder.md

@@ -2,9 +2,12 @@
 <meta itemprop="name" content="tfds.core.DatasetBuilder" />
 <meta itemprop="path" content="Stable" />
 <meta itemprop="property" content="builder_config"/>
+<meta itemprop="property" content="canonical_version"/>
 <meta itemprop="property" content="data_dir"/>
 <meta itemprop="property" content="info"/>
+<meta itemprop="property" content="supported_versions"/>
 <meta itemprop="property" content="version"/>
+<meta itemprop="property" content="versions"/>
 <meta itemprop="property" content="__init__"/>
 <meta itemprop="property" content="as_dataset"/>
 <meta itemprop="property" content="download_and_prepare"/>
@@ -102,14 +105,22 @@ Callers must pass arguments as keyword arguments.
 
 <a href="../../tfds/core/BuilderConfig.md"><code>tfds.core.BuilderConfig</code></a> for this builder.
 
+<h3 id="canonical_version"><code>canonical_version</code></h3>
+
 <h3 id="data_dir"><code>data_dir</code></h3>
 
 <h3 id="info"><code>info</code></h3>
 
 <a href="../../tfds/core/DatasetInfo.md"><code>tfds.core.DatasetInfo</code></a> for this builder.
 
+<h3 id="supported_versions"><code>supported_versions</code></h3>
+
 <h3 id="version"><code>version</code></h3>
 
+<h3 id="versions"><code>versions</code></h3>
+
+Versions (canonical + availables), in preference order.
+
 ## Methods
 
 <h3 id="as_dataset"><code>as_dataset</code></h3>

docs/api_docs/python/tfds/core/GeneratorBasedBuilder.md

@@ -2,9 +2,12 @@
 <meta itemprop="name" content="tfds.core.GeneratorBasedBuilder" />
 <meta itemprop="path" content="Stable" />
 <meta itemprop="property" content="builder_config"/>
+<meta itemprop="property" content="canonical_version"/>
 <meta itemprop="property" content="data_dir"/>
 <meta itemprop="property" content="info"/>
+<meta itemprop="property" content="supported_versions"/>
 <meta itemprop="property" content="version"/>
+<meta itemprop="property" content="versions"/>
 <meta itemprop="property" content="__init__"/>
 <meta itemprop="property" content="as_dataset"/>
 <meta itemprop="property" content="download_and_prepare"/>
@@ -80,14 +83,22 @@ Callers must pass arguments as keyword arguments.
 
 <a href="../../tfds/core/BuilderConfig.md"><code>tfds.core.BuilderConfig</code></a> for this builder.
 
+<h3 id="canonical_version"><code>canonical_version</code></h3>
+
 <h3 id="data_dir"><code>data_dir</code></h3>
 
 <h3 id="info"><code>info</code></h3>
 
 <a href="../../tfds/core/DatasetInfo.md"><code>tfds.core.DatasetInfo</code></a> for this builder.
 
+<h3 id="supported_versions"><code>supported_versions</code></h3>
+
 <h3 id="version"><code>version</code></h3>
 
+<h3 id="versions"><code>versions</code></h3>
+
+Versions (canonical + availables), in preference order.
+
 ## Methods
 
 <h3 id="as_dataset"><code>as_dataset</code></h3>

docs/api_docs/python/tfds/core/Version.md

@@ -39,10 +39,23 @@ source</a>
 __init__(
     version_str,
     description=None,
-    experiments=None
+    experiments=None,
+    tfds_version_to_prepare=None
 )
 ```
 
+Version init.
+
+#### Args:
+
+*   <b>`version_str`</b>: string. Eg: "1.2.3".
+*   <b>`description`</b>: string, a description of what is new in this version.
+*   <b>`experiments`</b>: dict of experiments. See Experiment.
+*   <b>`tfds_version_to_prepare`</b>: string, defaults to None. If set,
+    indicates that current version of TFDS cannot be used to
+    `download_and_prepare` the dataset, but that TFDS at version
+    {tfds_version_to_prepare} should be used instead.
+
 ## Properties
 
 <h3 id="tuple"><code>tuple</code></h3>

docs/api_docs/python/tfds/testing/DummyDatasetSharedGenerator.md

@@ -2,9 +2,12 @@
 <meta itemprop="name" content="tfds.testing.DummyDatasetSharedGenerator" />
 <meta itemprop="path" content="Stable" />
 <meta itemprop="property" content="builder_config"/>
+<meta itemprop="property" content="canonical_version"/>
 <meta itemprop="property" content="data_dir"/>
 <meta itemprop="property" content="info"/>
+<meta itemprop="property" content="supported_versions"/>
 <meta itemprop="property" content="version"/>
+<meta itemprop="property" content="versions"/>
 <meta itemprop="property" content="__init__"/>
 <meta itemprop="property" content="as_dataset"/>
 <meta itemprop="property" content="download_and_prepare"/>
@@ -73,14 +76,22 @@ Callers must pass arguments as keyword arguments.
 
 <a href="../../tfds/core/BuilderConfig.md"><code>tfds.core.BuilderConfig</code></a> for this builder.
 
+<h3 id="canonical_version"><code>canonical_version</code></h3>
+
 <h3 id="data_dir"><code>data_dir</code></h3>
 
 <h3 id="info"><code>info</code></h3>
 
 <a href="../../tfds/core/DatasetInfo.md"><code>tfds.core.DatasetInfo</code></a> for this builder.
 
+<h3 id="supported_versions"><code>supported_versions</code></h3>
+
 <h3 id="version"><code>version</code></h3>
 
+<h3 id="versions"><code>versions</code></h3>
+
+Versions (canonical + availables), in preference order.
+
 ## Methods
 
 <h3 id="as_dataset"><code>as_dataset</code></h3>

docs/api_docs/python/tfds/testing/DummyMnist.md

@@ -2,9 +2,12 @@
 <meta itemprop="name" content="tfds.testing.DummyMnist" />
 <meta itemprop="path" content="Stable" />
 <meta itemprop="property" content="builder_config"/>
+<meta itemprop="property" content="canonical_version"/>
 <meta itemprop="property" content="data_dir"/>
 <meta itemprop="property" content="info"/>
+<meta itemprop="property" content="supported_versions"/>
 <meta itemprop="property" content="version"/>
+<meta itemprop="property" content="versions"/>
 <meta itemprop="property" content="__init__"/>
 <meta itemprop="property" content="as_dataset"/>
 <meta itemprop="property" content="download_and_prepare"/>
@@ -73,14 +76,22 @@ Callers must pass arguments as keyword arguments.
 
 <a href="../../tfds/core/BuilderConfig.md"><code>tfds.core.BuilderConfig</code></a> for this builder.
 
+<h3 id="canonical_version"><code>canonical_version</code></h3>
+
 <h3 id="data_dir"><code>data_dir</code></h3>
 
 <h3 id="info"><code>info</code></h3>
 
 <a href="../../tfds/core/DatasetInfo.md"><code>tfds.core.DatasetInfo</code></a> for this builder.
 
+<h3 id="supported_versions"><code>supported_versions</code></h3>
+
 <h3 id="version"><code>version</code></h3>
 
+<h3 id="versions"><code>versions</code></h3>
+
+Versions (canonical + availables), in preference order.
+
 ## Methods
 
 <h3 id="as_dataset"><code>as_dataset</code></h3>

docs/catalog/c4.md

@@ -26,16 +26,16 @@ https://www.tensorflow.org/datasets/beam_datasets.
 `c4` is configured with `tfds.text.c4.C4Config` and has the following
 configurations predefined (defaults to the first one):
 
-*   `en` (`v1.0.1`) (`Size: 6.96 TiB`): English C4 dataset.
+*   `en` (`v1.1.0`) (`Size: ?? GiB`): English C4 dataset.
 
-*   `en.noclean` (`v1.0.1`) (`Size: 6.96 TiB`): Disables all cleaning
+*   `en.noclean` (`v1.1.0`) (`Size: ?? GiB`): Disables all cleaning
     (deduplication, removal based on bad words, etc.)
 
-*   `en.realnewslike` (`v1.0.1`) (`Size: 6.96 TiB`): Filters from the default
+*   `en.realnewslike` (`v1.1.0`) (`Size: ?? GiB`): Filters from the default
     config to only include content from the domains used in the 'RealNews'
     dataset (Zellers et al., 2019).
 
-*   `en.webtextlike` (`v1.0.1`) (`Size: 6.96 TiB`): Filters from the default
+*   `en.webtextlike` (`v1.1.0`) (`Size: ?? GiB`): Filters from the default
     config to only include content from the URLs in OpenWebText
     (https://github.com/jcpeterson/openwebtext).
 
@@ -44,8 +44,9 @@ English C4 dataset.
 
 Versions:
 
-*   **`1.0.1`** (default):
+*   **`1.1.0`** (default):
 *   `1.0.0`: None
+*   `1.0.1`: None
 
 ### Statistics
 None computed
@@ -70,8 +71,9 @@ Disables all cleaning (deduplication, removal based on bad words, etc.)
 
 Versions:
 
-*   **`1.0.1`** (default):
+*   **`1.1.0`** (default):
 *   `1.0.0`: None
+*   `1.0.1`: None
 
 ### Statistics
 None computed
@@ -98,8 +100,9 @@ the 'RealNews' dataset (Zellers et al., 2019).
 
 Versions:
 
-*   **`1.0.1`** (default):
+*   **`1.1.0`** (default):
 *   `1.0.0`: None
+*   `1.0.1`: None
 
 ### Statistics
 None computed
@@ -126,8 +129,9 @@ OpenWebText (https://github.com/jcpeterson/openwebtext).
 
 Versions:
 
-*   **`1.0.1`** (default):
+*   **`1.1.0`** (default):
 *   `1.0.0`: None
+*   `1.0.1`: None
 
 ### Statistics
 None computed