cogdl.datasets.kg_data

Module Contents

Classes

BidirectionalOneShotIterator
TestDataset
TrainDataset
KnowledgeGraphDataset	Dataset base class for creating graph datasets.
FB13Datset	Dataset base class for creating graph datasets.
FB15kDatset	Dataset base class for creating graph datasets.
FB15k237Datset	Dataset base class for creating graph datasets.
WN18Datset	Dataset base class for creating graph datasets.
WN18RRDataset	Dataset base class for creating graph datasets.
FB13SDatset	Dataset base class for creating graph datasets.

Functions

read_triplet_data(folder)

class cogdl.datasets.kg_data.BidirectionalOneShotIterator(dataloader_head, dataloader_tail)

Bases: object

__next__(self)

static one_shot_iterator(dataloader)

Transform a PyTorch Dataloader into python iterator

class cogdl.datasets.kg_data.TestDataset(triples, all_true_triples, nentity, nrelation, mode)

Bases: torch.utils.data.Dataset

__len__(self)

__getitem__(self, idx)

static collate_fn(data)

class cogdl.datasets.kg_data.TrainDataset(triples, nentity, nrelation, negative_sample_size, mode)

Bases: torch.utils.data.Dataset

__len__(self)

__getitem__(self, idx)

static collate_fn(data)

static count_frequency(triples, start=4)

Get frequency of a partial triple like (head, relation) or (relation, tail) The frequency will be used for subsampling like word2vec

static get_true_head_and_tail(triples)

Build a dictionary of true triples that will be used to filter these true triples for negative sampling

cogdl.datasets.kg_data.read_triplet_data(folder)

class cogdl.datasets.kg_data.KnowledgeGraphDataset(root, name)

Bases: cogdl.data.Dataset

Dataset base class for creating graph datasets. See here for the accompanying tutorial.

Args:

root (string): Root directory where the dataset should be saved. transform (callable, optional): A function/transform that takes in an

cogdl.data.Data object and returns a transformed version. The data object will be transformed before every access. (default: None)

pre_transform (callable, optional): A function/transform that takes in

an cogdl.data.Data object and returns a transformed version. The data object will be transformed before being saved to disk. (default: None)

pre_filter (callable, optional): A function that takes in an

cogdl.data.Data object and returns a boolean value, indicating whether the data object should be included in the final dataset. (default: None)

url = https://raw.githubusercontent.com/thunlp/OpenKE/OpenKE-PyTorch/benchmarks

property raw_file_names(self)

The name of the files to find in the self.raw_dir folder in order to skip the download.

property processed_file_names(self)

The name of the files to find in the self.processed_dir folder in order to skip the processing.

property train_start_idx(self)

property valid_start_idx(self)

property test_start_idx(self)

property num_entities(self)

property num_relations(self)

get(self, idx)

Gets the data object at index idx.

download(self)

Downloads the dataset to the self.raw_dir folder.

process(self)

Processes the dataset to the self.processed_dir folder.

class cogdl.datasets.kg_data.FB13Datset

Bases: cogdl.datasets.kg_data.KnowledgeGraphDataset

Dataset base class for creating graph datasets. See here for the accompanying tutorial.

Args:

root (string): Root directory where the dataset should be saved. transform (callable, optional): A function/transform that takes in an

cogdl.data.Data object and returns a transformed version. The data object will be transformed before every access. (default: None)

pre_transform (callable, optional): A function/transform that takes in

an cogdl.data.Data object and returns a transformed version. The data object will be transformed before being saved to disk. (default: None)

pre_filter (callable, optional): A function that takes in an

cogdl.data.Data object and returns a boolean value, indicating whether the data object should be included in the final dataset. (default: None)

class cogdl.datasets.kg_data.FB15kDatset

Bases: cogdl.datasets.kg_data.KnowledgeGraphDataset

Dataset base class for creating graph datasets. See here for the accompanying tutorial.

Args:

root (string): Root directory where the dataset should be saved. transform (callable, optional): A function/transform that takes in an

cogdl.data.Data object and returns a transformed version. The data object will be transformed before every access. (default: None)

pre_transform (callable, optional): A function/transform that takes in

an cogdl.data.Data object and returns a transformed version. The data object will be transformed before being saved to disk. (default: None)

pre_filter (callable, optional): A function that takes in an

cogdl.data.Data object and returns a boolean value, indicating whether the data object should be included in the final dataset. (default: None)

class cogdl.datasets.kg_data.FB15k237Datset

Bases: cogdl.datasets.kg_data.KnowledgeGraphDataset

Dataset base class for creating graph datasets. See here for the accompanying tutorial.

Args:

root (string): Root directory where the dataset should be saved. transform (callable, optional): A function/transform that takes in an

cogdl.data.Data object and returns a transformed version. The data object will be transformed before every access. (default: None)

pre_transform (callable, optional): A function/transform that takes in

an cogdl.data.Data object and returns a transformed version. The data object will be transformed before being saved to disk. (default: None)

pre_filter (callable, optional): A function that takes in an

cogdl.data.Data object and returns a boolean value, indicating whether the data object should be included in the final dataset. (default: None)

class cogdl.datasets.kg_data.WN18Datset

Bases: cogdl.datasets.kg_data.KnowledgeGraphDataset

Dataset base class for creating graph datasets. See here for the accompanying tutorial.

Args:

root (string): Root directory where the dataset should be saved. transform (callable, optional): A function/transform that takes in an

cogdl.data.Data object and returns a transformed version. The data object will be transformed before every access. (default: None)

pre_transform (callable, optional): A function/transform that takes in

an cogdl.data.Data object and returns a transformed version. The data object will be transformed before being saved to disk. (default: None)

pre_filter (callable, optional): A function that takes in an

cogdl.data.Data object and returns a boolean value, indicating whether the data object should be included in the final dataset. (default: None)

class cogdl.datasets.kg_data.WN18RRDataset

Bases: cogdl.datasets.kg_data.KnowledgeGraphDataset

Dataset base class for creating graph datasets. See here for the accompanying tutorial.

Args:

root (string): Root directory where the dataset should be saved. transform (callable, optional): A function/transform that takes in an

cogdl.data.Data object and returns a transformed version. The data object will be transformed before every access. (default: None)

pre_transform (callable, optional): A function/transform that takes in

an cogdl.data.Data object and returns a transformed version. The data object will be transformed before being saved to disk. (default: None)

pre_filter (callable, optional): A function that takes in an

cogdl.data.Data object and returns a boolean value, indicating whether the data object should be included in the final dataset. (default: None)

class cogdl.datasets.kg_data.FB13SDatset

Bases: cogdl.datasets.kg_data.KnowledgeGraphDataset

Dataset base class for creating graph datasets. See here for the accompanying tutorial.

Args:

root (string): Root directory where the dataset should be saved. transform (callable, optional): A function/transform that takes in an

cogdl.data.Data object and returns a transformed version. The data object will be transformed before every access. (default: None)

pre_transform (callable, optional): A function/transform that takes in

an cogdl.data.Data object and returns a transformed version. The data object will be transformed before being saved to disk. (default: None)

pre_filter (callable, optional): A function that takes in an

cogdl.data.Data object and returns a boolean value, indicating whether the data object should be included in the final dataset. (default: None)

url = https://raw.githubusercontent.com/cenyk1230/test-data/main