# Module: tff.simulation.datasets

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/federated/blob/v0.87.0 Version 2.0, January 2004 Licensed under the Apache License, Version 2.0 (the) |

Datasets for running TensorFlow Federated simulations.

## Modules

[`celeba`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/celeba) module: Libraries for the federated CelebA dataset for simulation.

[`cifar100`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/cifar100) module: Libraries for the federated CIFAR-100 dataset for simulation.

[`emnist`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/emnist) module: Libraries for the federated EMNIST dataset for simulation.

[`flair`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/flair) module: Libraries for loading the FLAIR dataset.

[`gldv2`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/gldv2) module: Libraries for the federated Google Landmark v2 dataset for simulation.

[`inaturalist`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/inaturalist) module: Libraries for the federated iNaturalist dataset for simulation.

[`shakespeare`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/shakespeare) module: Libraries for the Shakespeare dataset for federated learning simulation.

[`stackoverflow`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/stackoverflow) module: Libraries for the Stackoverflow dataset for federated learning simulation.

## Classes

[`class ClientData`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/ClientData): Object to hold a federated dataset.

[`class FilePerUserClientData`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/FilePerUserClientData): A [`tff.simulation.datasets.ClientData`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/ClientData) that maps a set of files to a dataset.

[`class SqlClientData`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/SqlClientData): A [`tff.simulation.datasets.ClientData`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/ClientData) backed by an SQL file.

[`class TestClientData`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/TestClientData): A [`tff.simulation.datasets.ClientData`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/ClientData) intended for test purposes.

[`class TransformingClientData`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/TransformingClientData): Transforms client data, potentially expanding by adding pseudo-clients.

## Functions

[`build_dataset_mixture(...)`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/build_dataset_mixture): Build a new dataset that probabilistically returns examples.

[`build_single_label_dataset(...)`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/build_single_label_dataset): Build a new dataset that only yields examples with a particular label.

[`build_synthethic_iid_datasets(...)`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/build_synthethic_iid_datasets): Constructs an iterable of IID clients from a [`tff.simulation.datasets.ClientData`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/ClientData).

[`load_and_parse_sql_client_data(...)`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/load_and_parse_sql_client_data): Load a `ClientData` arises by parsing a serialized `SqlClientData`.

[`save_to_sql_client_data(...)`](https://www.tensorflow.org/federated/api_docs/python/tff/simulation/datasets/save_to_sql_client_data): Serialize a federated dataset into a SQL database compatible with `SqlClientData`.