Skip to content

Commit 762cc55

Browse files
Conchylicultorcopybara-github
authored andcommitted
Update doc
PiperOrigin-RevId: 255300214
1 parent 55b8cfb commit 762cc55

File tree

10 files changed

+132
-169
lines changed

10 files changed

+132
-169
lines changed

docs/api_docs/python/tfds/_api_cache.json

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,6 @@
139139
"tfds.core": false,
140140
"tfds.core.BeamBasedBuilder": false,
141141
"tfds.core.BeamBasedBuilder.BUILDER_CONFIGS": true,
142-
"tfds.core.BeamBasedBuilder.GOOGLE_DISABLED": true,
143-
"tfds.core.BeamBasedBuilder.IN_DEVELOPMENT": true,
144142
"tfds.core.BeamBasedBuilder.SUPPORTED_VERSIONS": true,
145143
"tfds.core.BeamBasedBuilder.VERSION": true,
146144
"tfds.core.BeamBasedBuilder.__init__": true,
@@ -160,8 +158,6 @@
160158
"tfds.core.BuilderConfig.version": true,
161159
"tfds.core.DatasetBuilder": false,
162160
"tfds.core.DatasetBuilder.BUILDER_CONFIGS": true,
163-
"tfds.core.DatasetBuilder.GOOGLE_DISABLED": true,
164-
"tfds.core.DatasetBuilder.IN_DEVELOPMENT": true,
165161
"tfds.core.DatasetBuilder.SUPPORTED_VERSIONS": true,
166162
"tfds.core.DatasetBuilder.VERSION": true,
167163
"tfds.core.DatasetBuilder.__init__": true,
@@ -200,8 +196,6 @@
200196
"tfds.core.Experiment.S3": true,
201197
"tfds.core.GeneratorBasedBuilder": false,
202198
"tfds.core.GeneratorBasedBuilder.BUILDER_CONFIGS": true,
203-
"tfds.core.GeneratorBasedBuilder.GOOGLE_DISABLED": true,
204-
"tfds.core.GeneratorBasedBuilder.IN_DEVELOPMENT": true,
205199
"tfds.core.GeneratorBasedBuilder.SUPPORTED_VERSIONS": true,
206200
"tfds.core.GeneratorBasedBuilder.VERSION": true,
207201
"tfds.core.GeneratorBasedBuilder.__init__": true,
@@ -599,7 +593,6 @@
599593
"tfds.testing.DatasetBuilderTestCase.DATASET_CLASS": true,
600594
"tfds.testing.DatasetBuilderTestCase.DL_EXTRACT_RESULT": true,
601595
"tfds.testing.DatasetBuilderTestCase.EXAMPLE_DIR": true,
602-
"tfds.testing.DatasetBuilderTestCase.INTERNAL_DATASET": true,
603596
"tfds.testing.DatasetBuilderTestCase.MOCK_MONARCH": true,
604597
"tfds.testing.DatasetBuilderTestCase.MOCK_OUT_FORBIDDEN_OS_FUNCTIONS": true,
605598
"tfds.testing.DatasetBuilderTestCase.OVERLAPPING_SPLITS": true,
@@ -745,8 +738,6 @@
745738
"tfds.testing.DatasetBuilderTestCase.test_session": true,
746739
"tfds.testing.DummyDatasetSharedGenerator": false,
747740
"tfds.testing.DummyDatasetSharedGenerator.BUILDER_CONFIGS": true,
748-
"tfds.testing.DummyDatasetSharedGenerator.GOOGLE_DISABLED": true,
749-
"tfds.testing.DummyDatasetSharedGenerator.IN_DEVELOPMENT": true,
750741
"tfds.testing.DummyDatasetSharedGenerator.SUPPORTED_VERSIONS": true,
751742
"tfds.testing.DummyDatasetSharedGenerator.VERSION": true,
752743
"tfds.testing.DummyDatasetSharedGenerator.__init__": true,
@@ -760,8 +751,6 @@
760751
"tfds.testing.DummyDatasetSharedGenerator.version": true,
761752
"tfds.testing.DummyMnist": false,
762753
"tfds.testing.DummyMnist.BUILDER_CONFIGS": true,
763-
"tfds.testing.DummyMnist.GOOGLE_DISABLED": true,
764-
"tfds.testing.DummyMnist.IN_DEVELOPMENT": true,
765754
"tfds.testing.DummyMnist.SUPPORTED_VERSIONS": true,
766755
"tfds.testing.DummyMnist.VERSION": true,
767756
"tfds.testing.DummyMnist.__init__": true,
@@ -1199,7 +1188,6 @@
11991188
"tfds.units.MiB": true,
12001189
"tfds.units.PiB": true,
12011190
"tfds.units.TiB": true,
1202-
"tfds.units.absolute_import": true,
12031191
"tfds.units.division": true,
12041192
"tfds.units.print_function": true,
12051193
"tfds.units.size_str": false

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99
<meta itemprop="property" content="as_dataset"/>
1010
<meta itemprop="property" content="download_and_prepare"/>
1111
<meta itemprop="property" content="BUILDER_CONFIGS"/>
12-
<meta itemprop="property" content="GOOGLE_DISABLED"/>
13-
<meta itemprop="property" content="IN_DEVELOPMENT"/>
1412
<meta itemprop="property" content="SUPPORTED_VERSIONS"/>
1513
<meta itemprop="property" content="VERSION"/>
1614
<meta itemprop="property" content="builder_configs"/>
@@ -147,8 +145,6 @@ Downloads and prepares dataset for reading.
147145
## Class Members
148146

149147
* `BUILDER_CONFIGS` <a id="BUILDER_CONFIGS"></a>
150-
* `GOOGLE_DISABLED = False` <a id="GOOGLE_DISABLED"></a>
151-
* `IN_DEVELOPMENT = False` <a id="IN_DEVELOPMENT"></a>
152148
* `SUPPORTED_VERSIONS` <a id="SUPPORTED_VERSIONS"></a>
153149
* `VERSION = None` <a id="VERSION"></a>
154150
* `builder_configs` <a id="builder_configs"></a>

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99
<meta itemprop="property" content="as_dataset"/>
1010
<meta itemprop="property" content="download_and_prepare"/>
1111
<meta itemprop="property" content="BUILDER_CONFIGS"/>
12-
<meta itemprop="property" content="GOOGLE_DISABLED"/>
13-
<meta itemprop="property" content="IN_DEVELOPMENT"/>
1412
<meta itemprop="property" content="SUPPORTED_VERSIONS"/>
1513
<meta itemprop="property" content="VERSION"/>
1614
<meta itemprop="property" content="builder_configs"/>
@@ -178,8 +176,6 @@ Downloads and prepares dataset for reading.
178176
## Class Members
179177

180178
* `BUILDER_CONFIGS` <a id="BUILDER_CONFIGS"></a>
181-
* `GOOGLE_DISABLED = False` <a id="GOOGLE_DISABLED"></a>
182-
* `IN_DEVELOPMENT = False` <a id="IN_DEVELOPMENT"></a>
183179
* `SUPPORTED_VERSIONS` <a id="SUPPORTED_VERSIONS"></a>
184180
* `VERSION = None` <a id="VERSION"></a>
185181
* `builder_configs` <a id="builder_configs"></a>

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99
<meta itemprop="property" content="as_dataset"/>
1010
<meta itemprop="property" content="download_and_prepare"/>
1111
<meta itemprop="property" content="BUILDER_CONFIGS"/>
12-
<meta itemprop="property" content="GOOGLE_DISABLED"/>
13-
<meta itemprop="property" content="IN_DEVELOPMENT"/>
1412
<meta itemprop="property" content="SUPPORTED_VERSIONS"/>
1513
<meta itemprop="property" content="VERSION"/>
1614
<meta itemprop="property" content="builder_configs"/>
@@ -156,8 +154,6 @@ Downloads and prepares dataset for reading.
156154
## Class Members
157155

158156
* `BUILDER_CONFIGS` <a id="BUILDER_CONFIGS"></a>
159-
* `GOOGLE_DISABLED = False` <a id="GOOGLE_DISABLED"></a>
160-
* `IN_DEVELOPMENT = False` <a id="IN_DEVELOPMENT"></a>
161157
* `SUPPORTED_VERSIONS` <a id="SUPPORTED_VERSIONS"></a>
162158
* `VERSION = None` <a id="VERSION"></a>
163159
* `builder_configs` <a id="builder_configs"></a>

docs/api_docs/python/tfds/features/text/TokenTextEncoder.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,10 @@ __init__(
4646

4747
Constructs a TokenTextEncoder.
4848

49-
To load from a file saved with `TokenTextEncoder.save_to_file`, use
50-
`TokenTextEncoder.load_from_file`.
49+
To load from a file saved with
50+
<a href="../../../tfds/features/text/TokenTextEncoder.md#save_to_file"><code>TokenTextEncoder.save_to_file</code></a>,
51+
use
52+
<a href="../../../tfds/features/text/TokenTextEncoder.md#load_from_file"><code>TokenTextEncoder.load_from_file</code></a>.
5153

5254
#### Args:
5355

docs/api_docs/python/tfds/load.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,12 @@ Defined in [`core/registered.py`](https://github.com/tensorflow/datasets/tree/ma
4444
If `split=None` (the default), returns all splits for the dataset. Otherwise,
4545
returns the specified split.
4646

47-
`load` is a convenience method that fetches the <a href="../tfds/core/DatasetBuilder.md"><code>tfds.core.DatasetBuilder</code></a> by
48-
string name, optionally calls `DatasetBuilder.download_and_prepare`
49-
(if `download=True`), and then calls `DatasetBuilder.as_dataset`.
47+
`load` is a convenience method that fetches the
48+
<a href="../tfds/core/DatasetBuilder.md"><code>tfds.core.DatasetBuilder</code></a>
49+
by string name, optionally calls
50+
<a href="../tfds/core/DatasetBuilder.md#download_and_prepare"><code>DatasetBuilder.download_and_prepare</code></a>
51+
(if `download=True`), and then calls
52+
<a href="../tfds/core/DatasetBuilder.md#as_dataset"><code>DatasetBuilder.as_dataset</code></a>.
5053
This is roughly equivalent to:
5154

5255
```

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

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,6 @@
137137
<meta itemprop="property" content="DATASET_CLASS"/>
138138
<meta itemprop="property" content="DL_EXTRACT_RESULT"/>
139139
<meta itemprop="property" content="EXAMPLE_DIR"/>
140-
<meta itemprop="property" content="INTERNAL_DATASET"/>
141140
<meta itemprop="property" content="MOCK_MONARCH"/>
142141
<meta itemprop="property" content="MOCK_OUT_FORBIDDEN_OS_FUNCTIONS"/>
143142
<meta itemprop="property" content="OVERLAPPING_SPLITS"/>
@@ -178,18 +177,15 @@ MOCK_OUT_FORBIDDEN_OS_FUNCTIONS: `bool`, defaults to True. Set to False to
178177
disable checks preventing usage of `os` or builtin functions instead of
179178
recommended `tf.io.gfile` API.
180179

181-
This test case will check for the following:
182-
- the dataset builder is correctly registered, i.e. `tfds.load(name)` works;
183-
- the dataset builder can read the fake examples stored in
184-
testing/test_data/fake_examples/${dataset_name};
185-
- the dataset builder can produce serialized data;
186-
- the dataset builder produces a valid Dataset object from serialized data
187-
- in eager mode;
188-
- in graph mode.
189-
- the produced Dataset examples have the expected dimensions and types;
190-
- the produced Dataset has and the expected number of examples;
191-
- a example is not part of two splits, or one of these splits is whitelisted
192-
in OVERLAPPING_SPLITS.
180+
This test case will check for the following: - the dataset builder is correctly
181+
registered, i.e. <a href="../../tfds/load.md"><code>tfds.load(name)</code></a>
182+
works; - the dataset builder can read the fake examples stored in
183+
testing/test_data/fake_examples/${dataset_name}; - the dataset builder can
184+
produce serialized data; - the dataset builder produces a valid Dataset object
185+
from serialized data - in eager mode; - in graph mode. - the produced Dataset
186+
examples have the expected dimensions and types; - the produced Dataset has and
187+
the expected number of examples; - a example is not part of two splits, or one
188+
of these splits is whitelisted in OVERLAPPING_SPLITS.
193189

194190
<h2 id="__init__"><code>__init__</code></h2>
195191

@@ -2450,7 +2446,6 @@ Use `self.session()` or `self.cached_session()` instead.
24502446
* `DATASET_CLASS = None` <a id="DATASET_CLASS"></a>
24512447
* `DL_EXTRACT_RESULT = None` <a id="DL_EXTRACT_RESULT"></a>
24522448
* `EXAMPLE_DIR = None` <a id="EXAMPLE_DIR"></a>
2453-
* `INTERNAL_DATASET = False` <a id="INTERNAL_DATASET"></a>
24542449
* `MOCK_MONARCH = True` <a id="MOCK_MONARCH"></a>
24552450
* `MOCK_OUT_FORBIDDEN_OS_FUNCTIONS = True`
24562451
<a id="MOCK_OUT_FORBIDDEN_OS_FUNCTIONS"></a>

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99
<meta itemprop="property" content="as_dataset"/>
1010
<meta itemprop="property" content="download_and_prepare"/>
1111
<meta itemprop="property" content="BUILDER_CONFIGS"/>
12-
<meta itemprop="property" content="GOOGLE_DISABLED"/>
13-
<meta itemprop="property" content="IN_DEVELOPMENT"/>
1412
<meta itemprop="property" content="SUPPORTED_VERSIONS"/>
1513
<meta itemprop="property" content="VERSION"/>
1614
<meta itemprop="property" content="builder_configs"/>
@@ -151,8 +149,6 @@ Downloads and prepares dataset for reading.
151149
## Class Members
152150

153151
* `BUILDER_CONFIGS` <a id="BUILDER_CONFIGS"></a>
154-
* `GOOGLE_DISABLED = False` <a id="GOOGLE_DISABLED"></a>
155-
* `IN_DEVELOPMENT = False` <a id="IN_DEVELOPMENT"></a>
156152
* `SUPPORTED_VERSIONS` <a id="SUPPORTED_VERSIONS"></a>
157153
* `VERSION` <a id="VERSION"></a>
158154
* `builder_configs` <a id="builder_configs"></a>

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99
<meta itemprop="property" content="as_dataset"/>
1010
<meta itemprop="property" content="download_and_prepare"/>
1111
<meta itemprop="property" content="BUILDER_CONFIGS"/>
12-
<meta itemprop="property" content="GOOGLE_DISABLED"/>
13-
<meta itemprop="property" content="IN_DEVELOPMENT"/>
1412
<meta itemprop="property" content="SUPPORTED_VERSIONS"/>
1513
<meta itemprop="property" content="VERSION"/>
1614
<meta itemprop="property" content="builder_configs"/>
@@ -131,8 +129,6 @@ Downloads and prepares dataset for reading.
131129
## Class Members
132130

133131
* `BUILDER_CONFIGS` <a id="BUILDER_CONFIGS"></a>
134-
* `GOOGLE_DISABLED = False` <a id="GOOGLE_DISABLED"></a>
135-
* `IN_DEVELOPMENT = False` <a id="IN_DEVELOPMENT"></a>
136132
* `SUPPORTED_VERSIONS` <a id="SUPPORTED_VERSIONS"></a>
137133
* `VERSION` <a id="VERSION"></a>
138134
* `builder_configs` <a id="builder_configs"></a>

0 commit comments

Comments
 (0)