Update doc

PiperOrigin-RevId: 250975797

Author: Conchylicultor

docs/api_docs/python/tfds.md

@@ -39,30 +39,32 @@ The main library entrypoints are:
 
 [`file_adapter`](./tfds/file_adapter.md) module: <a href="./tfds/file_adapter/FileFormatAdapter.md"><code>tfds.file_adapter.FileFormatAdapter</code></a>s for GeneratorBasedBuilder.
 
-[`units`](./tfds/units.md) module: Defines convenience constants/functions for converting various units.
-
 [`testing`](./tfds/testing.md) module: Testing utilities.
 
+[`units`](./tfds/units.md) module: Defines convenience constants/functions for
+converting various units.
+
 ## Classes
 
 [`class GenerateMode`](./tfds/download/GenerateMode.md): `Enum` for how to treat pre-existing downloads and data.
 
-[`class percent`](./tfds/percent.md): Syntactic sugar for defining slice subsplits: `tfds.percent[75:-5]`.
-
 [`class Split`](./tfds/Split.md): `Enum` for dataset splits.
 
+[`class percent`](./tfds/percent.md): Syntactic sugar for defining slice subsplits: `tfds.percent[75:-5]`.
+
 ## Functions
 
 [`as_numpy(...)`](./tfds/as_numpy.md): Converts a `tf.data.Dataset` to an iterable of NumPy arrays.
 
 [`builder(...)`](./tfds/builder.md): Fetches a <a href="./tfds/core/DatasetBuilder.md"><code>tfds.core.DatasetBuilder</code></a> by string name.
 
-[`list_builders(...)`](./tfds/list_builders.md): Returns the string names of all <a href="./tfds/core/DatasetBuilder.md"><code>tfds.core.DatasetBuilder</code></a>s.
-
-[`load(...)`](./tfds/load.md): Loads the named dataset into a `tf.data.Dataset`.
-
 [`disable_progress_bar(...)`](./tfds/disable_progress_bar.md): Disabled Tqdm
 progress bar.
 
 [`is_dataset_on_gcs(...)`](./tfds/is_dataset_on_gcs.md): If the dataset is
 available on the GCS bucket gs://tfds-data/datasets.
+
+[`list_builders(...)`](./tfds/list_builders.md): Returns the string names of all <a href="./tfds/core/DatasetBuilder.md"><code>tfds.core.DatasetBuilder</code></a>s.
+
+[`load(...)`](./tfds/load.md): Loads the named dataset into a `tf.data.Dataset`.
+

docs/api_docs/python/tfds/Split.md

@@ -1,7 +1,6 @@
 <div itemscope itemtype="http://developers.google.com/ReferenceObject">
 <meta itemprop="name" content="tfds.Split" />
 <meta itemprop="path" content="Stable" />
-<meta itemprop="property" content="__new__"/>
 <meta itemprop="property" content="ALL"/>
 <meta itemprop="property" content="TEST"/>
 <meta itemprop="property" content="TRAIN"/>
@@ -36,25 +35,9 @@ See the
 [guide on splits](https://github.com/tensorflow/datasets/tree/master/docs/splits.md)
 for more information.
 
-<h2 id="__new__"><code>__new__</code></h2>
-
-``` python
-@staticmethod
-__new__(
-    cls,
-    name
-)
-```
-
-Create a custom split with tfds.Split('custom_name').
-
 ## Class Members
 
-<h3 id="ALL"><code>ALL</code></h3>
-
-<h3 id="TEST"><code>TEST</code></h3>
-
-<h3 id="TRAIN"><code>TRAIN</code></h3>
-
-<h3 id="VALIDATION"><code>VALIDATION</code></h3>
-
+*   `ALL` <a id="ALL"></a>
+*   `TEST` <a id="TEST"></a>
+*   `TRAIN` <a id="TRAIN"></a>
+*   `VALIDATION` <a id="VALIDATION"></a>

docs/api_docs/python/tfds/_api_cache.json

@@ -14,19 +14,15 @@ Defined in [`core/__init__.py`](https://github.com/tensorflow/datasets/tree/mast
 
 ## Classes
 
-[`class lazy_imports`](../tfds/core/lazy_imports.md): Lazy importer for heavy dependencies.
-
 [`class BeamBasedBuilder`](../tfds/core/BeamBasedBuilder.md): Beam based Builder.
 
 [`class BuilderConfig`](../tfds/core/BuilderConfig.md): Base class for `DatasetBuilder` data configuration.
 
 [`class DatasetBuilder`](../tfds/core/DatasetBuilder.md): Abstract base class for all datasets.
 
-[`class GeneratorBasedBuilder`](../tfds/core/GeneratorBasedBuilder.md): Base class for datasets with data generation based on dict generators.
-
 [`class DatasetInfo`](../tfds/core/DatasetInfo.md): Information about a dataset.
 
-[`class NamedSplit`](../tfds/core/NamedSplit.md): Descriptor corresponding to a named split (train, test, ...).
+[`class GeneratorBasedBuilder`](../tfds/core/GeneratorBasedBuilder.md): Base class for datasets with data generation based on dict generators.
 
 [`class Metadata`](../tfds/core/Metadata.md): Abstract base class for
 DatasetInfo metadata container.
@@ -35,6 +31,8 @@ DatasetInfo metadata container.
 <a href="../tfds/core/Metadata.md"><code>tfds.core.Metadata</code></a> object
 that acts as a `dict`.
 
+[`class NamedSplit`](../tfds/core/NamedSplit.md): Descriptor corresponding to a named split (train, test, ...).
+
 [`class SplitBase`](../tfds/core/SplitBase.md): Abstract base class for Split compositionality.
 
 [`class SplitDict`](../tfds/core/SplitDict.md): Split info object.
@@ -45,6 +43,9 @@ that acts as a `dict`.
 
 [`class Version`](../tfds/core/Version.md): Dataset version MAJOR.MINOR.PATCH.
 
+[`class lazy_imports`](../tfds/core/lazy_imports.md): Lazy importer for heavy
+dependencies.
+
 ## Functions
 
 [`get_tfds_path(...)`](../tfds/core/get_tfds_path.md): Returns absolute path to file given path relative to tfds root.

docs/api_docs/python/tfds/core.md

@@ -10,6 +10,7 @@
 <meta itemprop="property" content="BUILDER_CONFIGS"/>
 <meta itemprop="property" content="GOOGLE_DISABLED"/>
 <meta itemprop="property" content="IN_DEVELOPMENT"/>
+<meta itemprop="property" content="SUPPORTED_VERSIONS"/>
 <meta itemprop="property" content="VERSION"/>
 <meta itemprop="property" content="builder_configs"/>
 <meta itemprop="property" content="name"/>
@@ -51,7 +52,7 @@ Callers must pass arguments as keyword arguments.
     subdirectories and versions.
 *   <b>`version`</b>: `str`. Optional version at which to load the dataset. An
     error is raised if specified version cannot be satisfied. Eg: '1.2.3',
-    '1.2.*'. Note that only the currently defined version can be loaded.
+    '1.2.*'.
 
 ## Properties
 
@@ -74,8 +75,7 @@ as_dataset(
     split=None,
     batch_size=1,
     shuffle_files=None,
-    as_supervised=False,
-    in_memory=None
+    as_supervised=False
 )
 ```
 
@@ -100,11 +100,6 @@ Callers must pass arguments as keyword arguments.
     will have a 2-tuple structure `(input, label)` according to
     `builder.info.supervised_keys`. If `False`, the default, the returned
     `tf.data.Dataset` will have a dictionary with all the features.
-*   <b>`in_memory`</b>: `bool`, if `True`, loads the dataset in memory which
-    increases iteration speeds. Note that if `True` and the dataset has unknown
-    dimensions, the features will be padded to the maximum size across the
-    dataset. By default (when `None`), will load the dataset in memory if the
-    size is <1GB and all feature dimensions are statically known.
 
 #### Returns:
 
@@ -141,15 +136,10 @@ Downloads and prepares dataset for reading.
 
 ## Class Members
 
-<h3 id="BUILDER_CONFIGS"><code>BUILDER_CONFIGS</code></h3>
-
-<h3 id="GOOGLE_DISABLED"><code>GOOGLE_DISABLED</code></h3>
-
-<h3 id="IN_DEVELOPMENT"><code>IN_DEVELOPMENT</code></h3>
-
-<h3 id="VERSION"><code>VERSION</code></h3>
-
-<h3 id="builder_configs"><code>builder_configs</code></h3>
-
-<h3 id="name"><code>name</code></h3>
-
+*   `BUILDER_CONFIGS` <a id="BUILDER_CONFIGS"></a>
+*   `GOOGLE_DISABLED = False` <a id="GOOGLE_DISABLED"></a>
+*   `IN_DEVELOPMENT = False` <a id="IN_DEVELOPMENT"></a>
+*   `SUPPORTED_VERSIONS` <a id="SUPPORTED_VERSIONS"></a>
+*   `VERSION = None` <a id="VERSION"></a>
+*   `builder_configs` <a id="builder_configs"></a>
+*   `name = 'beam_based_builder'` <a id="name"></a>

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

@@ -3,6 +3,7 @@
 <meta itemprop="path" content="Stable" />
 <meta itemprop="property" content="description"/>
 <meta itemprop="property" content="name"/>
+<meta itemprop="property" content="supported_versions"/>
 <meta itemprop="property" content="version"/>
 <meta itemprop="property" content="__init__"/>
 </div>
@@ -22,10 +23,11 @@ DatasetBuilder subclasses with data configuration options should subclass
 
 <h2 id="__init__"><code>__init__</code></h2>
 
-``` python
+```python
 __init__(
     name,
     version=None,
+    supported_versions=None,
     description=None
 )
 ```
@@ -36,4 +38,6 @@ __init__(
 
 <h3 id="name"><code>name</code></h3>
 
+<h3 id="supported_versions"><code>supported_versions</code></h3>
+
 <h3 id="version"><code>version</code></h3>

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

@@ -10,6 +10,7 @@
 <meta itemprop="property" content="BUILDER_CONFIGS"/>
 <meta itemprop="property" content="GOOGLE_DISABLED"/>
 <meta itemprop="property" content="IN_DEVELOPMENT"/>
+<meta itemprop="property" content="SUPPORTED_VERSIONS"/>
 <meta itemprop="property" content="VERSION"/>
 <meta itemprop="property" content="builder_configs"/>
 <meta itemprop="property" content="name"/>
@@ -82,7 +83,7 @@ Callers must pass arguments as keyword arguments.
     subdirectories and versions.
 *   <b>`version`</b>: `str`. Optional version at which to load the dataset. An
     error is raised if specified version cannot be satisfied. Eg: '1.2.3',
-    '1.2.*'. Note that only the currently defined version can be loaded.
+    '1.2.*'.
 
 ## Properties
 
@@ -105,8 +106,7 @@ as_dataset(
     split=None,
     batch_size=1,
     shuffle_files=None,
-    as_supervised=False,
-    in_memory=None
+    as_supervised=False
 )
 ```
 
@@ -131,11 +131,6 @@ Callers must pass arguments as keyword arguments.
     will have a 2-tuple structure `(input, label)` according to
     `builder.info.supervised_keys`. If `False`, the default, the returned
     `tf.data.Dataset` will have a dictionary with all the features.
-*   <b>`in_memory`</b>: `bool`, if `True`, loads the dataset in memory which
-    increases iteration speeds. Note that if `True` and the dataset has unknown
-    dimensions, the features will be padded to the maximum size across the
-    dataset. By default (when `None`), will load the dataset in memory if the
-    size is <1GB and all feature dimensions are statically known.
 
 #### Returns:
 
@@ -172,15 +167,10 @@ Downloads and prepares dataset for reading.
 
 ## Class Members
 
-<h3 id="BUILDER_CONFIGS"><code>BUILDER_CONFIGS</code></h3>
-
-<h3 id="GOOGLE_DISABLED"><code>GOOGLE_DISABLED</code></h3>
-
-<h3 id="IN_DEVELOPMENT"><code>IN_DEVELOPMENT</code></h3>
-
-<h3 id="VERSION"><code>VERSION</code></h3>
-
-<h3 id="builder_configs"><code>builder_configs</code></h3>
-
-<h3 id="name"><code>name</code></h3>
-
+*   `BUILDER_CONFIGS` <a id="BUILDER_CONFIGS"></a>
+*   `GOOGLE_DISABLED = False` <a id="GOOGLE_DISABLED"></a>
+*   `IN_DEVELOPMENT = False` <a id="IN_DEVELOPMENT"></a>
+*   `SUPPORTED_VERSIONS` <a id="SUPPORTED_VERSIONS"></a>
+*   `VERSION = None` <a id="VERSION"></a>
+*   `builder_configs` <a id="builder_configs"></a>
+*   `name = 'dataset_builder'` <a id="name"></a>

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

@@ -10,6 +10,7 @@
 <meta itemprop="property" content="BUILDER_CONFIGS"/>
 <meta itemprop="property" content="GOOGLE_DISABLED"/>
 <meta itemprop="property" content="IN_DEVELOPMENT"/>
+<meta itemprop="property" content="SUPPORTED_VERSIONS"/>
 <meta itemprop="property" content="VERSION"/>
 <meta itemprop="property" content="builder_configs"/>
 <meta itemprop="property" content="name"/>
@@ -60,7 +61,7 @@ Callers must pass arguments as keyword arguments.
     subdirectories and versions.
 *   <b>`version`</b>: `str`. Optional version at which to load the dataset. An
     error is raised if specified version cannot be satisfied. Eg: '1.2.3',
-    '1.2.*'. Note that only the currently defined version can be loaded.
+    '1.2.*'.
 
 ## Properties
 
@@ -83,8 +84,7 @@ as_dataset(
     split=None,
     batch_size=1,
     shuffle_files=None,
-    as_supervised=False,
-    in_memory=None
+    as_supervised=False
 )
 ```
 
@@ -109,11 +109,6 @@ Callers must pass arguments as keyword arguments.
     will have a 2-tuple structure `(input, label)` according to
     `builder.info.supervised_keys`. If `False`, the default, the returned
     `tf.data.Dataset` will have a dictionary with all the features.
-*   <b>`in_memory`</b>: `bool`, if `True`, loads the dataset in memory which
-    increases iteration speeds. Note that if `True` and the dataset has unknown
-    dimensions, the features will be padded to the maximum size across the
-    dataset. By default (when `None`), will load the dataset in memory if the
-    size is <1GB and all feature dimensions are statically known.
 
 #### Returns:
 
@@ -150,15 +145,10 @@ Downloads and prepares dataset for reading.
 
 ## Class Members
 
-<h3 id="BUILDER_CONFIGS"><code>BUILDER_CONFIGS</code></h3>
-
-<h3 id="GOOGLE_DISABLED"><code>GOOGLE_DISABLED</code></h3>
-
-<h3 id="IN_DEVELOPMENT"><code>IN_DEVELOPMENT</code></h3>
-
-<h3 id="VERSION"><code>VERSION</code></h3>
-
-<h3 id="builder_configs"><code>builder_configs</code></h3>
-
-<h3 id="name"><code>name</code></h3>
-
+*   `BUILDER_CONFIGS` <a id="BUILDER_CONFIGS"></a>
+*   `GOOGLE_DISABLED = False` <a id="GOOGLE_DISABLED"></a>
+*   `IN_DEVELOPMENT = False` <a id="IN_DEVELOPMENT"></a>
+*   `SUPPORTED_VERSIONS` <a id="SUPPORTED_VERSIONS"></a>
+*   `VERSION = None` <a id="VERSION"></a>
+*   `builder_configs` <a id="builder_configs"></a>
+*   `name = 'generator_based_builder'` <a id="name"></a>

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

@@ -4,7 +4,6 @@
 <meta itemprop="property" content="total_num_examples"/>
 <meta itemprop="property" content="__getitem__"/>
 <meta itemprop="property" content="__init__"/>
-<meta itemprop="property" content="__setitem__"/>
 <meta itemprop="property" content="add"/>
 <meta itemprop="property" content="copy"/>
 <meta itemprop="property" content="from_proto"/>
@@ -43,15 +42,6 @@ Return the total number of examples.
 __getitem__(key)
 ```
 
-<h3 id="__setitem__"><code>__setitem__</code></h3>
-
-``` python
-__setitem__(
-    key,
-    value
-)
-```
-
 <h3 id="add"><code>add</code></h3>
 
 ``` python

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

@@ -3,7 +3,6 @@
 <meta itemprop="path" content="Stable" />
 <meta itemprop="property" content="num_examples"/>
 <meta itemprop="property" content="__eq__"/>
-<meta itemprop="property" content="__getattr__"/>
 <meta itemprop="property" content="__init__"/>
 <meta itemprop="property" content="get_proto"/>
 </div>
@@ -40,12 +39,6 @@ __init__(
 __eq__(other)
 ```
 
-<h3 id="__getattr__"><code>__getattr__</code></h3>
-
-``` python
-__getattr__(attr_name)
-```
-
 <h3 id="get_proto"><code>get_proto</code></h3>
 
 ``` python