SingleTabbedDataset

class SingleTabbedDataset(url: str, name: str | None = None, cache_root: str | None = None, eager: bool = False, create_inverse_triples: bool = False, random_state: None | int | Generator = None, download_kwargs: dict[str, Any] | None = None, read_csv_kwargs: dict[str, Any] | None = None)[source]

This class is for when you’ve got a single TSV of edges and want them to get auto-split.

Initialize dataset.

Parameters:

url (str) – 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.
random_state (TorchRandomHint) – An optional random state to make the training/testing/validation split reproducible.
download_kwargs (dict[str, Any] | None) – Keyword arguments to pass through to pystow.utils.download().
read_csv_kwargs (dict[str, Any] | None) – Keyword arguments to pass through to pandas.read_csv().

Raises:

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

Attributes Summary

Attributes Documentation