Skip to content

Commit d2926e4

Browse files
Conchylicultorcopybara-github
Conchylicultor
authored and
copybara-github
committed
Automated documentation update
PiperOrigin-RevId: 258881047
1 parent a812ddd commit d2926e4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+344
-338
lines changed

‎docs/api_docs/python/tfds.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
`tensorflow_datasets` (<a href="./tfds.md"><code>tfds</code></a>) defines a
99
collection of datasets ready-to-use with TensorFlow.
1010

11-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/__init__.py>View
11+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/__init__.py">View
1212
source</a>
1313

1414
<!-- Placeholder for "Used in" -->

‎docs/api_docs/python/tfds/Split.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
`Enum` for dataset splits.
1515

16-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/splits.py>View
16+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/splits.py">View
1717
source</a>
1818

1919
<!-- Placeholder for "Used in" -->

‎docs/api_docs/python/tfds/as_numpy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ tfds.as_numpy(
1414
)
1515
```
1616

17-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_utils.py>View
17+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_utils.py">View
1818
source</a>
1919

2020
<!-- Placeholder for "Used in" -->

‎docs/api_docs/python/tfds/builder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ tfds.builder(
1616
)
1717
```
1818

19-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/registered.py>View
19+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/registered.py">View
2020
source</a>
2121

2222
<!-- Placeholder for "Used in" -->

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
API to define datasets.
99

10-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/__init__.py>View
10+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/__init__.py">View
1111
source</a>
1212

1313
<!-- Placeholder for "Used in" -->

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@
2121

2222
Beam based Builder.
2323

24-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
24+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py">View
2525
source</a>
2626

2727
<!-- Placeholder for "Used in" -->
2828

2929

3030
<h2 id="__init__"><code>__init__</code></h2>
3131

32-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
32+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py">View
3333
source</a>
3434

3535
```python
@@ -77,7 +77,7 @@ Callers must pass arguments as keyword arguments.
7777

7878
<h3 id="as_dataset"><code>as_dataset</code></h3>
7979

80-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
80+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py">View
8181
source</a>
8282

8383
```python
@@ -150,7 +150,9 @@ assert isinstance(ds_test_supervised, tf.data.Dataset)
150150
to `True` if `split == tfds.Split.TRAIN` and `False` otherwise.
151151
* <b>`decoders`</b>: Nested dict of `Decoder` objects which allow to customize
152152
the decoding. The structure should match the feature structure, but only
153-
customized feature keys need to be present.
153+
customized feature keys need to be present. See
154+
[the guide](https://github.com/tensorflow/datasets/tree/master/docs/decode.md)
155+
for more info.
154156
* <b>`as_supervised`</b>: `bool`, if `True`, the returned `tf.data.Dataset`
155157
will have a 2-tuple structure `(input, label)` according to
156158
`builder.info.supervised_keys`. If `False`, the default, the returned
@@ -170,7 +172,7 @@ the entire dataset in `tf.Tensor`s instead of a `tf.data.Dataset`.
170172

171173
<h3 id="download_and_prepare"><code>download_and_prepare</code></h3>
172174

173-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
175+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py">View
174176
source</a>
175177

176178
``` python

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
Base class for `DatasetBuilder` data configuration.
1616

17-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
17+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py">View
1818
source</a>
1919

2020
<!-- Placeholder for "Used in" -->
@@ -24,7 +24,7 @@ DatasetBuilder subclasses with data configuration options should subclass
2424

2525
<h2 id="__init__"><code>__init__</code></h2>
2626

27-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
27+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py">View
2828
source</a>
2929

3030
```python

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
Abstract base class for all datasets.
2323

24-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
24+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py">View
2525
source</a>
2626

2727
<!-- Placeholder for "Used in" -->
@@ -60,7 +60,7 @@ image, label = features['image'], features['label']
6060

6161
<h2 id="__init__"><code>__init__</code></h2>
6262

63-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
63+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py">View
6464
source</a>
6565

6666
```python
@@ -108,7 +108,7 @@ Callers must pass arguments as keyword arguments.
108108

109109
<h3 id="as_dataset"><code>as_dataset</code></h3>
110110

111-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
111+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py">View
112112
source</a>
113113

114114
```python
@@ -181,7 +181,9 @@ assert isinstance(ds_test_supervised, tf.data.Dataset)
181181
to `True` if `split == tfds.Split.TRAIN` and `False` otherwise.
182182
* <b>`decoders`</b>: Nested dict of `Decoder` objects which allow to customize
183183
the decoding. The structure should match the feature structure, but only
184-
customized feature keys need to be present.
184+
customized feature keys need to be present. See
185+
[the guide](https://github.com/tensorflow/datasets/tree/master/docs/decode.md)
186+
for more info.
185187
* <b>`as_supervised`</b>: `bool`, if `True`, the returned `tf.data.Dataset`
186188
will have a 2-tuple structure `(input, label)` according to
187189
`builder.info.supervised_keys`. If `False`, the default, the returned
@@ -201,7 +203,7 @@ the entire dataset in `tf.Tensor`s instead of a `tf.data.Dataset`.
201203

202204
<h3 id="download_and_prepare"><code>download_and_prepare</code></h3>
203205

204-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
206+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py">View
205207
source</a>
206208

207209
``` python

‎docs/api_docs/python/tfds/core/DatasetInfo.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
Information about a dataset.
3232

33-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
33+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py">View
3434
source</a>
3535

3636
<!-- Placeholder for "Used in" -->
@@ -45,7 +45,7 @@ split is typically updated during data generation (i.e. on calling
4545

4646
<h2 id="__init__"><code>__init__</code></h2>
4747

48-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
48+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py">View
4949
source</a>
5050

5151
```python
@@ -71,8 +71,13 @@ Constructs DatasetInfo.
7171
<a href="../../tfds/features/FeaturesDict.md"><code>tfds.features.FeaturesDict</code></a>,
7272
Information on the feature dict of the `tf.data.Dataset()` object from the
7373
`builder.as_dataset()` method.
74-
* <b>`supervised_keys`</b>: `tuple`, Specifies the input feature and the label
75-
for supervised learning, if applicable for the dataset.
74+
* <b>`supervised_keys`</b>: `tuple` of `(input_key, target_key)`, Specifies
75+
the input feature and the label for supervised learning, if applicable for
76+
the dataset. The keys correspond to the feature names to select in
77+
`info.features`. When calling
78+
<a href="../../tfds/core/DatasetBuilder.md#as_dataset"><code>tfds.core.DatasetBuilder.as_dataset()</code></a>
79+
with `as_supervised=True`, the `tf.data.Dataset` object will yield the
80+
(input, target) defined here.
7681
* <b>`urls`</b>: `list(str)`, optional, the homepage(s) for this dataset.
7782
* <b>`citation`</b>: `str`, optional, the citation to use for this dataset.
7883
* <b>`metadata`</b>:
@@ -124,7 +129,7 @@ Whether DatasetInfo has been fully initialized.
124129

125130
<h3 id="compute_dynamic_properties"><code>compute_dynamic_properties</code></h3>
126131

127-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
132+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py">View
128133
source</a>
129134

130135
``` python
@@ -133,7 +138,7 @@ compute_dynamic_properties()
133138

134139
<h3 id="initialize_from_bucket"><code>initialize_from_bucket</code></h3>
135140

136-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
141+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py">View
137142
source</a>
138143

139144
``` python
@@ -144,7 +149,7 @@ Initialize DatasetInfo from GCS bucket info files.
144149

145150
<h3 id="read_from_directory"><code>read_from_directory</code></h3>
146151

147-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
152+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py">View
148153
source</a>
149154

150155
``` python
@@ -165,7 +170,7 @@ This will overwrite all previous metadata.
165170

166171
<h3 id="update_splits_if_different"><code>update_splits_if_different</code></h3>
167172

168-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
173+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py">View
169174
source</a>
170175

171176
``` python
@@ -187,7 +192,7 @@ Overwrite the splits if they are different from the current ones.
187192

188193
<h3 id="write_to_directory"><code>write_to_directory</code></h3>
189194

190-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
195+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py">View
191196
source</a>
192197

193198
``` python

‎docs/api_docs/python/tfds/core/Experiment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
Experiments which can be enabled/disabled on a per version basis.
1313

14-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/utils/version.py>View
14+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/utils/version.py">View
1515
source</a>
1616

1717
<!-- Placeholder for "Used in" -->

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
Base class for datasets with data generation based on dict generators.
2323

24-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
24+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py">View
2525
source</a>
2626

2727
<!-- Placeholder for "Used in" -->
@@ -38,7 +38,7 @@ feature dictionaries yielded by example generators. See the class docstrings.
3838

3939
<h2 id="__init__"><code>__init__</code></h2>
4040

41-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
41+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py">View
4242
source</a>
4343

4444
```python
@@ -86,7 +86,7 @@ Callers must pass arguments as keyword arguments.
8686

8787
<h3 id="as_dataset"><code>as_dataset</code></h3>
8888

89-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
89+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py">View
9090
source</a>
9191

9292
```python
@@ -159,7 +159,9 @@ assert isinstance(ds_test_supervised, tf.data.Dataset)
159159
to `True` if `split == tfds.Split.TRAIN` and `False` otherwise.
160160
* <b>`decoders`</b>: Nested dict of `Decoder` objects which allow to customize
161161
the decoding. The structure should match the feature structure, but only
162-
customized feature keys need to be present.
162+
customized feature keys need to be present. See
163+
[the guide](https://github.com/tensorflow/datasets/tree/master/docs/decode.md)
164+
for more info.
163165
* <b>`as_supervised`</b>: `bool`, if `True`, the returned `tf.data.Dataset`
164166
will have a 2-tuple structure `(input, label)` according to
165167
`builder.info.supervised_keys`. If `False`, the default, the returned
@@ -179,7 +181,7 @@ the entire dataset in `tf.Tensor`s instead of a `tf.data.Dataset`.
179181

180182
<h3 id="download_and_prepare"><code>download_and_prepare</code></h3>
181183

182-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
184+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py">View
183185
source</a>
184186

185187
``` python

‎docs/api_docs/python/tfds/core/Metadata.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
Abstract base class for DatasetInfo metadata container.
1313

14-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
14+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py">View
1515
source</a>
1616

1717
<!-- Placeholder for "Used in" -->
@@ -31,7 +31,7 @@ file.
3131

3232
<h3 id="load_metadata"><code>load_metadata</code></h3>
3333

34-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
34+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py">View
3535
source</a>
3636

3737
```python
@@ -42,7 +42,7 @@ Restore the metadata.
4242

4343
<h3 id="save_metadata"><code>save_metadata</code></h3>
4444

45-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
45+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py">View
4646
source</a>
4747

4848
```python

‎docs/api_docs/python/tfds/core/MetadataDict.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ object that acts as a `dict`.
1414

1515
Inherits From: [`Metadata`](../../tfds/core/Metadata.md)
1616

17-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
17+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py">View
1818
source</a>
1919

2020
<!-- Placeholder for "Used in" -->
@@ -25,7 +25,7 @@ By default, the metadata will be serialized as JSON.
2525

2626
<h3 id="load_metadata"><code>load_metadata</code></h3>
2727

28-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
28+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py">View
2929
source</a>
3030

3131
```python
@@ -36,7 +36,7 @@ Restore the metadata.
3636

3737
<h3 id="save_metadata"><code>save_metadata</code></h3>
3838

39-
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
39+
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py">View
4040
source</a>
4141

4242
```python

0 commit comments

Comments
 (0)