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：仅混洗文件。

  • Shuffle.INFILE：保持读入文件的序列，仅混洗每个文件中的数据。

• num_shards (int, 可选) - 指定分布式训练时将数据集进行划分的分片数。默认值：None。指定此参数后， num_samples 表示每个分片的最大样本数。

• shard_id (int, 可选) - 指定分布式训练时使用的分片ID号。默认值：None。只有当指定了 num_shards 时才能指定此参数。

• sampler (Sampler, 可选) - 指定从数据集中选取样本的采样器。默认值：None。下表中会展示不同配置的预期行为。当前此数据集仅支持以下采样器：SubsetRandomSampler、PkSampler、RandomSampler、SequentialSampler和DistributedSampler。

• padded_sample (dict, 可选) - 指定额外添加到数据集的样本，可用于在分布式训练时补齐分片数据，注意字典的键名需要与 column_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 )范围。

说明

此数据集可以指定参数 sampler ，但参数 sampler 和参数 shuffle 的行为是互斥的。下表展示了几种合法的输入参数组合及预期的行为。

配置 sampler 和 shuffle 的不同组合得到的预期排序结果

参数 sampler	参数 shuffle	预期数据顺序
None	None	随机排列
None	True	随机排列
None	False	顺序排列
sampler 实例	None	由 sampler 行为定义的顺序
sampler 实例	True	不允许
sampler 实例	False	不允许

样例：

>>> mind_dataset_dir = ["/path/to/mind_dataset_file"] # contains 1 or multiple MindRecord files
>>> dataset = ds.MindDataset(dataset_files=mind_dataset_dir)

预处理操作

mindspore.dataset.Dataset.apply	对数据集对象执行给定操作函数。
mindspore.dataset.Dataset.concat	对传入的多个数据集对象进行拼接操作。
mindspore.dataset.Dataset.filter	通过自定义判断条件对数据集对象中的数据进行过滤。
mindspore.dataset.Dataset.flat_map	对数据集对象中每一条数据执行给定的数据处理，并将结果展平。
mindspore.dataset.Dataset.map	给定一组数据增强列表，按顺序将数据增强作用在数据集对象上。
mindspore.dataset.Dataset.project	从数据集对象中选择需要的列，并按给定的列名的顺序进行排序。
mindspore.dataset.Dataset.rename	对数据集对象按指定的列名进行重命名。
mindspore.dataset.Dataset.repeat	重复此数据集 count 次。
mindspore.dataset.Dataset.reset	重置下一个epoch的数据集对象。
mindspore.dataset.Dataset.save	将数据处理管道中正处理的数据保存为通用的数据集格式。
mindspore.dataset.Dataset.shuffle	通过创建 buffer_size 大小的缓存来混洗该数据集。
mindspore.dataset.Dataset.skip	跳过此数据集对象的前 count 条数据。
mindspore.dataset.Dataset.split	将数据集拆分为多个不重叠的子数据集。
mindspore.dataset.Dataset.take	从数据集中获取最多 count 的元素。
mindspore.dataset.Dataset.zip	将多个dataset对象按列进行合并压缩，多个dataset对象不能有相同的列名。

Batch（批操作）

mindspore.dataset.Dataset.batch	将数据集中连续 batch_size 条数据组合为一个批数据，并可通过可选参数 per_batch_map 指定组合前要进行的预处理操作。
mindspore.dataset.Dataset.bucket_batch_by_length	根据数据的长度进行分桶。
mindspore.dataset.Dataset.padded_batch	将数据集中连续 batch_size 条数据组合为一个批数据，并可通过可选参数 pad_info 预先将样本补齐。

迭代器

mindspore.dataset.Dataset.create_dict_iterator	基于数据集对象创建迭代器。
mindspore.dataset.Dataset.create_tuple_iterator	基于数据集对象创建迭代器。

数据集属性

mindspore.dataset.Dataset.get_batch_size	获得数据集对象定义的批处理大小，即一个批处理数据中包含的数据条数。
mindspore.dataset.Dataset.get_class_indexing	返回类别索引。
mindspore.dataset.Dataset.get_col_names	返回数据集对象中包含的列名。
mindspore.dataset.Dataset.get_dataset_size	返回一个epoch中的batch数。
mindspore.dataset.Dataset.get_repeat_count	获取 RepeatDataset 中定义的repeat操作的次数。
mindspore.dataset.Dataset.input_indexs	获取/设置数据列索引，它表示使用下沉模式时数据列映射至网络中的对应关系。
mindspore.dataset.Dataset.num_classes	获取数据集对象中所有样本的类别数目。
mindspore.dataset.Dataset.output_shapes	获取数据集对象中每列数据的shape。
mindspore.dataset.Dataset.output_types	获取数据集对象中每列数据的数据类型。

应用采样方法

mindspore.dataset.MappableDataset.add_sampler	为当前数据集添加子采样器。
mindspore.dataset.MappableDataset.use_sampler	替换当前数据集的最末子采样器，保持父采样器不变。

其他方法

mindspore.dataset.Dataset.device_que	将数据异步传输到Ascend/GPU设备上。
mindspore.dataset.Dataset.sync_update	释放阻塞条件并使用给定数据触发回调函数。
mindspore.dataset.Dataset.sync_wait	为同步操作在数据集对象上添加阻塞条件。
mindspore.dataset.Dataset.to_json	将数据处理管道序列化为JSON字符串，如果提供了文件名，则转储到文件中。