tfds.deprecated.add_checksums_dir

Registers a new checksums dir.

View aliases

Main aliases

tfds.download.add_checksums_dir

tfds.deprecated.add_checksums_dir(
    checksums_dir: str
) -> None

This function allow external datasets not present in the tfds repository to define their own checksums_dir containing the dataset downloads checksums.

Note: When redistributing your dataset, you should distribute the checksums files with it and set add_checksums_dir when the user is importing your my_dataset.py.

# Set-up the folder containing the 'my_dataset.txt' checksums.
checksum_dir = os.path.join(os.path.dirname(__file__), 'checksums/')
checksum_dir = os.path.normpath(checksum_dir)

# Add the checksum dir (will be executed when the user import your dataset)
tfds.download.add_checksums_dir(checksum_dir)

class MyDataset(tfds.core.DatasetBuilder):
  ...

Args
checksums_dir	str, checksums dir to add to the registry