<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/core/__init__.py) |

API to define datasets.

## Classes

[`class BeamBasedBuilder`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/BeamBasedBuilder): Beam based Builder.

[`class BeamMetadataDict`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/BeamMetadataDict): A [`tfds.core.Metadata`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/Metadata) object supporting Beam-generated datasets.

[`class BenchmarkResult`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/BenchmarkResult)

[`class BuilderConfig`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/BuilderConfig): Base class for `DatasetBuilder` data configuration.

[`class DatasetBuilder`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/DatasetBuilder): Abstract base class for all datasets.

[`class DatasetBuilderProvider`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/DatasetBuilderProvider): Base class for protocol classes.

[`class DatasetCollectionLoader`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/DatasetCollectionLoader): Loader class for dataset collections.

[`class DatasetIdentity`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/DatasetIdentity): Identity of a dataset that completely identifies a dataset.

[`class DatasetInfo`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/DatasetInfo): Information about a dataset.

[`class DatasetNotFoundError`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/DatasetNotFoundError): Exception raised when the dataset cannot be found.

[`class ExampleWriter`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/ExampleWriter): Writes examples to files.

[`class Experiment`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/Experiment): Experiments which can be enabled/disabled on a per version basis.

[`class FileFormat`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/FileFormat): Format of the record files.

[`class GeneratorBasedBuilder`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/GeneratorBasedBuilder): Base class for datasets with data generation based on file adapter.

[`class Metadata`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/Metadata): Abstract base class for DatasetInfo metadata container.

[`class MetadataDict`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/MetadataDict): A [`tfds.core.Metadata`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/Metadata) object that acts as a `dict`.

[`class Path`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/Path): Abstract base class for pathlib.Path-like API.

[`class Permissions`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/Permissions): Permissions for a file or directory.

[`class ReadInstruction`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/ReadInstruction): Reading instruction for a dataset.

[`class SequentialWriter`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/SequentialWriter): Class to write a TFDS dataset sequentially.

[`class ShardedFileTemplate`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/ShardedFileTemplate): Template to produce filenames for sharded datasets.

[`class SplitDict`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/SplitDict): Split info object.

[`class SplitGenerator`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/SplitGenerator): Defines the split information for the generator.

[`class SplitInfo`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/SplitInfo): Wraps `proto.SplitInfo` with an additional property.

[`class Version`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/Version): Dataset version MAJOR.MINOR.PATCH.

[`class lazy_imports`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/lazy_imports): Lazy importer for heavy dependencies.

## Functions

[`add_data_dir(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/add_data_dir): Registers a new default `data_dir` to search for datasets.

[`add_dataset_builder_provider(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/add_dataset_builder_provider): Adds a dataset builder provider to the global registry.

[`as_path(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/as_path): DEPRECATED. Please use `from etils import epath` with `epath.Path()`.

[`gcs_path(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/gcs_path): Returns the GCS URI path.

[`tfds_path(...)`](https://www.tensorflow.org/datasets/api_docs/python/tfds/core/tfds_path): Path to `tensorflow_datasets/` root dir.