tfds.core.Metadata

Stay organized with collections Save and categorize content based on your preferences.

Abstract base class for DatasetInfo metadata container.

tfds.core.Metadata(
    *args, **kwargs
)

builder.info.metadata allows the dataset to expose additional general information about the dataset which are not specific to a feature or individual example.

To implement the interface, overwrite save_metadata and load_metadata.

See tfds.core.MetadataDict for a simple implementation that acts as a dict that saves data to/from a JSON file.

Methods

clear

clear()

D.clear() -> None. Remove all items from D.

copy

copy()

D.copy() -> a shallow copy of D

fromkeys

fromkeys(
    value, /
)

Create a new dictionary with keys from iterable and values set to value.

get

get(
    key, default, /
)

Return the value for key if key is in the dictionary, else default.

items

items()

D.items() -> a set-like object providing a view on D's items

keys

keys()

D.keys() -> a set-like object providing a view on D's keys

load_metadata

View source

@abc.abstractmethod
load_metadata(
    data_dir
)

Restore the metadata.

pop

pop()

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If key is not found, default is returned if given, otherwise KeyError is raised

popitem

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

save_metadata

View source

@abc.abstractmethod
save_metadata(
    data_dir
)

Save the metadata.

setdefault

setdefault(
    key, default, /
)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update

update()

D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values

values()

D.values() -> an object providing a view on D's values

__contains__

__contains__(
    key, /
)

True if the dictionary has the specified key, else False.

__eq__

__eq__(
    value, /
)

Return self==value.

__ge__

__ge__(
    value, /
)

Return self>=value.

__getitem__

__getitem__()

x.getitem(y) <==> x[y]

__gt__

__gt__(
    value, /
)

Return self>value.

__iter__

__iter__()

Implement iter(self).

__le__

__le__(
    value, /
)

Return self<=value.

__len__

__len__()

Return len(self).

__lt__

__lt__(
    value, /
)

Return self<value.

__ne__

__ne__(
    value, /
)

Return self!=value.

__or__

__or__(
    value, /
)

Return self|value.

__ror__

__ror__(
    value, /
)

Return value|self.