forked from mindspore-Ecosystem/mindspore
90 lines
4.7 KiB
ReStructuredText
90 lines
4.7 KiB
ReStructuredText
mindspore.dataset.KMnistDataset
|
||
===============================
|
||
|
||
.. py:class:: mindspore.dataset.KMnistDataset(dataset_dir, usage=None, num_samples=None, num_parallel_workers=None, shuffle=None, sampler=None, num_shards=None, shard_id=None, cache=None)
|
||
|
||
读取和解析KMNIST数据集的源文件构建数据集。
|
||
|
||
生成的数据集有两列: `[image, label]` 。 `image` 列的数据类型为uint8。 `label` 列的数据类型为uint32。
|
||
|
||
参数：
|
||
- **dataset_dir** (str) - 包含数据集文件的根目录路径。
|
||
- **usage** (str, 可选) - 指定数据集的子集，可取值为 'train'、 'test' 或 'all'。
|
||
取值为 'train'时将会读取60,000个训练样本，取值为 'test'时将会读取10,000个测试样本，取值为 'all'时将会读取全部70,000个样本。默认值：None，读取全部样本图片。
|
||
- **num_samples** (int, 可选) - 指定从数据集中读取的样本数，可以小于数据集总数。默认值：None，读取全部样本图片。
|
||
- **num_parallel_workers** (int, 可选) - 指定读取数据的工作线程数。默认值：None，使用mindspore.dataset.config中配置的线程数。
|
||
- **shuffle** (bool, 可选) - 是否混洗数据集。默认值：None。下表中会展示不同参数配置的预期行为。
|
||
- **sampler** (Sampler, 可选) - 指定从数据集中选取样本的采样器。默认值：None。下表中会展示不同配置的预期行为。
|
||
- **num_shards** (int, 可选) - 指定分布式训练时将数据集进行划分的分片数。默认值：None。指定此参数后， `num_samples` 表示每个分片的最大样本数。
|
||
- **shard_id** (int, 可选) - 指定分布式训练时使用的分片ID号。默认值：None。只有当指定了 `num_shards` 时才能指定此参数。
|
||
- **cache** (DatasetCache, 可选) - 单节点数据缓存服务，用于加快数据集处理，详情请阅读 `单节点数据缓存 <https://www.mindspore.cn/tutorials/experts/zh-CN/master/dataset/cache.html>`_ 。默认值：None，不使用缓存。
|
||
|
||
异常：
|
||
- **RuntimeError** - `dataset_dir` 路径下不包含数据文件。
|
||
- **RuntimeError** - 同时指定了 `sampler` 和 `shuffle` 参数。
|
||
- **RuntimeError** - 同时指定了 `sampler` 和 `num_shards` 参数或同时指定了 `sampler` 和 `shard_id` 参数。
|
||
- **RuntimeError** - 指定了 `num_shards` 参数，但是未指定 `shard_id` 参数。
|
||
- **RuntimeError** - 指定了 `shard_id` 参数，但是未指定 `num_shards` 参数。
|
||
- **ValueError** - `num_parallel_workers` 参数超过系统最大线程数。
|
||
- **ValueError** - `shard_id` 参数错误，小于0或者大于等于 `num_shards` 。
|
||
|
||
.. note:: 此数据集可以指定参数 `sampler` ，但参数 `sampler` 和参数 `shuffle` 的行为是互斥的。下表展示了几种合法的输入参数组合及预期的行为。
|
||
|
||
.. list-table:: 配置 `sampler` 和 `shuffle` 的不同组合得到的预期排序结果
|
||
:widths: 25 25 50
|
||
:header-rows: 1
|
||
|
||
* - 参数 `sampler`
|
||
- 参数 `shuffle`
|
||
- 预期数据顺序
|
||
* - None
|
||
- None
|
||
- 随机排列
|
||
* - None
|
||
- True
|
||
- 随机排列
|
||
* - None
|
||
- False
|
||
- 顺序排列
|
||
* - `sampler` 实例
|
||
- None
|
||
- 由 `sampler` 行为定义的顺序
|
||
* - `sampler` 实例
|
||
- True
|
||
- 不允许
|
||
* - `sampler` 实例
|
||
- False
|
||
- 不允许
|
||
|
||
**关于KMNIST数据集：**
|
||
|
||
KMNIST是一个数据集，改编自Kuzushiji数据集，作为MNIST数据集的替代数据集（MNIST数据集是机器学习社区中著名的数据集）。
|
||
以下是原始KMNIST数据集结构。可以将数据集文件解压缩到此目录结构中，并由MindSpore的API读取。
|
||
|
||
.. code-block::
|
||
|
||
.
|
||
└── kmnist_dataset_dir
|
||
├── t10k-images-idx3-ubyte
|
||
├── t10k-labels-idx1-ubyte
|
||
├── train-images-idx3-ubyte
|
||
└── train-labels-idx1-ubyte
|
||
|
||
**引用：**
|
||
|
||
.. code-block::
|
||
|
||
@online{clanuwat2018deep,
|
||
author = {Tarin Clanuwat and Mikel Bober-Irizar and Asanobu Kitamoto and
|
||
Alex Lamb and Kazuaki Yamamoto and David Ha},
|
||
title = {Deep Learning for Classical Japanese Literature},
|
||
date = {2018-12-03},
|
||
year = {2018},
|
||
eprintclass = {cs.CV},
|
||
eprinttype = {arXiv},
|
||
eprint = {cs.CV/1812.01718},
|
||
}
|
||
|
||
|
||
.. include:: mindspore.dataset.api_list_vision.rst
|