documentation update.

PiperOrigin-RevId: 282944149

Author: cyfra

docs/api_docs/python/tfds/_api_cache.json

@@ -232,6 +232,7 @@
     "tfds.core": false, 
     "tfds.core.BeamBasedBuilder": false, 
     "tfds.core.BeamBasedBuilder.BUILDER_CONFIGS": true, 
+    "tfds.core.BeamBasedBuilder.MANUAL_DOWNLOAD_INSTRUCTIONS": true, 
     "tfds.core.BeamBasedBuilder.SUPPORTED_VERSIONS": true, 
     "tfds.core.BeamBasedBuilder.VERSION": true, 
     "tfds.core.BeamBasedBuilder.__init__": true, 
@@ -289,6 +290,7 @@
     "tfds.core.BuilderConfig.version": true, 
     "tfds.core.DatasetBuilder": false, 
     "tfds.core.DatasetBuilder.BUILDER_CONFIGS": true, 
+    "tfds.core.DatasetBuilder.MANUAL_DOWNLOAD_INSTRUCTIONS": true, 
     "tfds.core.DatasetBuilder.SUPPORTED_VERSIONS": true, 
     "tfds.core.DatasetBuilder.VERSION": true, 
     "tfds.core.DatasetBuilder.__init__": true, 
@@ -332,6 +334,7 @@
     "tfds.core.Experiment.S3": true, 
     "tfds.core.GeneratorBasedBuilder": false, 
     "tfds.core.GeneratorBasedBuilder.BUILDER_CONFIGS": true, 
+    "tfds.core.GeneratorBasedBuilder.MANUAL_DOWNLOAD_INSTRUCTIONS": true, 
     "tfds.core.GeneratorBasedBuilder.SUPPORTED_VERSIONS": true, 
     "tfds.core.GeneratorBasedBuilder.VERSION": true, 
     "tfds.core.GeneratorBasedBuilder.__init__": true, 
@@ -968,6 +971,7 @@
     "tfds.testing.DatasetBuilderTestCase.test_session": true, 
     "tfds.testing.DummyDatasetSharedGenerator": false, 
     "tfds.testing.DummyDatasetSharedGenerator.BUILDER_CONFIGS": true, 
+    "tfds.testing.DummyDatasetSharedGenerator.MANUAL_DOWNLOAD_INSTRUCTIONS": true, 
     "tfds.testing.DummyDatasetSharedGenerator.SUPPORTED_VERSIONS": true, 
     "tfds.testing.DummyDatasetSharedGenerator.VERSION": true, 
     "tfds.testing.DummyDatasetSharedGenerator.__init__": true, 
@@ -985,6 +989,7 @@
     "tfds.testing.DummyDatasetSharedGenerator.versions": true, 
     "tfds.testing.DummyMnist": false, 
     "tfds.testing.DummyMnist.BUILDER_CONFIGS": true, 
+    "tfds.testing.DummyMnist.MANUAL_DOWNLOAD_INSTRUCTIONS": true, 
     "tfds.testing.DummyMnist.SUPPORTED_VERSIONS": true, 
     "tfds.testing.DummyMnist.VERSION": true, 
     "tfds.testing.DummyMnist.__init__": true, 

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

@@ -12,6 +12,7 @@
 <meta itemprop="property" content="as_dataset"/>
 <meta itemprop="property" content="download_and_prepare"/>
 <meta itemprop="property" content="BUILDER_CONFIGS"/>
+<meta itemprop="property" content="MANUAL_DOWNLOAD_INSTRUCTIONS"/>
 <meta itemprop="property" content="SUPPORTED_VERSIONS"/>
 <meta itemprop="property" content="VERSION"/>
 <meta itemprop="property" content="builder_configs"/>
@@ -218,6 +219,8 @@ Downloads and prepares dataset for reading.
 ## Class Members
 
 *   `BUILDER_CONFIGS` <a id="BUILDER_CONFIGS"></a>
+*   `MANUAL_DOWNLOAD_INSTRUCTIONS = None`
+    <a id="MANUAL_DOWNLOAD_INSTRUCTIONS"></a>
 *   `SUPPORTED_VERSIONS` <a id="SUPPORTED_VERSIONS"></a>
 *   `VERSION = None` <a id="VERSION"></a>
 *   `builder_configs` <a id="builder_configs"></a>

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

@@ -12,6 +12,7 @@
 <meta itemprop="property" content="as_dataset"/>
 <meta itemprop="property" content="download_and_prepare"/>
 <meta itemprop="property" content="BUILDER_CONFIGS"/>
+<meta itemprop="property" content="MANUAL_DOWNLOAD_INSTRUCTIONS"/>
 <meta itemprop="property" content="SUPPORTED_VERSIONS"/>
 <meta itemprop="property" content="VERSION"/>
 <meta itemprop="property" content="builder_configs"/>
@@ -249,6 +250,8 @@ Downloads and prepares dataset for reading.
 ## Class Members
 
 *   `BUILDER_CONFIGS` <a id="BUILDER_CONFIGS"></a>
+*   `MANUAL_DOWNLOAD_INSTRUCTIONS = None`
+    <a id="MANUAL_DOWNLOAD_INSTRUCTIONS"></a>
 *   `SUPPORTED_VERSIONS` <a id="SUPPORTED_VERSIONS"></a>
 *   `VERSION = None` <a id="VERSION"></a>
 *   `builder_configs` <a id="builder_configs"></a>

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

@@ -12,6 +12,7 @@
 <meta itemprop="property" content="as_dataset"/>
 <meta itemprop="property" content="download_and_prepare"/>
 <meta itemprop="property" content="BUILDER_CONFIGS"/>
+<meta itemprop="property" content="MANUAL_DOWNLOAD_INSTRUCTIONS"/>
 <meta itemprop="property" content="SUPPORTED_VERSIONS"/>
 <meta itemprop="property" content="VERSION"/>
 <meta itemprop="property" content="builder_configs"/>
@@ -227,6 +228,8 @@ Downloads and prepares dataset for reading.
 ## Class Members
 
 *   `BUILDER_CONFIGS` <a id="BUILDER_CONFIGS"></a>
+*   `MANUAL_DOWNLOAD_INSTRUCTIONS = None`
+    <a id="MANUAL_DOWNLOAD_INSTRUCTIONS"></a>
 *   `SUPPORTED_VERSIONS` <a id="SUPPORTED_VERSIONS"></a>
 *   `VERSION = None` <a id="VERSION"></a>
 *   `builder_configs` <a id="builder_configs"></a>

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

@@ -14,7 +14,6 @@
 source</a>
 
 <!-- Start diff -->
-
 Requires function to be called using keyword arguments.
 
 ```python

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

@@ -14,7 +14,6 @@
 source</a>
 
 <!-- Start diff -->
-
 Returns absolute path to file given path relative to tfds root.
 
 ``` python

docs/api_docs/python/tfds/download/DownloadManager.md

@@ -75,11 +75,12 @@ For more customization on the download/extraction (ex: passwords, output_name,
 <a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/download/download_manager.py">View
 source</a>
 
-``` python
+```python
 __init__(
     download_dir,
     extract_dir=None,
     manual_dir=None,
+    manual_dir_instructions=None,
     dataset_name=None,
     force_download=False,
     force_extraction=False,
@@ -96,6 +97,8 @@ Download manager constructor.
     extracted.
 *   <b>`manual_dir`</b>: `str`, path to manually downloaded/extracted data
     directory.
+*   <b>`manual_dir_instructions`</b>: `str`, human readable instructions on how
+    to prepare contents of the manual_dir for this dataset.
 *   <b>`dataset_name`</b>: `str`, name of dataset this instance will be used
     for. If provided, downloads will contain which datasets they were used for.
 *   <b>`force_download`</b>: `bool`, default to False. If True, always

docs/api_docs/python/tfds/is_dataset_on_gcs.md

@@ -14,7 +14,6 @@
 source</a>
 
 <!-- Start diff -->
-
 If the dataset is available on the GCS bucket gs://tfds-data/datasets.
 
 ```python

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

@@ -12,6 +12,7 @@
 <meta itemprop="property" content="as_dataset"/>
 <meta itemprop="property" content="download_and_prepare"/>
 <meta itemprop="property" content="BUILDER_CONFIGS"/>
+<meta itemprop="property" content="MANUAL_DOWNLOAD_INSTRUCTIONS"/>
 <meta itemprop="property" content="SUPPORTED_VERSIONS"/>
 <meta itemprop="property" content="VERSION"/>
 <meta itemprop="property" content="builder_configs"/>
@@ -220,6 +221,8 @@ Downloads and prepares dataset for reading.
 ## Class Members
 
 *   `BUILDER_CONFIGS` <a id="BUILDER_CONFIGS"></a>
+*   `MANUAL_DOWNLOAD_INSTRUCTIONS = None`
+    <a id="MANUAL_DOWNLOAD_INSTRUCTIONS"></a>
 *   `SUPPORTED_VERSIONS` <a id="SUPPORTED_VERSIONS"></a>
 *   `VERSION` <a id="VERSION"></a>
 *   `builder_configs` <a id="builder_configs"></a>

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

@@ -12,6 +12,7 @@
 <meta itemprop="property" content="as_dataset"/>
 <meta itemprop="property" content="download_and_prepare"/>
 <meta itemprop="property" content="BUILDER_CONFIGS"/>
+<meta itemprop="property" content="MANUAL_DOWNLOAD_INSTRUCTIONS"/>
 <meta itemprop="property" content="SUPPORTED_VERSIONS"/>
 <meta itemprop="property" content="VERSION"/>
 <meta itemprop="property" content="builder_configs"/>
@@ -220,6 +221,8 @@ Downloads and prepares dataset for reading.
 ## Class Members
 
 *   `BUILDER_CONFIGS` <a id="BUILDER_CONFIGS"></a>
+*   `MANUAL_DOWNLOAD_INSTRUCTIONS = None`
+    <a id="MANUAL_DOWNLOAD_INSTRUCTIONS"></a>
 *   `SUPPORTED_VERSIONS` <a id="SUPPORTED_VERSIONS"></a>
 *   `VERSION` <a id="VERSION"></a>
 *   `builder_configs` <a id="builder_configs"></a>