PackedRemoteDataSet

class PackedRemoteDataSet(url: str, relative_training_path: str | PurePath, relative_testing_path: str | PurePath, relative_validation_path: str | PurePath, *, force: bool = False, cache_root: str | Path | None = None, **kwargs: Unpack[PathDatasetKwargs])[source]

Bases: SourceDataSet

An abstract base class for packed remote datasets.

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

  • force (bool) – whether files should be re-downloaded

  • cache_root (str | pathlib.Path | None) – 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 ~/.pykeen.

  • kwargs (Unpack[PathDatasetKwargs])