Skip to content

Commit 548f2c4

Browse files
author
The TensorFlow Datasets Authors
committed
Automated documentation update.
PiperOrigin-RevId: 632576990
1 parent 7b66e9b commit 548f2c4

File tree

4 files changed

+402
-9
lines changed

4 files changed

+402
-9
lines changed

docs/catalog/_toc.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1070,6 +1070,9 @@ toc:
10701070
title: robo_set
10711071
- path: /datasets/catalog/roboturk
10721072
title: roboturk
1073+
- path: /datasets/catalog/spoc_robot
1074+
status: nightly
1075+
title: spoc_robot
10731076
- path: /datasets/catalog/stanford_hydra_dataset_converted_externally_to_rlds
10741077
title: stanford_hydra_dataset_converted_externally_to_rlds
10751078
- path: /datasets/catalog/stanford_kuka_multimodal_dataset_converted_externally_to_rlds

docs/catalog/emnist.md

Lines changed: 253 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<meta itemprop="name" content="TensorFlow Datasets" />
44
</div>
55
<meta itemprop="name" content="emnist" />
6-
<meta itemprop="description" content="The EMNIST dataset is a set of handwritten character digits derived from the NIST Special Database 19 and converted to a 28x28 pixel image format and dataset structure that directly matches the MNIST dataset.&#10;&#10;Note: Like the original EMNIST data, images provided here are inverted horizontally and rotated 90 anti-clockwise. You can use `tf.transpose` within `ds.map` to convert the images to a human-friendlier format.&#10;&#10;To use this dataset:&#10;&#10;```python&#10;import tensorflow_datasets as tfds&#10;&#10;ds = tfds.load(&#x27;emnist&#x27;, split=&#x27;train&#x27;)&#10;for ex in ds.take(4):&#10; print(ex)&#10;```&#10;&#10;See [the guide](https://www.tensorflow.org/datasets/overview) for more&#10;informations on [tensorflow_datasets](https://www.tensorflow.org/datasets).&#10;&#10;" />
6+
<meta itemprop="description" content="The EMNIST dataset is a set of handwritten character digits derived from the NIST Special Database 19 and converted to a 28x28 pixel image format and dataset structure that directly matches the MNIST dataset.&#10;&#10;Note: Like the original EMNIST data, images provided here are inverted horizontally and rotated 90 anti-clockwise. You can use `tf.transpose` within `ds.map` to convert the images to a human-friendlier format.&#10;&#10;To use this dataset:&#10;&#10;```python&#10;import tensorflow_datasets as tfds&#10;&#10;ds = tfds.load(&#x27;emnist&#x27;, split=&#x27;train&#x27;)&#10;for ex in ds.take(4):&#10; print(ex)&#10;```&#10;&#10;See [the guide](https://www.tensorflow.org/datasets/overview) for more&#10;informations on [tensorflow_datasets](https://www.tensorflow.org/datasets).&#10;&#10;&lt;img src=&quot;https://storage.googleapis.com/tfds-data/visualization/fig/emnist-byclass-3.1.0.png&quot; alt=&quot;Visualization&quot; width=&quot;500px&quot;&gt;&#10;&#10;" />
77
<meta itemprop="url" content="https://www.tensorflow.org/datasets/catalog/emnist" />
88
<meta itemprop="sameAs" content="https://www.nist.gov/itl/products-and-services/emnist-dataset" />
99
<meta itemprop="citation" content="@article{cohen_afshar_tapson_schaik_2017,&#10; title={EMNIST: Extending MNIST to handwritten letters},&#10; DOI={10.1109/ijcnn.2017.7966217},&#10; journal={2017 International Joint Conference on Neural Networks (IJCNN)},&#10; author={Cohen, Gregory and Afshar, Saeed and Tapson, Jonathan and Schaik, Andre Van},&#10; year={2017}&#10;}" />
@@ -58,14 +58,6 @@ horizontally and rotated 90 anti-clockwise. You can use `tf.transpose` within
5858
[`as_supervised` doc](https://www.tensorflow.org/datasets/api_docs/python/tfds/load#args)):
5959
`('image', 'label')`
6060

61-
* **Figure**
62-
([tfds.show_examples](https://www.tensorflow.org/datasets/api_docs/python/tfds/visualization/show_examples)):
63-
Not supported.
64-
65-
* **Examples**
66-
([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):
67-
Missing.
68-
6961
* **Citation**:
7062

7163
```
@@ -113,6 +105,48 @@ Feature | Class | Shape | Dtype | Description
113105
image | Image | (28, 28, 1) | uint8 |
114106
label | ClassLabel | | int64 |
115107

108+
* **Figure**
109+
([tfds.show_examples](https://www.tensorflow.org/datasets/api_docs/python/tfds/visualization/show_examples)):
110+
111+
<img src="https://storage.googleapis.com/tfds-data/visualization/fig/emnist-byclass-3.1.0.png" alt="Visualization" width="500px">
112+
113+
* **Examples**
114+
([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):
115+
116+
<!-- mdformat off(HTML should not be auto-formatted) -->
117+
118+
{% framebox %}
119+
120+
<button id="displaydataframe">Display examples...</button>
121+
<div id="dataframecontent" style="overflow-x:auto"></div>
122+
<script>
123+
const url = "https://storage.googleapis.com/tfds-data/visualization/dataframe/emnist-byclass-3.1.0.html";
124+
const dataButton = document.getElementById('displaydataframe');
125+
dataButton.addEventListener('click', async () => {
126+
// Disable the button after clicking (dataframe loaded only once).
127+
dataButton.disabled = true;
128+
129+
const contentPane = document.getElementById('dataframecontent');
130+
try {
131+
const response = await fetch(url);
132+
// Error response codes don't throw an error, so force an error to show
133+
// the error message.
134+
if (!response.ok) throw Error(response.statusText);
135+
136+
const data = await response.text();
137+
contentPane.innerHTML = data;
138+
} catch (e) {
139+
contentPane.innerHTML =
140+
'Error loading examples. If the error persist, please open '
141+
+ 'a new issue.';
142+
}
143+
});
144+
</script>
145+
146+
{% endframebox %}
147+
148+
<!-- mdformat on -->
149+
116150
## emnist/bymerge
117151

118152
* **Config description**: EMNIST ByMerge
@@ -147,6 +181,48 @@ Feature | Class | Shape | Dtype | Description
147181
image | Image | (28, 28, 1) | uint8 |
148182
label | ClassLabel | | int64 |
149183

184+
* **Figure**
185+
([tfds.show_examples](https://www.tensorflow.org/datasets/api_docs/python/tfds/visualization/show_examples)):
186+
187+
<img src="https://storage.googleapis.com/tfds-data/visualization/fig/emnist-bymerge-3.1.0.png" alt="Visualization" width="500px">
188+
189+
* **Examples**
190+
([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):
191+
192+
<!-- mdformat off(HTML should not be auto-formatted) -->
193+
194+
{% framebox %}
195+
196+
<button id="displaydataframe">Display examples...</button>
197+
<div id="dataframecontent" style="overflow-x:auto"></div>
198+
<script>
199+
const url = "https://storage.googleapis.com/tfds-data/visualization/dataframe/emnist-bymerge-3.1.0.html";
200+
const dataButton = document.getElementById('displaydataframe');
201+
dataButton.addEventListener('click', async () => {
202+
// Disable the button after clicking (dataframe loaded only once).
203+
dataButton.disabled = true;
204+
205+
const contentPane = document.getElementById('dataframecontent');
206+
try {
207+
const response = await fetch(url);
208+
// Error response codes don't throw an error, so force an error to show
209+
// the error message.
210+
if (!response.ok) throw Error(response.statusText);
211+
212+
const data = await response.text();
213+
contentPane.innerHTML = data;
214+
} catch (e) {
215+
contentPane.innerHTML =
216+
'Error loading examples. If the error persist, please open '
217+
+ 'a new issue.';
218+
}
219+
});
220+
</script>
221+
222+
{% endframebox %}
223+
224+
<!-- mdformat on -->
225+
150226
## emnist/balanced
151227

152228
* **Config description**: EMNIST Balanced
@@ -181,6 +257,48 @@ Feature | Class | Shape | Dtype | Description
181257
image | Image | (28, 28, 1) | uint8 |
182258
label | ClassLabel | | int64 |
183259

260+
* **Figure**
261+
([tfds.show_examples](https://www.tensorflow.org/datasets/api_docs/python/tfds/visualization/show_examples)):
262+
263+
<img src="https://storage.googleapis.com/tfds-data/visualization/fig/emnist-balanced-3.1.0.png" alt="Visualization" width="500px">
264+
265+
* **Examples**
266+
([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):
267+
268+
<!-- mdformat off(HTML should not be auto-formatted) -->
269+
270+
{% framebox %}
271+
272+
<button id="displaydataframe">Display examples...</button>
273+
<div id="dataframecontent" style="overflow-x:auto"></div>
274+
<script>
275+
const url = "https://storage.googleapis.com/tfds-data/visualization/dataframe/emnist-balanced-3.1.0.html";
276+
const dataButton = document.getElementById('displaydataframe');
277+
dataButton.addEventListener('click', async () => {
278+
// Disable the button after clicking (dataframe loaded only once).
279+
dataButton.disabled = true;
280+
281+
const contentPane = document.getElementById('dataframecontent');
282+
try {
283+
const response = await fetch(url);
284+
// Error response codes don't throw an error, so force an error to show
285+
// the error message.
286+
if (!response.ok) throw Error(response.statusText);
287+
288+
const data = await response.text();
289+
contentPane.innerHTML = data;
290+
} catch (e) {
291+
contentPane.innerHTML =
292+
'Error loading examples. If the error persist, please open '
293+
+ 'a new issue.';
294+
}
295+
});
296+
</script>
297+
298+
{% endframebox %}
299+
300+
<!-- mdformat on -->
301+
184302
## emnist/letters
185303

186304
* **Config description**: EMNIST Letters
@@ -215,6 +333,48 @@ Feature | Class | Shape | Dtype | Description
215333
image | Image | (28, 28, 1) | uint8 |
216334
label | ClassLabel | | int64 |
217335

336+
* **Figure**
337+
([tfds.show_examples](https://www.tensorflow.org/datasets/api_docs/python/tfds/visualization/show_examples)):
338+
339+
<img src="https://storage.googleapis.com/tfds-data/visualization/fig/emnist-letters-3.1.0.png" alt="Visualization" width="500px">
340+
341+
* **Examples**
342+
([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):
343+
344+
<!-- mdformat off(HTML should not be auto-formatted) -->
345+
346+
{% framebox %}
347+
348+
<button id="displaydataframe">Display examples...</button>
349+
<div id="dataframecontent" style="overflow-x:auto"></div>
350+
<script>
351+
const url = "https://storage.googleapis.com/tfds-data/visualization/dataframe/emnist-letters-3.1.0.html";
352+
const dataButton = document.getElementById('displaydataframe');
353+
dataButton.addEventListener('click', async () => {
354+
// Disable the button after clicking (dataframe loaded only once).
355+
dataButton.disabled = true;
356+
357+
const contentPane = document.getElementById('dataframecontent');
358+
try {
359+
const response = await fetch(url);
360+
// Error response codes don't throw an error, so force an error to show
361+
// the error message.
362+
if (!response.ok) throw Error(response.statusText);
363+
364+
const data = await response.text();
365+
contentPane.innerHTML = data;
366+
} catch (e) {
367+
contentPane.innerHTML =
368+
'Error loading examples. If the error persist, please open '
369+
+ 'a new issue.';
370+
}
371+
});
372+
</script>
373+
374+
{% endframebox %}
375+
376+
<!-- mdformat on -->
377+
218378
## emnist/digits
219379

220380
* **Config description**: EMNIST Digits
@@ -249,6 +409,48 @@ Feature | Class | Shape | Dtype | Description
249409
image | Image | (28, 28, 1) | uint8 |
250410
label | ClassLabel | | int64 |
251411

412+
* **Figure**
413+
([tfds.show_examples](https://www.tensorflow.org/datasets/api_docs/python/tfds/visualization/show_examples)):
414+
415+
<img src="https://storage.googleapis.com/tfds-data/visualization/fig/emnist-digits-3.1.0.png" alt="Visualization" width="500px">
416+
417+
* **Examples**
418+
([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):
419+
420+
<!-- mdformat off(HTML should not be auto-formatted) -->
421+
422+
{% framebox %}
423+
424+
<button id="displaydataframe">Display examples...</button>
425+
<div id="dataframecontent" style="overflow-x:auto"></div>
426+
<script>
427+
const url = "https://storage.googleapis.com/tfds-data/visualization/dataframe/emnist-digits-3.1.0.html";
428+
const dataButton = document.getElementById('displaydataframe');
429+
dataButton.addEventListener('click', async () => {
430+
// Disable the button after clicking (dataframe loaded only once).
431+
dataButton.disabled = true;
432+
433+
const contentPane = document.getElementById('dataframecontent');
434+
try {
435+
const response = await fetch(url);
436+
// Error response codes don't throw an error, so force an error to show
437+
// the error message.
438+
if (!response.ok) throw Error(response.statusText);
439+
440+
const data = await response.text();
441+
contentPane.innerHTML = data;
442+
} catch (e) {
443+
contentPane.innerHTML =
444+
'Error loading examples. If the error persist, please open '
445+
+ 'a new issue.';
446+
}
447+
});
448+
</script>
449+
450+
{% endframebox %}
451+
452+
<!-- mdformat on -->
453+
252454
## emnist/mnist
253455

254456
* **Config description**: EMNIST MNIST
@@ -282,3 +484,45 @@ Feature | Class | Shape | Dtype | Description
282484
| FeaturesDict | | |
283485
image | Image | (28, 28, 1) | uint8 |
284486
label | ClassLabel | | int64 |
487+
488+
* **Figure**
489+
([tfds.show_examples](https://www.tensorflow.org/datasets/api_docs/python/tfds/visualization/show_examples)):
490+
491+
<img src="https://storage.googleapis.com/tfds-data/visualization/fig/emnist-mnist-3.1.0.png" alt="Visualization" width="500px">
492+
493+
* **Examples**
494+
([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):
495+
496+
<!-- mdformat off(HTML should not be auto-formatted) -->
497+
498+
{% framebox %}
499+
500+
<button id="displaydataframe">Display examples...</button>
501+
<div id="dataframecontent" style="overflow-x:auto"></div>
502+
<script>
503+
const url = "https://storage.googleapis.com/tfds-data/visualization/dataframe/emnist-mnist-3.1.0.html";
504+
const dataButton = document.getElementById('displaydataframe');
505+
dataButton.addEventListener('click', async () => {
506+
// Disable the button after clicking (dataframe loaded only once).
507+
dataButton.disabled = true;
508+
509+
const contentPane = document.getElementById('dataframecontent');
510+
try {
511+
const response = await fetch(url);
512+
// Error response codes don't throw an error, so force an error to show
513+
// the error message.
514+
if (!response.ok) throw Error(response.statusText);
515+
516+
const data = await response.text();
517+
contentPane.innerHTML = data;
518+
} catch (e) {
519+
contentPane.innerHTML =
520+
'Error loading examples. If the error persist, please open '
521+
+ 'a new issue.';
522+
}
523+
});
524+
</script>
525+
526+
{% endframebox %}
527+
528+
<!-- mdformat on -->

docs/catalog/overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -675,6 +675,8 @@ for ex in tfds.load('cifar10', split='train'):
675675
* [`robo_set`](robo_set.md)
676676
<span class="material-icons" title="Available only in the tfds-nightly package">nights_stay</span>
677677
* [`roboturk`](roboturk.md)
678+
* [`spoc_robot`](spoc_robot.md)
679+
<span class="material-icons" title="Available only in the tfds-nightly package">nights_stay</span>
678680
* [`stanford_hydra_dataset_converted_externally_to_rlds`](stanford_hydra_dataset_converted_externally_to_rlds.md)
679681
* [`stanford_kuka_multimodal_dataset_converted_externally_to_rlds`](stanford_kuka_multimodal_dataset_converted_externally_to_rlds.md)
680682
* [`stanford_mask_vit_converted_externally_to_rlds`](stanford_mask_vit_converted_externally_to_rlds.md)

0 commit comments

Comments
 (0)