Skip to content

Commit fbc76a7

Browse files
Conchylicultorcopybara-github
authored andcommitted
Update dead API doc links
PiperOrigin-RevId: 296215085
1 parent a3b2459 commit fbc76a7

File tree

2 files changed

+10
-12
lines changed

2 files changed

+10
-12
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,14 @@ Try it interactively in a
6666

6767
### `DatasetBuilder`
6868

69-
All datasets are implemented as subclasses of
70-
[`DatasetBuilder`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/DatasetBuilder.md)
71-
and
72-
[`tfds.load`](https://www.tensorflow.org/datasets/api_docs/python/tfds/load.md)
73-
is a thin convenience wrapper.
74-
[`DatasetInfo`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/DatasetInfo.md)
75-
documents the dataset.
69+
All datasets are implemented as subclasses of `tfds.core.DatasetBuilder`. TFDS
70+
has two entry points:
71+
72+
* `tfds.builder`: Returns the `tfds.core.DatasetBuilder` instance, giving
73+
control over `builder.download_and_prepate()` and
74+
`builder.as_dataset()`.
75+
* `tfds.load`: Convenience wrapper which hides the `download_and_prepate` and
76+
`as_dataset` calls, and directly returns the `tf.data.Dataset`.
7677

7778
```python
7879
import tensorflow_datasets as tfds
@@ -138,9 +139,7 @@ info.features['label'].str2int('cat') # 0
138139
### NumPy Usage with `tfds.as_numpy`
139140

140141
As a convenience for users that want simple NumPy arrays in their programs, you
141-
can use
142-
[`tfds.as_numpy`](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_numpy.md)
143-
to return a generator that yields NumPy array
142+
can use `tfds.as_numpy` to return a generator that yields NumPy array
144143
records out of a `tf.data.Dataset`. This allows you to build high-performance
145144
input pipelines with `tf.data` but use whatever you'd like for your model
146145
components.

docs/add_dataset.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -361,8 +361,7 @@ Heavy configuration affects how the data is written to disk. For example, for
361361
text datasets, different `TextEncoder`s and vocabularies affect the token ids
362362
that are written to disk.
363363

364-
Heavy configuration is done through
365-
[`tfds.core.BuilderConfig`s](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/BuilderConfig.md):
364+
Heavy configuration is done through `tfds.core.BuilderConfig`s:
366365

367366
1. Define your own configuration object as a subclass of
368367
`tfds.core.BuilderConfig`. For example, `MyDatasetConfig`.

0 commit comments

Comments
 (0)