Skip to content

Commit ea08b49

Browse files
author
The TensorFlow Datasets Authors
committed
Automated documentation update.
PiperOrigin-RevId: 675261508
1 parent 7dd3a31 commit ea08b49

File tree

3 files changed

+116
-0
lines changed

3 files changed

+116
-0
lines changed

docs/catalog/_toc.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,11 @@ toc:
237237
- path: /datasets/catalog/cardiotox
238238
title: cardiotox
239239
title: Graphs
240+
- section:
241+
- path: /datasets/catalog/pneumonia_mnist
242+
status: nightly
243+
title: pneumonia_mnist
244+
title: Health
240245
- section:
241246
- path: /datasets/catalog/abstract_reasoning
242247
title: abstract_reasoning (manual)
@@ -344,6 +349,9 @@ toc:
344349
title: plant_village
345350
- path: /datasets/catalog/plantae_k
346351
title: plantae_k
352+
- path: /datasets/catalog/pneumonia_mnist
353+
status: nightly
354+
title: pneumonia_mnist
347355
- path: /datasets/catalog/quickdraw_bitmap
348356
title: quickdraw_bitmap
349357
- path: /datasets/catalog/ref_coco
@@ -503,6 +511,9 @@ toc:
503511
title: places365_small
504512
- path: /datasets/catalog/plant_village
505513
title: plant_village
514+
- path: /datasets/catalog/pneumonia_mnist
515+
status: nightly
516+
title: pneumonia_mnist
506517
- path: /datasets/catalog/resisc45
507518
title: resisc45 (manual)
508519
- path: /datasets/catalog/siscore

docs/catalog/overview.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,11 @@ for ex in tfds.load('cifar10', split='train'):
191191

192192
* [`cardiotox`](cardiotox.md)
193193

194+
### `Health`
195+
196+
* [`pneumonia_mnist`](pneumonia_mnist.md)
197+
<span class="material-icons" title="Available only in the tfds-nightly package">nights_stay</span>
198+
194199
### `Image`
195200

196201
* [`abstract_reasoning`](abstract_reasoning.md)
@@ -246,6 +251,8 @@ for ex in tfds.load('cifar10', split='train'):
246251
* [`plant_leaves`](plant_leaves.md)
247252
* [`plant_village`](plant_village.md)
248253
* [`plantae_k`](plantae_k.md)
254+
* [`pneumonia_mnist`](pneumonia_mnist.md)
255+
<span class="material-icons" title="Available only in the tfds-nightly package">nights_stay</span>
249256
* [`quickdraw_bitmap`](quickdraw_bitmap.md)
250257
* [`ref_coco`](ref_coco.md)
251258
* [`resisc45`](resisc45.md)
@@ -328,6 +335,8 @@ for ex in tfds.load('cifar10', split='train'):
328335
* [`oxford_iiit_pet`](oxford_iiit_pet.md)
329336
* [`places365_small`](places365_small.md)
330337
* [`plant_village`](plant_village.md)
338+
* [`pneumonia_mnist`](pneumonia_mnist.md)
339+
<span class="material-icons" title="Available only in the tfds-nightly package">nights_stay</span>
331340
* [`resisc45`](resisc45.md)
332341
* [`siscore`](siscore.md)
333342
* [`smallnorb`](smallnorb.md)

docs/catalog/pneumonia_mnist.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
<div itemscope itemtype="http://schema.org/Dataset">
2+
<div itemscope itemprop="includedInDataCatalog" itemtype="http://schema.org/DataCatalog">
3+
<meta itemprop="name" content="TensorFlow Datasets" />
4+
</div>
5+
<meta itemprop="name" content="pneumonia_mnist" />
6+
<meta itemprop="description" content="# MedMNIST Pneumonia Dataset&#10;&#10;The PneumoniaMNIST is based on a prior dataset of 5,856 pediatric chest X-Ray&#10;images. The task is binary-class classification of pneumonia against normal. The&#10;source training set is split with a ratio of 9:1 into training and validation&#10;set, and use its source validation set as the test set. The source images are&#10;gray-scale, and their sizes are (384–2,916) × (127–2,713). The images are&#10;center-cropped with a window size of length of the short edge and resized into 1&#10;× 28 × 28.&#10;&#10;To use this dataset:&#10;&#10;```python&#10;import tensorflow_datasets as tfds&#10;&#10;ds = tfds.load(&#x27;pneumonia_mnist&#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;" />
7+
<meta itemprop="url" content="https://www.tensorflow.org/datasets/catalog/pneumonia_mnist" />
8+
<meta itemprop="sameAs" content="https://medmnist.com//" />
9+
<meta itemprop="citation" content="@article{yang2023medmnist,&#10; title={Medmnist v2-a large-scale lightweight benchmark for 2d and 3d biomedical image classification},&#10; author={Yang, Jiancheng and Shi, Rui and Wei, Donglai and Liu, Zequan and Zhao, Lin and Ke, Bilian and Pfister, Hanspeter and Ni, Bingbing},&#10; journal={Scientific Data},&#10; volume={10},&#10; number={1},&#10; pages={41},&#10; year={2023},&#10; publisher={Nature Publishing Group UK London}&#10;}" />
10+
</div>
11+
12+
# `pneumonia_mnist`
13+
14+
15+
Note: This dataset was added recently and is only available in our
16+
`tfds-nightly` package
17+
<span class="material-icons" title="Available only in the tfds-nightly package">nights_stay</span>.
18+
19+
* **Description**:
20+
21+
# MedMNIST Pneumonia Dataset
22+
23+
The PneumoniaMNIST is based on a prior dataset of 5,856 pediatric chest X-Ray
24+
images. The task is binary-class classification of pneumonia against normal. The
25+
source training set is split with a ratio of 9:1 into training and validation
26+
set, and use its source validation set as the test set. The source images are
27+
gray-scale, and their sizes are (384–2,916) × (127–2,713). The images are
28+
center-cropped with a window size of length of the short edge and resized into 1
29+
× 28 × 28.
30+
31+
* **Homepage**: [https://medmnist.com//](https://medmnist.com//)
32+
33+
* **Source code**:
34+
[`tfds.datasets.pneumonia_mnist.Builder`](https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/datasets/pneumonia_mnist/pneumonia_mnist_dataset_builder.py)
35+
36+
* **Versions**:
37+
38+
* **`1.0.0`** (default): Initial release.
39+
40+
* **Download size**: `Unknown size`
41+
42+
* **Dataset size**: `Unknown size`
43+
44+
* **Auto-cached**
45+
([documentation](https://www.tensorflow.org/datasets/performances#auto-caching)):
46+
Unknown
47+
48+
* **Splits**:
49+
50+
Split | Examples
51+
:---- | -------:
52+
53+
* **Feature structure**:
54+
55+
```python
56+
FeaturesDict({
57+
'image': Image(shape=(28, 28, 1), dtype=uint8),
58+
'label': ClassLabel(shape=(), dtype=int64, num_classes=2),
59+
})
60+
```
61+
62+
* **Feature documentation**:
63+
64+
Feature | Class | Shape | Dtype | Description
65+
:------ | :----------- | :---------- | :---- | :----------
66+
| FeaturesDict | | |
67+
image | Image | (28, 28, 1) | uint8 |
68+
label | ClassLabel | | int64 |
69+
70+
* **Supervised keys** (See
71+
[`as_supervised` doc](https://www.tensorflow.org/datasets/api_docs/python/tfds/load#args)):
72+
`('image', 'label')`
73+
74+
* **Figure**
75+
([tfds.show_examples](https://www.tensorflow.org/datasets/api_docs/python/tfds/visualization/show_examples)):
76+
Not supported.
77+
78+
* **Examples**
79+
([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):
80+
Missing.
81+
82+
* **Citation**:
83+
84+
```
85+
@article{yang2023medmnist,
86+
title={Medmnist v2-a large-scale lightweight benchmark for 2d and 3d biomedical image classification},
87+
author={Yang, Jiancheng and Shi, Rui and Wei, Donglai and Liu, Zequan and Zhao, Lin and Ke, Bilian and Pfister, Hanspeter and Ni, Bingbing},
88+
journal={Scientific Data},
89+
volume={10},
90+
number={1},
91+
pages={41},
92+
year={2023},
93+
publisher={Nature Publishing Group UK London}
94+
}
95+
```
96+

0 commit comments

Comments
 (0)