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) dataset.

When task is 'people', the generated dataset has two columns: [image, label]; When task is 'pairs', the generated dataset has three columns: [image1, image2, label] . The tensor of column image is of the uint8 type. The tensor of column image1 is of the uint8 type. The tensor of column image2 is of the uint8 type. The tensor of column label is a scalar of the uint32 type.

Parameters

• dataset_dir (str) – Path to the root directory that contains the dataset.

• task (str, optional) – Set the task type of reading lfw data, support 'people' and 'pairs'. Default: None , means 'people'.

• usage (str, optional) – The image split to use, support '10fold', 'train', 'test' and 'all'. Default: None , will read samples including 'train' and 'test'.

• image_set (str, optional) – Type of image funneling to use, support 'original', 'funneled' or 'deepfunneled'. Default: None , will use 'funneled'.

• num_samples (int, optional) – The number of images to be included in the dataset. Default: None , all images.

• num_parallel_workers (int, optional) – Number of worker threads to read the data. Default: None , will use global default workers(8), it can be set by mindspore.dataset.config.set_num_parallel_workers() .

• shuffle (bool, optional) – Whether or not to perform shuffle on the dataset. Default: None , expected order behavior shown in the table below.

• decode (bool, optional) – Decode the images after reading. Default: False.

• sampler (Sampler, optional) – Object used to choose samples from the dataset. Default: None , expected order behavior shown in the table below.

• num_shards (int, optional) – Number of shards that the dataset will be divided into. Default: None . When this argument is specified, num_samples reflects the max sample number of per shard.

• shard_id (int, optional) – The shard ID within num_shards. Default: None . This argument can only be specified when num_shards is also specified.

• cache (DatasetCache, optional) – Use tensor caching service to speed up dataset processing. More details: Single-Node Data Cache . Default: None , which means no cache is used.

Raises

• RuntimeError – If dataset_dir does not contain data files.

• RuntimeError – If sampler and shuffle are specified at the same time.

• RuntimeError – If sampler and sharding are specified at the same time.

• RuntimeError – If num_shards is specified but shard_id is None.

• RuntimeError – If shard_id is specified but num_shards is None.

• ValueError – If shard_id is invalid (< 0 or >= num_shards ).

Tutorial Examples:

• Load & Process Data With Dataset Pipeline

Note

• The parameters num_samples , shuffle , num_shards , shard_id can be used to control the sampler used in the dataset, and their effects when combined with parameter sampler are as follows.

Sampler obtained by different combinations of parameters sampler and num_samples , shuffle , num_shards , shard_id

Parameter sampler	Parameter num_shards / shard_id	Parameter shuffle	Parameter num_samples	Sampler Used
mindspore.dataset.Sampler type	None	None	None	sampler
numpy.ndarray,list,tuple,int type	/	/	num_samples	SubsetSampler(indices = sampler , num_samples = num_samples )
iterable type	/	/	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 )

Examples

>>> import mindspore.dataset as ds
>>> # 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")

About LFW dataset:

LFW (Labelled Faces in the Wild) dataset is one of the most commonly used and widely open datasets in the field of face recognition. It was released by Gary B. Huang and his team at Massachusetts Institute of Technology in 2007. The dataset includes nearly 50,000 images of 13,233 individuals, which are sourced from various internet platforms and contain diverse environmental factors such as different poses, lighting conditions, and angles. Most of the images in the dataset are frontal and cover a wide range of ages, genders, and ethnicities.

You can unzip the original LFW dataset files into this directory structure and read by MindSpore's 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

Citation:

@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}
}

Pre-processing Operation

mindspore.dataset.Dataset.apply	Apply a function in this dataset.
mindspore.dataset.Dataset.concat	Concatenate the dataset objects in the input list.
mindspore.dataset.Dataset.filter	Filter dataset by prediction.
mindspore.dataset.Dataset.flat_map	Map func to each row in dataset and flatten the result.
mindspore.dataset.Dataset.map	Apply each operation in operations to this dataset.
mindspore.dataset.Dataset.project	The specified columns will be selected from the dataset and passed into the pipeline with the order specified.
mindspore.dataset.Dataset.rename	Rename the columns in input datasets.
mindspore.dataset.Dataset.repeat	Repeat this dataset count times.
mindspore.dataset.Dataset.reset	Reset the dataset for next epoch.
mindspore.dataset.Dataset.save	Save the dynamic data processed by the dataset pipeline in common dataset format.
mindspore.dataset.Dataset.shuffle	Shuffle the dataset by creating a cache with the size of buffer_size .
mindspore.dataset.Dataset.skip	Skip the first N elements of this dataset.
mindspore.dataset.Dataset.split	Split the dataset into smaller, non-overlapping datasets.
mindspore.dataset.Dataset.take	Take the first specified number of samples from the dataset.
mindspore.dataset.Dataset.zip	Zip the datasets in the sense of input tuple of datasets.

Batch

mindspore.dataset.Dataset.batch	Combine batch_size number of consecutive rows into batch which apply per_batch_map to the samples first.
mindspore.dataset.Dataset.bucket_batch_by_length	Bucket elements according to their lengths.
mindspore.dataset.Dataset.padded_batch	Combine batch_size number of consecutive rows into batch which apply pad_info to the samples first.

Iterator

mindspore.dataset.Dataset.create_dict_iterator	Create an iterator over the dataset that yields samples of type dict, while the key is the column name and the value is the data.
mindspore.dataset.Dataset.create_tuple_iterator	Create an iterator over the dataset that yields samples of type list, whose elements are the data for each column.

Attribute

mindspore.dataset.Dataset.get_batch_size	Return the size of batch.
mindspore.dataset.Dataset.get_class_indexing	Get the mapping dictionary from category names to category indexes.
mindspore.dataset.Dataset.get_col_names	Return the names of the columns in dataset.
mindspore.dataset.Dataset.get_dataset_size	Return the number of batches in an epoch.
mindspore.dataset.Dataset.get_repeat_count	Get the replication times in RepeatDataset.
mindspore.dataset.Dataset.input_indexs	Get the column index, which represents the corresponding relationship between the data column order and the network when using the sink mode.
mindspore.dataset.Dataset.num_classes	Get the number of classes in a dataset.
mindspore.dataset.Dataset.output_shapes	Get the shapes of output data.
mindspore.dataset.Dataset.output_types	Get the types of output data.

Apply Sampler

mindspore.dataset.MappableDataset.add_sampler	Add a child sampler for the current dataset.
mindspore.dataset.MappableDataset.use_sampler	Replace the last child sampler of the current dataset, remaining the parent sampler unchanged.

Others

mindspore.dataset.Dataset.sync_update	Release a blocking condition and trigger callback with given data.
mindspore.dataset.Dataset.sync_wait	Add a blocking condition to the input Dataset and a synchronize action will be applied.
mindspore.dataset.Dataset.to_json	Serialize a pipeline into JSON string and dump into file if filename is provided.