tfds.core.DatasetIdentity

Identity of a dataset that completely identifies a dataset.

tfds.core.DatasetIdentity(
    name: str,
    version: utils.Version,
    data_dir: str,
    module_name: str,
    config_name: (str | None) = None,
    config_description: (str | None) = None,
    config_tags: (list[str] | None) = None,
    release_notes: (dict[str, str] | None) = None
)

name Dataclass field
version Dataclass field
data_dir Dataclass field
module_name Dataclass field
config_name Dataclass field
config_description Dataclass field
config_tags Dataclass field
release_notes Dataclass field

Methods

from_builder

View source

@classmethod
from_builder(
    builder
) -> 'DatasetIdentity'

Constructs a DatasetIdentity from a given dataset builder.

from_proto

View source

@classmethod
from_proto(
    info_proto: dataset_info_pb2.DatasetInfo, data_dir: str
) -> 'DatasetIdentity'

Constructs a DatasetIdentity for a given dataset.

Args
info_proto The DatasetInfo proto for the dataset.
data_dir Path to the data_dir for the dataset.

Returns
A DatasetIdentity object for the required dataset.

__eq__

__eq__(
    other
)

Return self==value.

config_description None
config_name None
config_tags None
release_notes None