mindspore.dataset.MindDataset
- class mindspore.dataset.MindDataset(dataset_files, columns_list=None, num_parallel_workers=None, shuffle=None, num_shards=None, shard_id=None, sampler=None, padded_sample=None, num_padded=None, num_samples=None, cache=None)[源代码]
读取和解析MindRecord数据文件构建数据集。生成的数据集的列名和列类型取决于MindRecord文件中的保存的列名与类型。
- 参数:
dataset_files (Union[str, list[str]]) - MindRecord文件路径,支持单文件路径字符串、多文件路径字符串列表。如果 dataset_files 的类型是字符串,则它代表一组具有相同前缀名的MindRecord文件,同一路径下具有相同前缀名的其他MindRecord文件将会被自动寻找并加载。如果 dataset_files 的类型是列表,则它表示所需读取的MindRecord数据文件。
columns_list (list[str],可选) - 指定从MindRecord文件中读取的数据列。默认值:
None
,读取所有列。num_parallel_workers (int, 可选) - 指定读取数据的工作线程数。默认值:
None
,使用全局默认线程数(8),也可以通过mindspore.dataset.config.set_num_parallel_workers()
配置全局线程数。shuffle (Union[bool,
Shuffle
], 可选) - 每个epoch中数据混洗的模式,支持传入bool类型与枚举类型进行指定。默认值:None
,采用mindspore.dataset.Shuffle.GLOBAL
。 如果 shuffle 为False
,则不混洗,如果 shuffle 为True
,等同于将 shuffle 设置为mindspore.dataset.Shuffle.GLOBAL
。 通过传入枚举变量设置数据混洗的模式:Shuffle.GLOBAL
:混洗文件和文件中的数据。Shuffle.FILES
:仅混洗文件,当数据集样本量大于1亿条时不支持。Shuffle.INFILE
:保持读入文件的序列,仅混洗每个文件中的数据,当数据集样本量大于1亿条时不支持。
num_shards (int, 可选) - 指定分布式训练时将数据集进行划分的分片数。默认值:
None
。指定此参数后, num_samples 表示每个分片的最大样本数。shard_id (int, 可选) - 指定分布式训练时使用的分片ID号。默认值:
None
。只有当指定了 num_shards 时才能指定此参数。sampler (Sampler, 可选) - 指定从数据集中选取样本的采样器。默认值:
None
。下表中会展示不同配置的预期行为。当前此数据集仅支持以下采样器:mindspore.dataset.SubsetRandomSampler
、mindspore.dataset.PKSampler
、mindspore.dataset.RandomSampler
、mindspore.dataset.SequentialSampler
和mindspore.dataset.DistributedSampler
。padded_sample (dict, 可选) - 指定额外添加到数据集的样本,可用于在分布式训练时补齐分片数据,注意字典的键名需要与 columns_list 指定的列名相同。默认值:
None
,不添加样本。需要与 num_padded 参数同时使用。num_padded (int, 可选) - 指定额外添加的数据集样本的数量。在分布式训练时可用于为数据集补齐样本,使得总样本数量可被 num_shards 整除。默认值:
None
,不添加样本。需要与 padded_sample 参数同时使用。num_samples (int, 可选) - 指定从数据集中读取的样本数。默认值:
None
,读取所有样本。cache (
DatasetCache
, 可选) - 单节点数据缓存服务,用于加快数据集处理,详情请阅读 单节点数据缓存 。默认值:None
,不使用缓存。
- 异常:
ValueError - dataset_files 参数所指向的文件无效或不存在。
ValueError - num_parallel_workers 参数超过最大线程数。
RuntimeError - 指定了 num_shards 参数,但是未指定 shard_id 参数。
RuntimeError - 指定了 shard_id 参数,但是未指定 num_shards 参数。
ValueError - 如果 shard_id 取值不在[0, num_shards )范围。
样例:
>>> import mindspore.dataset as ds >>> mindrecord_files = ["/path/to/mind_dataset_file"] # contains 1 or multiple MindRecord files >>> dataset = ds.MindDataset(dataset_files=mindrecord_files)
- 教程样例:
说明
入参 num_samples 、 shuffle 、 num_shards 、 shard_id 可用于控制数据集所使用的采样器,其与入参 sampler 搭配使用的效果如下。
参数 sampler
参数 num_shards / shard_id
参数 shuffle
参数 num_samples
使用的采样器
mindspore.dataset.Sampler 类型
None
None
None
sampler
numpy.ndarray,list,tuple,int 类型
/
/
num_samples
SubsetSampler(indices = sampler , num_samples = num_samples )
iterable 类型
/
/
num_samples
IterSampler(sampler = sampler , num_samples = num_samples )
None
num_shards / shard_id
None / True
num_samples
DistributedSampler(num_shards = num_shards , shard_id = shard_id , shuffle = True , num_samples = num_samples )
None
num_shards / shard_id
False
num_samples
DistributedSampler(num_shards = num_shards , shard_id = shard_id , shuffle = False , num_samples = num_samples )
None
None
None / True
None
RandomSampler(num_samples = num_samples )
None
None
None / True
num_samples
RandomSampler(replacement = True , num_samples = num_samples )
None
None
False
num_samples
SequentialSampler(num_samples = num_samples )
预处理操作
对数据集对象执行给定操作函数。 |
|
对传入的多个数据集对象进行拼接操作。 |
|
通过自定义判断条件对数据集对象中的数据进行过滤。 |
|
对数据集对象中每一条数据执行给定的数据处理,并将结果展平。 |
|
给定一组数据增强列表,按顺序将数据增强作用在数据集对象上。 |
|
从数据集对象中选择需要的列,并按给定的列名的顺序进行排序。 |
|
对数据集对象按指定的列名进行重命名。 |
|
重复此数据集 count 次。 |
|
重置下一个epoch的数据集对象。 |
|
将数据处理管道中正处理的数据保存为通用的数据集格式。 |
|
通过创建 buffer_size 大小的缓存来混洗该数据集。 |
|
跳过此数据集对象的前 count 条数据。 |
|
将数据集拆分为多个不重叠的子数据集。 |
|
截取数据集的前指定条数据。 |
|
将多个dataset对象按列进行合并压缩,多个dataset对象不能有相同的列名。 |
Batch(批操作)
将数据集中连续 batch_size 条数据组合为一个批数据,并可通过可选参数 per_batch_map 指定组合前要进行的预处理操作。 |
|
根据数据的长度进行分桶。 |
|
将数据集中连续 batch_size 条数据组合为一个批数据,并可通过可选参数 pad_info 预先将样本补齐。 |
迭代器
基于数据集对象创建迭代器。 |
|
基于数据集对象创建迭代器。 |
数据集属性
获得数据集对象定义的批处理大小,即一个批处理数据中包含的数据条数。 |
|
获取类别名称到类别索引的映射字典。 |
|
返回数据集对象中包含的列名。 |
|
返回一个epoch中的batch数。 |
|
获取 RepeatDataset 中定义的repeat操作的次数。 |
|
获取/设置数据列索引,它表示使用下沉模式时数据列映射至网络中的对应关系。 |
|
获取数据集对象中所有样本的类别数目。 |
|
获取数据集对象中每列数据的shape。 |
|
获取数据集对象中每列数据的数据类型。 |
应用采样方法
为当前数据集添加子采样器。 |
|
替换当前数据集的最末子采样器,保持父采样器不变。 |
其他方法
释放阻塞条件并使用给定数据触发回调函数。 |
|
为同步操作在数据集对象上添加阻塞条件。 |
|
将数据处理管道序列化为JSON字符串,如果提供了文件名,则转储到文件中。 |