mnists/README.md

53 lines
2.2 KiB
Markdown
Raw Normal View History

2018-03-14 08:16:14 -07:00
# mnists
downloads and prepares various mnist-compatible datasets.
2018-03-14 08:53:25 -07:00
files are downloaded to `~/.mnist`
and checked for integrity by SHA-256 hashes.
2018-03-14 08:16:14 -07:00
### dependencies
2018-03-14 08:16:14 -07:00
python 3.6 (or later), numpy.
### install
`pip install --upgrade --upgrade-strategy only-if-needed 'https://github.com/notwa/mnists/tarball/master#egg=mnists'`
2018-03-14 08:16:14 -07:00
2018-03-14 08:53:25 -07:00
I've added `--upgrade-strategy` to the command-line
2018-03-14 08:16:14 -07:00
so you don't accidentally "upgrade" numpy to
a version not compiled specifically for your system.
This can happen when using e.g. [Anaconda.][anaconda]
[anaconda]: //www.anaconda.com/
2018-03-14 08:16:14 -07:00
## usage
```python
import mnists
dataset = "emnist_balanced"
train_images, train_labels, test_images, test_labels = mnists.prepare(dataset)
```
2018-03-14 08:53:25 -07:00
the default images shape is (n, 1, 28, 28).
2018-03-14 08:16:14 -07:00
pass `flatten=True` to `mnists.prepare` to get (n, 784).
## datasets
2018-03-14 18:10:28 -07:00
in alphabetical order, using default `mnists.prepare` parameters:
2018-03-14 08:16:14 -07:00
[emnist]: //www.nist.gov/itl/iad/image-group/emnist-dataset
[fashion-mnist]: //github.com/zalandoresearch/fashion-mnist
[mnist]: http://yann.lecun.com/exdb/mnist/
2018-03-14 18:10:28 -07:00
| dataset | train images shape | train labels shape | test images shape | test labels shape |
| :--- | ---: | ---: | ---: | ---: |
| emnist\_balanced | (112800, 1, 28, 28) | (112800, 47) | (18800, 1, 28, 28) | (18800, 47) |
| emnist\_byclass | (697932, 1, 28, 28) | (697932, 62) | (116323, 1, 28, 28) | (116323, 62) |
| emnist\_bymerge | (697932, 1, 28, 28) | (697932, 47) | (116323, 1, 28, 28) | (116323, 47) |
| emnist\_digits | (240000, 1, 28, 28) | (240000, 10) | (40000, 1, 28, 28) | (40000, 10) |
| emnist\_letters | (124800, 1, 28, 28) | (124800, 26) | (20800, 1, 28, 28) | (20800, 26) |
| emnist\_mnist | (60000, 1, 28, 28) | (60000, 10) | (10000, 1, 28, 28) | (10000, 10) |
| fashion\_mnist | (60000, 1, 28, 28) | (60000, 10) | (10000, 1, 28, 28) | (10000, 10) |
| mnist | (60000, 1, 28, 28) | (60000, 10) | (10000, 1, 28, 28) | (10000, 10) |