mindspore.dataset.IMDBDataset

class mindspore.dataset.IMDBDataset(dataset_dir, usage=None, num_samples=None, num_parallel_workers=None, shuffle=None, sampler=None, num_shards=None, shard_id=None, cache=None)

A source dataset that reads and parses Internet Movie Database (IMDb).

The generated dataset has two columns: [text, label] . The tensor of column text is of the string type. The column label is of a scalar of uint32 type.

Parameters

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

• usage (str, optional) – Usage of this dataset, can be ‘train’, ‘test’ or ‘all’. Default: None, will read all samples.

• num_samples (int, optional) – The number of images to be included in the dataset. For Polarity dataset, ‘train’ will read from 3,600,000 train samples, ‘test’ will read from 400,000 test samples, ‘all’ will read from all 4,000,000 samples. For Full dataset, ‘train’ will read from 3,000,000 train samples, ‘test’ will read from 650,000 test samples, ‘all’ will read from all 3,650,000 samples. Default: None, will include all samples.

• num_parallel_workers (int, optional) – Number of workers to read the data. Default: None, number set in the mindspore.dataset.config.

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

• 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 maximum 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 num_shards/shard_id 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 num_parallel_workers exceeds the max thread numbers.

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

Note

• The shape of the test column.

• This dataset can take in a sampler . sampler and shuffle are mutually exclusive. The table below shows what input arguments are allowed and their expected behavior.

Expected Order Behavior of Using sampler and shuffle

Parameter sampler	Parameter shuffle	Expected Order Behavior
None	None	random order
None	True	random order
None	False	sequential order
Sampler object	None	order defined by sampler
Sampler object	True	not allowed
Sampler object	False	not allowed

Examples

>>> imdb_dataset_dir = "/path/to/imdb_dataset_directory"
>>>
>>> # 1) Read all samples (text files) in imdb_dataset_dir with 8 threads
>>> dataset = ds.IMDBDataset(dataset_dir=imdb_dataset_dir, num_parallel_workers=8)
>>>
>>> # 2) Read train samples (text files).
>>> dataset = ds.IMDBDataset(dataset_dir=imdb_dataset_dir, usage="train")

About IMDBDataset:

The IMDB dataset contains 50, 000 highly polarized reviews from the Internet Movie Database (IMDB). The dataset was divided into 25 000 comments for training and 25 000 comments for testing, with both the training set and test set containing 50% positive and 50% negative comments. Train labels and test labels are all lists of 0 and 1, where 0 stands for negative and 1 for positive.

You can unzip the dataset files into this directory structure and read by MindSpore’s API.

.
└── imdb_dataset_directory
     ├── train
     │    ├── pos
     │    │    ├── 0_9.txt
     │    │    ├── 1_7.txt
     │    │    ├── ...
     │    ├── neg
     │    │    ├── 0_3.txt
     │    │    ├── 1_1.txt
     │    │    ├── ...
     ├── test
     │    ├── pos
     │    │    ├── 0_10.txt
     │    │    ├── 1_10.txt
     │    │    ├── ...
     │    ├── neg
     │    │    ├── 0_2.txt
     │    │    ├── 1_3.txt
     │    │    ├── ...

Citation:

@InProceedings{maas-EtAl:2011:ACL-HLT2011,
  author    = {Maas, Andrew L.  and  Daly, Raymond E.  and  Pham, Peter T.  and  Huang, Dan
                and  Ng, Andrew Y.  and  Potts, Christopher},
  title     = {Learning Word Vectors for Sentiment Analysis},
  booktitle = {Proceedings of the 49th Annual Meeting of the Association for Computational Linguistics:
                Human Language Technologies},
  month     = {June},
  year      = {2011},
  address   = {Portland, Oregon, USA},
  publisher = {Association for Computational Linguistics},
  pages     = {142--150},
  url       = {http://www.aclweb.org/anthology/P11-1015}
}

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	Takes at most given numbers of elements from the dataset.
mindspore.dataset.Dataset.zip	Zip the datasets in the sense of input tuple of datasets.
mindspore.dataset.TextBaseDataset.build_sentencepiece_vocab	Function to create a SentencePieceVocab from source dataset.
mindspore.dataset.TextBaseDataset.build_vocab	Function to create a Vocab from source dataset.

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.
mindspore.dataset.Dataset.create_tuple_iterator	Create an iterator over the dataset.

Attribute

mindspore.dataset.Dataset.get_batch_size	Return the size of batch.
mindspore.dataset.Dataset.get_class_indexing	Return the class index.
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.device_que	Return a transferred Dataset that transfers data through a device.
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.