TarFileRemoteDataset

class TarFileRemoteDataset(url: str, relative_training_path: str | PurePath, relative_testing_path: str | PurePath, relative_validation_path: str | PurePath, cache_root: str | None = None, eager: bool = False, create_inverse_triples: bool = False, timeout=None)[source]

Bases: RemoteDataset

A remote dataset stored as a tar file.

Initialize dataset.

Parameters:

  • url (str) – The url where to download the dataset from.

  • relative_training_path (str | pathlib.PurePath) – The path inside the cache root where the training path gets extracted

  • relative_testing_path (str | pathlib.PurePath) – The path inside the cache root where the testing path gets extracted

  • relative_validation_path (str | pathlib.PurePath) – The path inside the cache root where the validation path gets extracted

  • cache_root (Path) – An optional directory to store the extracted files. Is none is given, the default PyKEEN directory is used. This is defined either by the environment variable PYKEEN_HOME or defaults to ~/.data/pykeen.

  • eager (bool) – Should the data be loaded eagerly? Defaults to false.

  • create_inverse_triples (bool) – Should inverse triples be created? Defaults to false.

  • timeout – The timeout number of seconds for waiting to download the dataset. Defaults to 60.