<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/datasets/blob/v4.9.10/tensorflow_datasets/__init__.py) |

`tensorflow_datasets` ([`tfds`](https://www.tensorflow.org/datasets/api_docs/python/tfds)) defines a collection of datasets ready-to-use with TensorFlow.

Each dataset is defined as a [`tfds.core.DatasetBuilder`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/DatasetBuilder), which encapsulates
the logic to download the dataset and construct an input pipeline, as well as
contains the dataset documentation (version, splits, number of examples, etc.).

The main library entrypoints are:

- [`tfds.builder`](https://www.tensorflow.org/datasets/api_docs/python/tfds/builder): fetch a [`tfds.core.DatasetBuilder`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/DatasetBuilder) by name
- [`tfds.load`](https://www.tensorflow.org/datasets/api_docs/python/tfds/load): convenience method to construct a builder, download the data, and create an input pipeline, returning a [`tf.data.Dataset`](https://www.tensorflow.org/api_docs/python/tf/data/Dataset).

#### Documentation:

- These API docs
- [Available datasets](https://www.tensorflow.org/datasets/catalog/overview)
- [Colab
  tutorial](https://colab.research.google.com/github/tensorflow/datasets/blob/master/docs/overview.ipynb)
- [Add a dataset](https://www.tensorflow.org/datasets/add_dataset)

## Modules

[`beam`](https://www.tensorflow.org/datasets/api_docs/python/tfds/beam) module: Beam utils.

[`core`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core) module: API to define datasets.

[`dataset_builders`](https://www.tensorflow.org/datasets/api_docs/python/tfds/dataset_builders) module: Dataset builders API.

[`decode`](https://www.tensorflow.org/datasets/api_docs/python/tfds/decode) module: Decoder public API.

[`deprecated`](https://www.tensorflow.org/datasets/api_docs/python/tfds/deprecated) module: Deprecated symbols.

[`download`](https://www.tensorflow.org/datasets/api_docs/python/tfds/download) module: [`tfds.download.DownloadManager`](https://www.tensorflow.org/datasets/api_docs/python/tfds/download/DownloadManager) API.

[`features`](https://www.tensorflow.org/datasets/api_docs/python/tfds/features) module: API defining dataset features (image, text, scalar,...).

[`folder_dataset`](https://www.tensorflow.org/datasets/api_docs/python/tfds/folder_dataset) module: Utils to load data comming from third party sources directly with TFDS.

[`testing`](https://www.tensorflow.org/datasets/api_docs/python/tfds/testing) module: Testing utilities.

[`transform`](https://www.tensorflow.org/datasets/api_docs/python/tfds/transform) module: Transform API.

[`typing`](https://www.tensorflow.org/datasets/api_docs/python/tfds/typing) module: TFDS typing annotations.

[`visualization`](https://www.tensorflow.org/datasets/api_docs/python/tfds/visualization) module: Visualizer utils.

## Classes

[`class GenerateMode`](https://www.tensorflow.org/datasets/api_docs/python/tfds/download/GenerateMode): `Enum` for how to treat pre-existing downloads and data.

[`class ImageFolder`](https://www.tensorflow.org/datasets/api_docs/python/tfds/folder_dataset/ImageFolder): Generic image classification dataset created from manual directory.

[`class ReadConfig`](https://www.tensorflow.org/datasets/api_docs/python/tfds/ReadConfig): Configures input reading pipeline.

[`class Split`](https://www.tensorflow.org/datasets/api_docs/python/tfds/Split): `Enum` for dataset splits.

[`class TranslateFolder`](https://www.tensorflow.org/datasets/api_docs/python/tfds/folder_dataset/TranslateFolder): Generic text translation dataset created from manual directory.

## Functions

[`as_dataframe(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe): Convert the dataset into a pandas dataframe.

[`as_numpy(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_numpy): Converts a [`tf.data.Dataset`](https://www.tensorflow.org/api_docs/python/tf/data/Dataset) to an iterable of NumPy arrays.

[`benchmark(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/benchmark): Benchmarks any iterable (e.g [`tf.data.Dataset`](https://www.tensorflow.org/api_docs/python/tf/data/Dataset)).

[`builder(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/builder): Fetches a [`tfds.core.DatasetBuilder`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/DatasetBuilder) by string name.

[`builder_cls(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/builder_cls): Fetches a [`tfds.core.DatasetBuilder`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/DatasetBuilder) class by string name.

[`builder_from_directories(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/builder_from_directories): Loads a [`tfds.core.DatasetBuilder`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/DatasetBuilder) from the given generated dataset path.

[`builder_from_directory(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/builder_from_directory): Loads a [`tfds.core.DatasetBuilder`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/DatasetBuilder) from the given generated dataset path.

[`data_source(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/data_source): Gets a data source from the named dataset.

[`dataset_collection(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/dataset_collection): Instantiates a DatasetCollectionLoader.

[`disable_progress_bar(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/disable_progress_bar): Disables Tqdm progress bar.

[`display_progress_bar(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/display_progress_bar): Controls whether Tqdm progress bar is enabled/disabled.

[`enable_progress_bar(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/enable_progress_bar): Enables Tqdm progress bar.

[`even_splits(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/even_splits): Generates a list of non-overlapping sub-splits of same size.

[`is_dataset_on_gcs(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/is_dataset_on_gcs): If the dataset is available on the GCS bucket gs://tfds-data/datasets.

[`list_builders(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/list_builders): Returns the string names of all [`tfds.core.DatasetBuilder`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/DatasetBuilder)s.

[`list_dataset_collections(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/list_dataset_collections): Returns the string names of all `tfds.core.DatasetCollectionBuilder`s.

[`load(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/load): Loads the named dataset into a [`tf.data.Dataset`](https://www.tensorflow.org/api_docs/python/tf/data/Dataset).

[`show_examples(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/visualization/show_examples): Visualize images (and labels) from an image classification dataset.

[`show_statistics(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/visualization/show_statistics): Display the datasets statistics on a Colab/Jupyter notebook.

[`split_for_jax_process(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/split_for_jax_process): Returns the subsplit of the data for the process.

<br />

<br />

<br />

| ## Other Members ||
|---|---|
| **version** | `'4.9.10'` |

<br />