Skip to content

Commit 0ff411f

Browse files
Ryan Sepassicopybara-github
authored andcommitted
Update docs; includes tfds.testing
PiperOrigin-RevId: 234028083
1 parent a516126 commit 0ff411f

29 files changed

+8688
-44
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
redirects:
22
- from: /datasets/api_docs/python/tfds/GenerateMode
33
to: /datasets/api_docs/python/tfds/download/GenerateMode
4+
- from: /datasets/api_docs/python/tfds/testing/FeatureExpectationsTestCase/failureException
5+
to: /datasets/api_docs/python/tfds/testing/DatasetBuilderTestCase/failureException
6+
- from: /datasets/api_docs/python/tfds/testing/TestCase/failureException
7+
to: /datasets/api_docs/python/tfds/testing/DatasetBuilderTestCase/failureException
48
- from: /datasets/api_docs/python/tfds/features/text
59
to: /datasets/api_docs/python/tfds/features/text_lib

docs/api_docs/python/_toc.yaml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ toc:
5050
section:
5151
- title: Overview
5252
path: /datasets/api_docs/python/tfds/download
53+
- title: ComputeStatsMode
54+
path: /datasets/api_docs/python/tfds/download/ComputeStatsMode
5355
- title: DownloadConfig
5456
path: /datasets/api_docs/python/tfds/download/DownloadConfig
5557
- title: DownloadManager
@@ -118,6 +120,34 @@ toc:
118120
path: /datasets/api_docs/python/tfds/file_adapter/FileFormatAdapter
119121
- title: TFRecordExampleAdapter
120122
path: /datasets/api_docs/python/tfds/file_adapter/TFRecordExampleAdapter
123+
- title: tfds.testing
124+
section:
125+
- title: Overview
126+
path: /datasets/api_docs/python/tfds/testing
127+
- title: DatasetBuilderTestCase
128+
path: /datasets/api_docs/python/tfds/testing/DatasetBuilderTestCase
129+
- title: DatasetBuilderTestCase.failureException
130+
path: /datasets/api_docs/python/tfds/testing/DatasetBuilderTestCase/failureException
131+
- title: DummyDatasetSharedGenerator
132+
path: /datasets/api_docs/python/tfds/testing/DummyDatasetSharedGenerator
133+
- title: DummyMnist
134+
path: /datasets/api_docs/python/tfds/testing/DummyMnist
135+
- title: FeatureExpectationItem
136+
path: /datasets/api_docs/python/tfds/testing/FeatureExpectationItem
137+
- title: FeatureExpectationsTestCase
138+
path: /datasets/api_docs/python/tfds/testing/FeatureExpectationsTestCase
139+
- title: make_tmp_dir
140+
path: /datasets/api_docs/python/tfds/testing/make_tmp_dir
141+
- title: rm_tmp_dir
142+
path: /datasets/api_docs/python/tfds/testing/rm_tmp_dir
143+
- title: run_in_graph_and_eager_modes
144+
path: /datasets/api_docs/python/tfds/testing/run_in_graph_and_eager_modes
145+
- title: TestCase
146+
path: /datasets/api_docs/python/tfds/testing/TestCase
147+
- title: test_main
148+
path: /datasets/api_docs/python/tfds/testing/test_main
149+
- title: tmp_dir
150+
path: /datasets/api_docs/python/tfds/testing/tmp_dir
121151
- title: tfds.units
122152
section:
123153
- title: Overview

docs/api_docs/python/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
* <a href="./tfds/core/lazy_imports.md"><code>tfds.core.lazy_imports</code></a>
2121
* <a href="./tfds/dataset_as_numpy.md"><code>tfds.dataset_as_numpy</code></a>
2222
* <a href="./tfds/download.md"><code>tfds.download</code></a>
23+
* <a href="./tfds/download/ComputeStatsMode.md"><code>tfds.download.ComputeStatsMode</code></a>
2324
* <a href="./tfds/download/DownloadConfig.md"><code>tfds.download.DownloadConfig</code></a>
2425
* <a href="./tfds/download/DownloadManager.md"><code>tfds.download.DownloadManager</code></a>
2526
* <a href="./tfds/download/ExtractMethod.md"><code>tfds.download.ExtractMethod</code></a>
@@ -54,5 +55,20 @@
5455
* <a href="./tfds/list_builders.md"><code>tfds.list_builders</code></a>
5556
* <a href="./tfds/load.md"><code>tfds.load</code></a>
5657
* <a href="./tfds/percent.md"><code>tfds.percent</code></a>
58+
* <a href="./tfds/testing.md"><code>tfds.testing</code></a>
59+
* <a href="./tfds/testing/DatasetBuilderTestCase.md"><code>tfds.testing.DatasetBuilderTestCase</code></a>
60+
* <a href="./tfds/testing/DatasetBuilderTestCase/failureException.md"><code>tfds.testing.DatasetBuilderTestCase.failureException</code></a>
61+
* <a href="./tfds/testing/DummyDatasetSharedGenerator.md"><code>tfds.testing.DummyDatasetSharedGenerator</code></a>
62+
* <a href="./tfds/testing/DummyMnist.md"><code>tfds.testing.DummyMnist</code></a>
63+
* <a href="./tfds/testing/FeatureExpectationItem.md"><code>tfds.testing.FeatureExpectationItem</code></a>
64+
* <a href="./tfds/testing/FeatureExpectationsTestCase.md"><code>tfds.testing.FeatureExpectationsTestCase</code></a>
65+
* <a href="./tfds/testing/DatasetBuilderTestCase/failureException.md"><code>tfds.testing.FeatureExpectationsTestCase.failureException</code></a>
66+
* <a href="./tfds/testing/TestCase.md"><code>tfds.testing.TestCase</code></a>
67+
* <a href="./tfds/testing/DatasetBuilderTestCase/failureException.md"><code>tfds.testing.TestCase.failureException</code></a>
68+
* <a href="./tfds/testing/make_tmp_dir.md"><code>tfds.testing.make_tmp_dir</code></a>
69+
* <a href="./tfds/testing/rm_tmp_dir.md"><code>tfds.testing.rm_tmp_dir</code></a>
70+
* <a href="./tfds/testing/run_in_graph_and_eager_modes.md"><code>tfds.testing.run_in_graph_and_eager_modes</code></a>
71+
* <a href="./tfds/testing/test_main.md"><code>tfds.testing.test_main</code></a>
72+
* <a href="./tfds/testing/tmp_dir.md"><code>tfds.testing.tmp_dir</code></a>
5773
* <a href="./tfds/units.md"><code>tfds.units</code></a>
5874
* <a href="./tfds/units/size_str.md"><code>tfds.units.size_str</code></a>

docs/api_docs/python/tfds.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,6 @@ Defined in [`__init__.py`](https://github.com/tensorflow/datasets/tree/master/te
1111

1212
`tensorflow_datasets` (<a href="./tfds.md"><code>tfds</code></a>) defines a collection of datasets ready-to-use with TensorFlow.
1313

14-
Warning: these docs are from branch `master`. `tensorflow-datasets` will
15-
release a stable version shortly. Follow the
16-
[release tracking issue](https://github.com/tensorflow/datasets/issues/5)
17-
to be notified of release.
18-
1914
Each dataset is defined as a <a href="./tfds/core/DatasetBuilder.md"><code>tfds.core.DatasetBuilder</code></a>, which encapsulates
2015
the logic to download the dataset and construct an input pipeline, as well as
2116
contains the dataset documentation (version, splits, number of examples, etc.).
@@ -28,9 +23,9 @@ The main library entrypoints are:
2823

2924
Documentation:
3025

26+
* These API docs
3127
* [Available datasets](https://github.com/tensorflow/datasets/tree/master/docs/datasets.md)
3228
* [Colab tutorial](https://colab.research.google.com/github/tensorflow/datasets/blob/master/docs/overview.ipynb)
33-
* These API docs
3429
* [Add a dataset](https://github.com/tensorflow/datasets/tree/master/docs/add_dataset.md)
3530

3631
## Modules
@@ -45,6 +40,8 @@ Documentation:
4540

4641
[`units`](./tfds/units.md) module: Defines convenience constants/functions for converting various units.
4742

43+
[`testing`](./tfds/testing.md) module: Testing utilities.
44+
4845
## Classes
4946

5047
[`class GenerateMode`](./tfds/download/GenerateMode.md): `Enum` for how to treat pre-existing downloads and data.

0 commit comments

Comments
 (0)