Skip to content

Commit cb33a61

Browse files
Conchylicultorcopybara-github
authored andcommitted
Update doc
PiperOrigin-RevId: 257703484
1 parent db9e56f commit cb33a61

Some content is hidden

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

73 files changed

+1326
-179
lines changed

docs/api_docs/python/tfds.md

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

11-
Defined in [`__init__.py`](https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/__init__.py).
11+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/__init__.py>View
12+
source</a>
1213

1314
<!-- Placeholder for "Used in" -->
1415

docs/api_docs/python/tfds/Split.md

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

1414
`Enum` for dataset splits.
1515

16-
Defined in [`core/splits.py`](https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/splits.py).
16+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/splits.py>View
17+
source</a>
1718

1819
<!-- Placeholder for "Used in" -->
1920

docs/api_docs/python/tfds/_api_cache.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -652,6 +652,7 @@
652652
"tfds.testing.DatasetBuilderTestCase.assertMultiLineEqual": true,
653653
"tfds.testing.DatasetBuilderTestCase.assertNDArrayNear": true,
654654
"tfds.testing.DatasetBuilderTestCase.assertNear": true,
655+
"tfds.testing.DatasetBuilderTestCase.assertNestedListAlmostEqual": true,
655656
"tfds.testing.DatasetBuilderTestCase.assertNoCommonElements": true,
656657
"tfds.testing.DatasetBuilderTestCase.assertNotAllClose": true,
657658
"tfds.testing.DatasetBuilderTestCase.assertNotAlmostEqual": true,
@@ -667,6 +668,8 @@
667668
"tfds.testing.DatasetBuilderTestCase.assertNotStartsWith": true,
668669
"tfds.testing.DatasetBuilderTestCase.assertProtoEquals": true,
669670
"tfds.testing.DatasetBuilderTestCase.assertProtoEqualsVersion": true,
671+
"tfds.testing.DatasetBuilderTestCase.assertRaggedAlmostEqual": true,
672+
"tfds.testing.DatasetBuilderTestCase.assertRaggedEqual": true,
670673
"tfds.testing.DatasetBuilderTestCase.assertRaises": true,
671674
"tfds.testing.DatasetBuilderTestCase.assertRaisesOpError": true,
672675
"tfds.testing.DatasetBuilderTestCase.assertRaisesRegex": true,
@@ -699,6 +702,7 @@
699702
"tfds.testing.DatasetBuilderTestCase.debug": true,
700703
"tfds.testing.DatasetBuilderTestCase.defaultTestResult": true,
701704
"tfds.testing.DatasetBuilderTestCase.doCleanups": true,
705+
"tfds.testing.DatasetBuilderTestCase.eval_to_list": true,
702706
"tfds.testing.DatasetBuilderTestCase.evaluate": true,
703707
"tfds.testing.DatasetBuilderTestCase.fail": true,
704708
"tfds.testing.DatasetBuilderTestCase.failIf": true,
@@ -823,6 +827,7 @@
823827
"tfds.testing.FeatureExpectationsTestCase.assertMultiLineEqual": true,
824828
"tfds.testing.FeatureExpectationsTestCase.assertNDArrayNear": true,
825829
"tfds.testing.FeatureExpectationsTestCase.assertNear": true,
830+
"tfds.testing.FeatureExpectationsTestCase.assertNestedListAlmostEqual": true,
826831
"tfds.testing.FeatureExpectationsTestCase.assertNoCommonElements": true,
827832
"tfds.testing.FeatureExpectationsTestCase.assertNotAllClose": true,
828833
"tfds.testing.FeatureExpectationsTestCase.assertNotAlmostEqual": true,
@@ -838,6 +843,8 @@
838843
"tfds.testing.FeatureExpectationsTestCase.assertNotStartsWith": true,
839844
"tfds.testing.FeatureExpectationsTestCase.assertProtoEquals": true,
840845
"tfds.testing.FeatureExpectationsTestCase.assertProtoEqualsVersion": true,
846+
"tfds.testing.FeatureExpectationsTestCase.assertRaggedAlmostEqual": true,
847+
"tfds.testing.FeatureExpectationsTestCase.assertRaggedEqual": true,
841848
"tfds.testing.FeatureExpectationsTestCase.assertRaises": true,
842849
"tfds.testing.FeatureExpectationsTestCase.assertRaisesOpError": true,
843850
"tfds.testing.FeatureExpectationsTestCase.assertRaisesRegex": true,
@@ -870,6 +877,7 @@
870877
"tfds.testing.FeatureExpectationsTestCase.debug": true,
871878
"tfds.testing.FeatureExpectationsTestCase.defaultTestResult": true,
872879
"tfds.testing.FeatureExpectationsTestCase.doCleanups": true,
880+
"tfds.testing.FeatureExpectationsTestCase.eval_to_list": true,
873881
"tfds.testing.FeatureExpectationsTestCase.evaluate": true,
874882
"tfds.testing.FeatureExpectationsTestCase.fail": true,
875883
"tfds.testing.FeatureExpectationsTestCase.failIf": true,
@@ -960,6 +968,7 @@
960968
"tfds.testing.SubTestCase.assertMultiLineEqual": true,
961969
"tfds.testing.SubTestCase.assertNDArrayNear": true,
962970
"tfds.testing.SubTestCase.assertNear": true,
971+
"tfds.testing.SubTestCase.assertNestedListAlmostEqual": true,
963972
"tfds.testing.SubTestCase.assertNoCommonElements": true,
964973
"tfds.testing.SubTestCase.assertNotAllClose": true,
965974
"tfds.testing.SubTestCase.assertNotAlmostEqual": true,
@@ -975,6 +984,8 @@
975984
"tfds.testing.SubTestCase.assertNotStartsWith": true,
976985
"tfds.testing.SubTestCase.assertProtoEquals": true,
977986
"tfds.testing.SubTestCase.assertProtoEqualsVersion": true,
987+
"tfds.testing.SubTestCase.assertRaggedAlmostEqual": true,
988+
"tfds.testing.SubTestCase.assertRaggedEqual": true,
978989
"tfds.testing.SubTestCase.assertRaises": true,
979990
"tfds.testing.SubTestCase.assertRaisesOpError": true,
980991
"tfds.testing.SubTestCase.assertRaisesRegex": true,
@@ -1007,6 +1018,7 @@
10071018
"tfds.testing.SubTestCase.debug": true,
10081019
"tfds.testing.SubTestCase.defaultTestResult": true,
10091020
"tfds.testing.SubTestCase.doCleanups": true,
1021+
"tfds.testing.SubTestCase.eval_to_list": true,
10101022
"tfds.testing.SubTestCase.evaluate": true,
10111023
"tfds.testing.SubTestCase.fail": true,
10121024
"tfds.testing.SubTestCase.failIf": true,

docs/api_docs/python/tfds/as_numpy.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,8 @@ tfds.as_numpy(
1414
)
1515
```
1616

17-
18-
19-
Defined in [`core/dataset_utils.py`](https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_utils.py).
17+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_utils.py>View
18+
source</a>
2019

2120
<!-- Placeholder for "Used in" -->
2221

docs/api_docs/python/tfds/builder.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,8 @@ tfds.builder(
1616
)
1717
```
1818

19-
20-
21-
Defined in [`core/registered.py`](https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/registered.py).
19+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/registered.py>View
20+
source</a>
2221

2322
<!-- Placeholder for "Used in" -->
2423

docs/api_docs/python/tfds/core.md

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

88
API to define datasets.
99

10-
Defined in [`core/__init__.py`](https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/__init__.py).
10+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/__init__.py>View
11+
source</a>
1112

1213
<!-- Placeholder for "Used in" -->
1314

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

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,17 @@
2121

2222
Beam based Builder.
2323

24-
Defined in [`core/dataset_builder.py`](https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py).
24+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
25+
source</a>
2526

2627
<!-- Placeholder for "Used in" -->
2728

2829

2930
<h2 id="__init__"><code>__init__</code></h2>
3031

32+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
33+
source</a>
34+
3135
```python
3236
__init__(
3337
data_dir=None,
@@ -73,6 +77,9 @@ Callers must pass arguments as keyword arguments.
7377

7478
<h3 id="as_dataset"><code>as_dataset</code></h3>
7579

80+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
81+
source</a>
82+
7683
```python
7784
as_dataset(
7885
split=None,
@@ -119,6 +126,9 @@ the entire dataset in `tf.Tensor`s instead of a `tf.data.Dataset`.
119126

120127
<h3 id="download_and_prepare"><code>download_and_prepare</code></h3>
121128

129+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
130+
source</a>
131+
122132
``` python
123133
download_and_prepare(
124134
download_dir=None,

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414

1515
Base class for `DatasetBuilder` data configuration.
1616

17-
Defined in [`core/dataset_builder.py`](https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py).
17+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
18+
source</a>
1819

1920
<!-- Placeholder for "Used in" -->
2021

@@ -23,6 +24,9 @@ DatasetBuilder subclasses with data configuration options should subclass
2324

2425
<h2 id="__init__"><code>__init__</code></h2>
2526

27+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
28+
source</a>
29+
2630
```python
2731
__init__(
2832
name,

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

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@
2121

2222
Abstract base class for all datasets.
2323

24-
Defined in [`core/dataset_builder.py`](https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py).
24+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
25+
source</a>
2526

2627
<!-- Placeholder for "Used in" -->
2728

@@ -59,6 +60,9 @@ image, label = features['image'], features['label']
5960

6061
<h2 id="__init__"><code>__init__</code></h2>
6162

63+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
64+
source</a>
65+
6266
```python
6367
__init__(
6468
data_dir=None,
@@ -104,6 +108,9 @@ Callers must pass arguments as keyword arguments.
104108

105109
<h3 id="as_dataset"><code>as_dataset</code></h3>
106110

111+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
112+
source</a>
113+
107114
```python
108115
as_dataset(
109116
split=None,
@@ -150,6 +157,9 @@ the entire dataset in `tf.Tensor`s instead of a `tf.data.Dataset`.
150157

151158
<h3 id="download_and_prepare"><code>download_and_prepare</code></h3>
152159

160+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_builder.py>View
161+
source</a>
162+
153163
``` python
154164
download_and_prepare(
155165
download_dir=None,

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

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030

3131
Information about a dataset.
3232

33-
Defined in [`core/dataset_info.py`](https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py).
33+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
34+
source</a>
3435

3536
<!-- Placeholder for "Used in" -->
3637

@@ -44,6 +45,9 @@ split is typically updated during data generation (i.e. on calling
4445

4546
<h2 id="__init__"><code>__init__</code></h2>
4647

48+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
49+
source</a>
50+
4751
```python
4852
__init__(
4953
builder,
@@ -120,12 +124,18 @@ Whether DatasetInfo has been fully initialized.
120124

121125
<h3 id="compute_dynamic_properties"><code>compute_dynamic_properties</code></h3>
122126

127+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
128+
source</a>
129+
123130
``` python
124131
compute_dynamic_properties()
125132
```
126133

127134
<h3 id="initialize_from_bucket"><code>initialize_from_bucket</code></h3>
128135

136+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
137+
source</a>
138+
129139
``` python
130140
initialize_from_bucket()
131141
```
@@ -134,6 +144,9 @@ Initialize DatasetInfo from GCS bucket info files.
134144

135145
<h3 id="read_from_directory"><code>read_from_directory</code></h3>
136146

147+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
148+
source</a>
149+
137150
``` python
138151
read_from_directory(dataset_info_dir)
139152
```
@@ -152,6 +165,9 @@ This will overwrite all previous metadata.
152165

153166
<h3 id="update_splits_if_different"><code>update_splits_if_different</code></h3>
154167

168+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
169+
source</a>
170+
155171
``` python
156172
update_splits_if_different(split_dict)
157173
```
@@ -171,6 +187,9 @@ Overwrite the splits if they are different from the current ones.
171187

172188
<h3 id="write_to_directory"><code>write_to_directory</code></h3>
173189

190+
<a target="_blank" href=https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py>View
191+
source</a>
192+
174193
``` python
175194
write_to_directory(dataset_info_dir)
176195
```

0 commit comments

Comments
 (0)