CompressedSingleDataset

class CompressedSingleDataset(url: str, relative_path: str | PurePosixPath, *, name: str | None = None, cache_root: str | Path | None = None, download_kwargs: DownloadKwargs | None = None, force: bool = False, **kwargs: Unpack[TabbedDatasetKwargs])[source]

Bases: TabbedDataset

Loads a dataset that’s a single file inside an archive.

Initialize dataset.

Parameters:

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

  • relative_path (str | pathlib.PurePosixPath) – The path inside the archive to the contained dataset.

  • name (str | None) – The name of the file. If not given, tries to get the name from the end of the URL

  • 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.

  • download_kwargs (DownloadKwargs | None) – Keyword arguments to pass through to pystow.utils.download().

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

  • kwargs (Unpack[TabbedDatasetKwargs])