mindspore.dataset.LFWDataset

class mindspore.dataset.LFWDataset(dataset_dir, task=None, usage=None, image_set=None, num_samples=None, num_parallel_workers=None, shuffle=None, decode=False, sampler=None, num_shards=None, shard_id=None, cache=None)[源代码]

LFW（Labeled Faces in the Wild）数据集。

当 task 为 ‘people’ 时，生成的数据集有两列： [image, label] ；当 task 为 ‘pairs’ 时，生成的数据集有三列： [image1, image2, label] 。 image 列的数据类型为uint8。 image1 列的数据类型为uint8。 image2 列的数据类型为uint8。 label 列的数据类型为uint32。

参数：

dataset_dir (str) - 包含数据集文件的根目录路径。
task (str, 可选) - 指定读取LFW数据集的任务类型，支持 ‘people’ 和 ‘pairs’。默认值：None，表示 ‘people’。
usage (str, 可选) - 指定数据集的子集，支持 ‘10fold’、’train’、’test’ 和 ‘all’。默认值：None，将读取 ‘train’ 和 ‘test’ 子集。
image_set (str, 可选) - 指定读取子集的 Image Funneling 类型，支持 ‘original’、’funneled’ 或 ‘deepfunneled’。默认值：None，将读取 ‘funneled’ 子集。
num_samples (int, 可选) - 指定从数据集中读取的样本数。默认值：None，读取全部图像。
num_parallel_workers (int, 可选) - 指定读取数据的工作线程数。默认值：None，使用全局默认线程数(8)，也可以通过 mindspore.dataset.config.set_num_parallel_workers 配置全局线程数。
shuffle (bool, 可选) - 是否混洗数据集。默认值：None。下表中会展示不同参数配置的预期行为。
decode (bool, 可选) - 是否对读取的图片进行解码操作。默认值：False，不解码。
sampler (Sampler, 可选) - 指定从数据集中选取样本的采样器。默认值：None。下表中会展示不同配置的预期行为。
num_shards (int, 可选) - 指定分布式训练时将数据集进行划分的分片数。默认值：None。指定此参数后， num_samples 表示每个分片的最大样本数。
shard_id (int, 可选) - 指定分布式训练时使用的分片ID号。默认值：None。只有当指定了 num_shards 时才能指定此参数。
cache (DatasetCache, 可选) - 单节点数据缓存服务，用于加快数据集处理，详情请阅读单节点数据缓存。默认值：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 - 如果 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	不允许

关于LFW数据集：

LFW（Labelled Faces in the Wild）数据集是人脸识别领域最常用和广泛的开放数据集之一，它由美国马萨诸塞理工学院的Gary B. Huang等人于2007年发布。该数据集包含13,233个人的近50,000张图像，这些图像来自互联网上不同来源的人物照片，并包含了不同的姿势、光照、角度等不同环境因素。该数据集中大部分图像都是正面正视的，而且包含多种年龄、性别和人种。

你可以将原始的LFW数据集文件解压成以下目录结构，并通过MindSpore的API进行读取。

.
└── lfw_dataset_directory
    ├── lfw
    │    ├──Aaron_Eckhart
    │    │    ├──Aaron_Eckhart_0001.jpg
    │    │    ├──...
    │    ├──Abbas_Kiarostami
    │    │    ├── Abbas_Kiarostami_0001.jpg
    │    │    ├──...
    │    ├──...
    ├── lfw-deepfunneled
    │    ├──Aaron_Eckhart
    │    │    ├──Aaron_Eckhart_0001.jpg
    │    │    ├──...
    │    ├──Abbas_Kiarostami
    │    │    ├── Abbas_Kiarostami_0001.jpg
    │    │    ├──...
    │    ├──...
    ├── lfw_funneled
    │    ├──Aaron_Eckhart
    │    │    ├──Aaron_Eckhart_0001.jpg
    │    │    ├──...
    │    ├──Abbas_Kiarostami
    │    │    ├── Abbas_Kiarostami_0001.jpg
    │    │    ├──...
    │    ├──...
    ├── lfw-names.txt
    ├── pairs.txt
    ├── pairsDevTest.txt
    ├── pairsDevTrain.txt
    ├── people.txt
    ├── peopleDevTest.txt
    ├── peopleDevTrain.txt

引用：

@TechReport{LFWTech,
    title={LFW: A Database for Studying Recognition in Unconstrained Environments},
    author={Gary B. Huang and Manu Ramesh and Tamara Berg and Erik Learned-Miller},
    institution ={University of Massachusetts, Amherst},
    year={2007}
    number={07-49},
    month={October},
    howpublished = {http://vis-www.cs.umass.edu/lfw}
}

样例：

>>> # 1) Read LFW People dataset
>>> lfw_people_dataset_dir = "/path/to/lfw_people_dataset_directory"
>>> dataset = ds.LFWDataset(dataset_dir=lfw_people_dataset_dir, task="people", usage="10fold",
...                         image_set="original")
>>>
>>> # 2) Read LFW Pairs dataset
>>> lfw_pairs_dataset_dir = "/path/to/lfw_pairs_dataset_directory"
>>> dataset = ds.LFWDataset(dataset_dir=lfw_pairs_dataset_dir, task="pairs", usage="test", image_set="funneled")

预处理操作

`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字符串，如果提供了文件名，则转储到文件中。