mindspore.dataset.TFRecordDataset

class mindspore.dataset.TFRecordDataset(dataset_files, schema=None, columns_list=None, num_samples=None, num_parallel_workers=None, shuffle=Shuffle.GLOBAL, num_shards=None, shard_id=None, shard_equal_rows=False, cache=None, compression_type=None)

读取和解析TFData格式的数据文件构建数据集。生成的数据集的列名和列类型取决于TFRecord文件中的保存的列名与类型。

说明

Windows平台尚不支持 TFRecordDataset 。

参数：

• dataset_files (Union[str, list[str]]) - 数据集文件路径，支持单文件路径字符串、多文件路径字符串列表或可被glob库模式匹配的字符串，文件列表将在内部进行字典排序。

• schema (Union[str, Schema], 可选) - 数据格式策略，用于指定读取数据列的数据类型、数据维度等信息。 支持传入JSON文件路径或 mindspore.dataset.Schema 构造的对象。默认值： None 。

• columns_list (list[str], 可选) - 指定从TFRecord文件中读取的数据列。默认值： None ，读取所有列。

• num_samples (int, 可选) - 指定从数据集中读取的样本数。默认值： None ，读取全部样本。 当指定了 num_shards 和 shard_id 参数时，num_samples 或numRows字段（由参数 schema 定义）将表示每个分片读取的数据量。 num_samples 的处理优先级如下：

  • 指定了 num_samples 参数，且值大于0，则读取 num_samples 条数据。此时 schema 参数的numRows字段会失效。

  • 不指定 num_samples 参数，指定了 schema 参数并定义了numRows字段，且值大于0，则读取numRows条数据。

  • 不指定 num_samples 参数 与 schema 参数，读取所有样本数据。

• num_parallel_workers (int, 可选) - 指定读取数据的工作线程数。默认值： None ，使用全局默认线程数(8)，也可以通过 mindspore.dataset.config.set_num_parallel_workers() 配置全局线程数。

• shuffle (Union[bool, Shuffle], 可选) - 每个epoch中数据混洗的模式，支持传入bool类型与枚举类型进行指定。默认值： Shuffle.GLOBAL 。 如果 shuffle 为 False ，则不混洗，如果 shuffle 为 True ，等同于将 shuffle 设置为 mindspore.dataset.Shuffle.GLOBAL 。 通过传入枚举变量设置数据混洗的模式：

  • Shuffle.GLOBAL ：混洗文件和样本。

  • Shuffle.FILES ：仅混洗文件。

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

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

• shard_equal_rows (bool, 可选) - 分布式训练时，为所有分片获取等量的数据行数。默认值： False 。如果 shard_equal_rows 为 False ，则可能会使得每个分片的数据条目不相等，从而导致分布式训练失败。因此当每个TFRecord文件的数据数量不相等时，建议将此参数设置为 True 。注意，只有当指定了 num_shards 时才能指定此参数。当 compression_type 非 None ，且指定了 num_samples 或numRows字段（由参数 schema 定义）时，shard_equal_rows 会被视为 True 。

• cache (DatasetCache, 可选) - 单节点数据缓存服务，用于加快数据集处理，详情请阅读 单节点数据缓存 。默认值： None ，不使用缓存。

• compression_type (str, 可选) - 用于所有文件的压缩类型，必须是 “” ， “GZIP” 或 “ZLIB” 。默认值： None ，即空字符串。 建议在 compression_type 为 "GZIP" 或 "ZLIB" 时，指定 num_samples 或numRows字段（由参数 schema 定义）以避免出现为了获取文件大小对同一个文件进行多次解压而导致性能下降的问题。

异常：

• ValueError - dataset_files 参数所指向的文件无效或不存在。

• ValueError - num_parallel_workers 参数超过系统最大线程数。

• RuntimeError - 指定了 num_shards 参数，但是未指定 shard_id 参数。

• RuntimeError - 指定了 shard_id 参数，但是未指定 num_shards 参数。

• ValueError - 如果 shard_id 取值不在[0, num_shards )范围。

• ValueError - compression_type 不是 '' 、 'GZIP' 、 'ZLIB' 三者之一。

• ValueError - compression_type 有效但是数据集文件数量小于 num_shards 。

• ValueError - num_samples 小于0。

样例：

>>> import mindspore.dataset as ds
>>> from mindspore import dtype as mstype
>>>
>>> tfrecord_dataset_dir = ["/path/to/tfrecord_dataset_file"] # contains 1 or multiple TFRecord files
>>> tfrecord_schema_file = "/path/to/tfrecord_schema_file"
>>>
>>> # 1) Get all rows from tfrecord_dataset_dir with no explicit schema.
>>> # The meta-data in the first row will be used as a schema.
>>> dataset = ds.TFRecordDataset(dataset_files=tfrecord_dataset_dir)
>>>
>>> # 2) Get all rows from tfrecord_dataset_dir with user-defined schema.
>>> schema = ds.Schema()
>>> schema.add_column(name='col_1d', de_type=mstype.int64, shape=[2])
>>> dataset = ds.TFRecordDataset(dataset_files=tfrecord_dataset_dir, schema=schema)
>>>
>>> # 3) Get all rows from tfrecord_dataset_dir with the schema file.
>>> dataset = ds.TFRecordDataset(dataset_files=tfrecord_dataset_dir, schema=tfrecord_schema_file)

教程样例：

• 使用数据Pipeline加载 & 处理数据集

预处理操作

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	截取数据集的前指定条数据。
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.sync_update	释放阻塞条件并使用给定数据触发回调函数。
mindspore.dataset.Dataset.sync_wait	为同步操作在数据集对象上添加阻塞条件。
mindspore.dataset.Dataset.to_json	将数据处理管道序列化为JSON字符串，如果提供了文件名，则转储到文件中。