#
Stream

Dataset streaming lets you work with a dataset without downloading it. The data is streamed as you iterate over the dataset. This is especially helpful when:

- You don’t want to wait for an extremely large dataset to download.
- The dataset size exceeds the amount of available disk space on your computer.
- You want to quickly explore just a few samples of a dataset.

For example, the English split of the oscar-corpus/OSCAR-2201 dataset is 1.2 terabytes, but you can use it instantly with streaming. Stream a dataset by setting `streaming=True` in load_dataset() as shown below:

    >>> from datasets import load_dataset
    >>> dataset = load_dataset('oscar-corpus/OSCAR-2201', 'en', split='train', streaming=True)
    >>> print(next(iter(dataset)))
    {'id': 0, 'text': 'Founded in 2015, Golden Bees is a leading programmatic recruitment platform dedicated to employers, HR agencies and job boards. The company has developed unique HR-custom technologies and predictive algorithms to identify and attract the best candidates for a job opportunity.', ...

Dataset streaming also lets you work with a dataset made of local files without doing any conversion. In this case, the data is streamed from the local files as you iterate over the dataset. This is especially helpful when:

- You don’t want to wait for an extremely large local dataset to be converted to Arrow.
- The converted files size would exceed the amount of available disk space on your computer.
- You want to quickly explore just a few samples of a dataset.

For example, you can stream a local dataset of hundreds of compressed JSONL files like oscar-corpus/OSCAR-2201 to use it instantly:

    >>> from datasets import load_dataset
    >>> data_files = {'train': 'path/to/OSCAR-2201/compressed/en_meta/*.jsonl.gz'}
    >>> dataset = load_dataset('json', data_files=data_files, split='train', streaming=True)
    >>> print(next(iter(dataset)))
    {'id': 0, 'text': 'Founded in 2015, Golden Bees is a leading programmatic recruitment platform dedicated to employers, HR agencies and job boards. The company has developed unique HR-custom technologies and predictive algorithms to identify and attract the best candidates for a job opportunity.', ...

Loading a dataset in streaming mode creates a new dataset type instance (instead of the classic Dataset object), known as an IterableDataset. This special type of dataset has its own set of processing methods shown below.

An IterableDataset is useful for iterative jobs like training a model. You shouldn’t use a IterableDataset for jobs that require random access to examples because you have to iterate all over it using a for loop. Getting the last example in an iterable dataset would require you to iterate over all the previous examples. You can find more details in the Dataset vs. IterableDataset guide.

##
Convert from a Dataset

If you have an existing Dataset object, you can convert it to an IterableDataset with the to_iterable_dataset() function. This is actually faster than setting the `streaming=True` argument in load_dataset() because the data is streamed from local files.

    >>> from datasets import load_dataset

    # faster 🐇
    >>> dataset = load_dataset("food101")
    >>> iterable_dataset = dataset.to_iterable_dataset()

    # slower 🐢
    >>> iterable_dataset = load_dataset("food101", streaming=True)

The to_iterable_dataset() function supports sharding when the IterableDataset is instantiated. This is useful when working with big datasets, and you’d like to shuffle the dataset or to enable fast parallel loading with a PyTorch DataLoader.

    >>> import torch
    >>> from datasets import load_dataset

    >>> dataset = load_dataset("food101")
    >>> iterable_dataset = dataset.to_iterable_dataset(num_shards=64) # shard the dataset
    >>> iterable_dataset = iterable_dataset.shuffle(buffer_size=10_000)  # shuffles the shards order and use a shuffle buffer when you start iterating
    dataloader = torch.utils.data.DataLoader(iterable_dataset, num_workers=4)  # assigns 64 / 4 = 16 shards from the shuffled list of shards to each worker when you start iterating

##
Shuffle

Like a regular Dataset object, you can also shuffle a IterableDataset with IterableDataset.shuffle().

The `buffer_size` argument controls the size of the buffer to randomly sample examples from. Let’s say your dataset has one million examples, and you set the `buffer_size` to ten thousand. IterableDataset.shuffle() will randomly select examples from the first ten thousand examples in the buffer. Selected examples in the buffer are replaced with new examples. By default, the buffer size is 1,000.

    >>> from datasets import load_dataset
    >>> dataset = load_dataset('oscar', "unshuffled_deduplicated_en", split='train', streaming=True)
    >>> shuffled_dataset = dataset.shuffle(seed=42, buffer_size=10_000)

IterableDataset.shuffle() will also shuffle the order of the shards if the dataset is sharded into multiple files.

##
Reshuffle

Sometimes you may want to reshuffle the dataset after each epoch. This will require you to set a different seed for each epoch. Use `IterableDataset.set_epoch()` in between epochs to tell the dataset what epoch you’re on.

Your seed effectively becomes: `initial seed + current epoch`.

    >>> for epoch in range(epochs):
    ...     shuffled_dataset.set_epoch(epoch)
    ...     for example in shuffled_dataset:
    ...         ...

##
Split dataset

You can split your dataset one of two ways:

- IterableDataset.take() returns the first `n` examples in a dataset:

    >>> dataset = load_dataset('oscar', "unshuffled_deduplicated_en", split='train', streaming=True)
    >>> dataset_head = dataset.take(2)
    >>> list(dataset_head)
    [{'id': 0, 'text': 'Mtendere Village was...'}, {'id': 1, 'text': 'Lily James cannot fight the music...'}]

- IterableDataset.skip() omits the first `n` examples in a dataset and returns the remaining examples:

    >>> train_dataset = shuffled_dataset.skip(1000)

`take` and `skip` prevent future calls to `shuffle` because they lock in the order of the shards. You should `shuffle` your dataset before splitting it.

##
Interleave

interleave_datasets() can combine an IterableDataset with other datasets. The combined dataset returns alternating examples from each of the original datasets.

    >>> from datasets import interleave_datasets
    >>> en_dataset = load_dataset('oscar', "unshuffled_deduplicated_en", split='train', streaming=True, trust_remote_code=True)
    >>> fr_dataset = load_dataset('oscar', "unshuffled_deduplicated_fr", split='train', streaming=True, trust_remote_code=True)

    >>> multilingual_dataset = interleave_datasets([en_dataset, fr_dataset])
    >>> list(multilingual_dataset.take(2))
    [{'text': 'Mtendere Village was inspired by the vision...'}, {'text': "Média de débat d'idées, de culture et de littérature..."}]

Define sampling probabilities from each of the original datasets for more control over how each of them are sampled and combined. Set the `probabilities` argument with your desired sampling probabilities:

    >>> multilingual_dataset_with_oversampling = interleave_datasets([en_dataset, fr_dataset], probabilities=[0.8, 0.2], seed=42)
    >>> list(multilingual_dataset_with_oversampling.take(2))
    [{'text': 'Mtendere Village was inspired by the vision...'}, {'text': 'Lily James cannot fight the music...'}]

Around 80% of the final dataset is made of the `en_dataset`, and 20% of the `fr_dataset`.

You can also specify the `stopping_strategy`. The default strategy, `first_exhausted`, is a subsampling strategy, i.e the dataset construction is stopped as soon one of the dataset runs out of samples. You can specify `stopping_strategy=all_exhausted` to execute an oversampling strategy. In this case, the dataset construction is stopped as soon as every samples in every dataset has been added at least once. In practice, it means that if a dataset is exhausted, it will return to the beginning of this dataset until the stop criterion has been reached. Note that if no sampling probabilities are specified, the new dataset will have `max_length_datasets*nb_dataset samples`.

##
Rename, remove, and cast

The following methods allow you to modify the columns of a dataset. These methods are useful for renaming or removing columns and changing columns to a new set of features.

###
Rename

Use IterableDataset.rename_column() when you need to rename a column in your dataset. Features associated with the original column are actually moved under the new column name, instead of just replacing the original column in-place.

Provide IterableDataset.rename_column() with the name of the original column, and the new column name:

    >>> from datasets import load_dataset
    >>> dataset = load_dataset('mc4', 'en', streaming=True, split='train', trust_remote_code=True)
    >>> dataset = dataset.rename_column("text", "content")

###
Remove

When you need to remove one or more columns, give IterableDataset.remove_columns() the name of the column to remove. Remove more than one column by providing a list of column names:

    >>> from datasets import load_dataset
    >>> dataset = load_dataset('mc4', 'en', streaming=True, split='train', trust_remote_code=True)
    >>> dataset = dataset.remove_columns('timestamp')

###
Cast

IterableDataset.cast() changes the feature type of one or more columns. This method takes your new `Features` as its argument. The following sample code shows how to change the feature types of `ClassLabel` and `Value`:

    >>> from datasets import load_dataset
    >>> dataset = load_dataset('glue', 'mrpc', split='train', streaming=True)
    >>> dataset.features
    {'sentence1': Value(dtype='string', id=None),
    'sentence2': Value(dtype='string', id=None),
    'label': ClassLabel(num_classes=2, names=['not_equivalent', 'equivalent'], names_file=None, id=None),
    'idx': Value(dtype='int32', id=None)}

    >>> from datasets import ClassLabel, Value
    >>> new_features = dataset.features.copy()
    >>> new_features["label"] = ClassLabel(names=['negative', 'positive'])
    >>> new_features["idx"] = Value('int64')
    >>> dataset = dataset.cast(new_features)
    >>> dataset.features
    {'sentence1': Value(dtype='string', id=None),
    'sentence2': Value(dtype='string', id=None),
    'label': ClassLabel(num_classes=2, names=['negative', 'positive'], names_file=None, id=None),
    'idx': Value(dtype='int64', id=None)}

Casting only works if the original feature type and new feature type are compatible. For example, you can cast a column with the feature type `Value('int32')` to `Value('bool')` if the original column only contains ones and zeros.

Use IterableDataset.cast_column() to change the feature type of just one column. Pass the column name and its new feature type as arguments:

    >>> dataset.features
    {'audio': Audio(sampling_rate=44100, mono=True, id=None)}

    >>> dataset = dataset.cast_column("audio", Audio(sampling_rate=16000))
    >>> dataset.features
    {'audio': Audio(sampling_rate=16000, mono=True, id=None)}

##
Map

Similar to the Dataset.map() function for a regular Dataset, 🤗 Datasets features IterableDataset.map() for processing an IterableDataset. IterableDataset.map() applies processing on-the-fly when examples are streamed.

It allows you to apply a processing function to each example in a dataset, independently or in batches. This function can even create new rows and columns.

The following example demonstrates how to tokenize a IterableDataset. The function needs to accept and output a `dict`:

    >>> def add_prefix(example):
    ...     example['text'] = 'My text: ' + example['text']
    ...     return example

Next, apply this function to the dataset with IterableDataset.map():

    >>> from datasets import load_dataset
    >>> dataset = load_dataset('oscar', 'unshuffled_deduplicated_en', streaming=True, split='train', trust_remote_code=True)
    >>> updated_dataset = dataset.map(add_prefix)
    >>> list(updated_dataset.take(3))
    [{'id': 0, 'text': 'My text: Mtendere Village was inspired by...'},
     {'id': 1, 'text': 'My text: Lily James cannot fight the music...'},
     {'id': 2, 'text': 'My text: "I\'d love to help kickstart...'}]

Let’s take a look at another example, except this time, you will remove a column with IterableDataset.map(). When you remove a column, it is only removed after the example has been provided to the mapped function. This allows the mapped function to use the content of the columns before they are removed.

Specify the column to remove with the `remove_columns` argument in IterableDataset.map():

    >>> updated_dataset = dataset.map(add_prefix, remove_columns=["id"])
    >>> list(updated_dataset.take(3))
    [{'text': 'My text: Mtendere Village was inspired by...'},
     {'text': 'My text: Lily James cannot fight the music...'},
     {'text': 'My text: "I\'d love to help kickstart...'}]

###
Batch processing

IterableDataset.map() also supports working with batches of examples. Operate on batches by setting `batched=True`. The default batch size is 1000, but you can adjust it with the `batch_size` argument. This opens the door to many interesting applications such as tokenization, splitting long sentences into shorter chunks, and data augmentation.

####
Tokenization

    >>> from datasets import load_dataset
    >>> from transformers import AutoTokenizer
    >>> dataset = load_dataset("mc4", "en", streaming=True, split="train", trust_remote_code=True)
    >>> tokenizer = AutoTokenizer.from_pretrained('distilbert-base-uncased')
    >>> def encode(examples):
    ...     return tokenizer(examples['text'], truncation=True, padding='max_length')
    >>> dataset = dataset.map(encode, batched=True, remove_columns=["text", "timestamp", "url"])
    >>> next(iter(dataset))
    {'input_ids': [101, 8466, 1018, 1010, 4029, 2475, 2062, 18558, 3100, 2061, ...,1106, 3739, 102],
    'attention_mask': [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, ..., 1, 1]}

See other examples of batch processing in the batched map processing documentation. They work the same for iterable datasets.

###
Filter

You can filter rows in the dataset based on a predicate function using Dataset.filter(). It returns rows that match a specified condition:

    >>> from datasets import load_dataset
    >>> dataset = load_dataset('oscar', 'unshuffled_deduplicated_en', streaming=True, split='train', trust_remote_code=True)
    >>> start_with_ar = dataset.filter(lambda example: example['text'].startswith('Ar'))
    >>> next(iter(start_with_ar))
    {'id': 4, 'text': 'Are you looking for Number the Stars (Essential Modern Classics)?...'}

Dataset.filter() can also filter by indices if you set `with_indices=True`:

    >>> even_dataset = dataset.filter(lambda example, idx: idx % 2 == 0, with_indices=True)
    >>> list(even_dataset.take(3))
    [{'id': 0, 'text': 'Mtendere Village was inspired by the vision of Chief Napoleon Dzombe, ...'},
     {'id': 2, 'text': '"I\'d love to help kickstart continued development! And 0 EUR/month...'},
     {'id': 4, 'text': 'Are you looking for Number the Stars (Essential Modern Classics)? Normally, ...'}]

##
Stream in a training loop

IterableDataset can be integrated into a training loop. First, shuffle the dataset:

Pytorch
Hide Pytorch content

    >>> seed, buffer_size = 42, 10_000
    >>> dataset = dataset.shuffle(seed, buffer_size=buffer_size)

Lastly, create a simple training loop and start training:

    >>> import torch
    >>> from torch.utils.data import DataLoader
    >>> from transformers import AutoModelForMaskedLM, DataCollatorForLanguageModeling
    >>> from tqdm import tqdm
    >>> dataset = dataset.with_format("torch")
    >>> dataloader = DataLoader(dataset, collate_fn=DataCollatorForLanguageModeling(tokenizer))
    >>> device = 'cuda' if torch.cuda.is_available() else 'cpu'
    >>> model = AutoModelForMaskedLM.from_pretrained("distilbert-base-uncased")
    >>> model.train().to(device)
    >>> optimizer = torch.optim.AdamW(params=model.parameters(), lr=1e-5)
    >>> for epoch in range(3):
    ...     dataset.set_epoch(epoch)
    ...     for i, batch in enumerate(tqdm(dataloader, total=5)):
    ...         if i == 5:
    ...             break
    ...         batch = {k: v.to(device) for k, v in batch.items()}
    ...         outputs = model(**batch)
    ...         loss = outputs[0]
    ...         loss.backward()
    ...         optimizer.step()
    ...         optimizer.zero_grad()
    ...         if i % 10 == 0:
    ...             print(f"loss: {loss}")

###
Save a dataset checkpoint and resume iteration

If your training loop stops, you may want to restart the training from where it was. To do so you can save a checkpoint of your model and optimizers, as well as your data loader.

Iterable datasets don’t provide random access to a specific example index to resume from, but you can use IterableDataset.state_dict() and IterableDataset.load_state_dict() to resume from a checkpoint instead, similarly to what you can do for models and optimizers:

    >>> iterable_dataset = Dataset.from_dict({"a": range(6)}).to_iterable_dataset(num_shards=3)
    >>> for idx, example in enumerate(iterable_dataset):
    ...     print(example)
    ...     if idx == 2:
    ...         state_dict = iterable_dataset.state_dict()
    ...         print("checkpoint")
    ...         break
    >>> iterable_dataset.load_state_dict(state_dict)
    >>> print(f"restart from checkpoint")
    >>> for example in iterable_dataset:
    ...     print(example)

Returns:

    {'a': 0}
    {'a': 1}
    {'a': 2}
    checkpoint
    restart from checkpoint
    {'a': 3}
    {'a': 4}
    {'a': 5}

Under the hood, the iterable dataset keeps track of the current shard being read and the example index in the current shard and it stores this info in the `state_dict`.

To resume from a checkpoint, the dataset skips all the shards that were previously read to restart from the current shard. Then it reads the shard and skips examples until it reaches the exact example from the checkpoint.

Therefore restarting a dataset is quite fast, since it will not re-read the shards that have already been iterated on. Still, resuming a dataset is generally not instantaneous since it has to restart reading from the beginning of the current shard and skip examples until it reaches the checkpoint location.

This can be used with the `StatefulDataLoader` from `torchdata`:

    >>> from torchdata.stateful_dataloader import StatefulDataLoader
    >>> iterable_dataset = load_dataset("deepmind/code_contests", streaming=True, split="train")
    >>> dataloader = StatefulDataLoader(iterable_dataset, batch_size=32, num_workers=4)
    >>> # checkpoint
    >>> state_dict = dataloader.state_dict()  # uses iterable_dataset.state_dict() under the hood
    >>> # resume from checkpoint
    >>> dataloader.load_state_dict(state_dict)  # uses iterable_dataset.load_state_dict() under the hood

Resuming returns exactly where the checkpoint was saved except in two cases: 1) examples from shuffle buffers are lost when resuming and the buffers are refilled with new data and 2) combinations of `.with_format(arrow)` and batched `.map()` may skip one batch.

< > Update on GitHub