PackedZipRemoteDataset

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

Bases: LazyDataset

Contains a lazy reference to a remote dataset that is loaded if needed.

Initialize dataset.

Parameters:

  • relative_training_path (str | pathlib.PurePath) – The path inside the zip file for the training data

  • relative_testing_path (str | pathlib.PurePath) – The path inside the zip file for the testing data

  • relative_validation_path (str | pathlib.PurePath) – The path inside the zip file for the validation data

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

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

  • 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 ~/.pykeen.

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

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

Raises:

ValueError – if there’s no URL specified and there is no data already at the calculated path

Attributes Summary

head_column

header

relation_column

sep

tail_column

Attributes Documentation

head_column: int = 0
header = None
relation_column: int = 1
sep = '\t'
tail_column: int = 2