Skip to content

TGB

TGB Datasets

tgb_data

Bases: object

Source code in tgx/data/tgb.py 
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
class tgb_data(object):
    def __init__(self, dname: str, 
            edge_feat: bool = False,
            w: bool = False,
            edge_label: bool = False,
            edge_idxs: bool = False):
        """
        Data class for loading default (in-package) temporal datasets

        In order to use "tgb" datasets install tgb package
        for more detals visit here: https://tgb.complexdatalab.com/

        In order to use dgb datasets download and extract dataset file
        from here: https://zenodo.org/record/7213796#.Y1cO6y8r30o
        and locate them in ./data/ directory.
        """
        self.tgb(dname, 
                edge_feat = edge_feat,
                w = w,
                edge_label = edge_label,
                edge_idxs = edge_idxs)

        return

    @classmethod
    def tgb(self, dname: str, 
            edge_feat: bool = False,
            w: bool = False,
            edge_label: bool = False,
            edge_idxs: bool = False):
        """
        Load datasets from "tgb" package. To load these datasets you need to install tgb package.
        Parameters:
            dname: str, name of the dataset from the list:
                        ["tgbl-wiki", "tgbl-review", 
                        "tgbl-coin", "tgbl-comment", 
                        "tgbl-flight","tgbn-trade", 
                        "tgbn-genre", "tgbn-reddit"]
            edge_feat: list of edge features
            w: edge weights
            edge_label: edge labels
            edge_idxs: edge indexes

        """
        try:
            from tgb.linkproppred.dataset import LinkPropPredDataset
            from tgb.nodeproppred.dataset import NodePropPredDataset
        except:
            print("First install TGB package using 'pip install py-tgb'")

        #TODO not hard code the dataset name anymore
        link_pred = ["tgbl-wiki", "tgbl-review", "tgbl-coin", "tgbl-comment", "tgbl-flight"]
        node_pred = ["tgbn-trade", "tgbn-genre", "tgbn-reddit", "tgbn-token"]
        if dname in link_pred:
            dataset = LinkPropPredDataset(name=dname, root="datasets", preprocess=True)
        elif dname in node_pred:
            dataset = NodePropPredDataset(name=dname, root="datasets", preprocess=True)
        else:
            raise ValueError("Invalid tgb dataset name")

        data = dataset.full_data
        data = np.array([data['sources'], data["destinations"], data["timestamps"]])
        self.data = np.transpose(data)

        if edge_feat:
            self.edge_feat = data['edge_feat']
        if w:
            self.w = data['w']
        if edge_label:
            self.edge_label = data['edge_label']
        if edge_idxs:
            self.edge_idxs = data['edge_idxs']

        self.discretize = Data_specifications[dname]['discretize']
        self.time_scale = Data_specifications[dname]['time_scale']
        self.train_mask = dataset.train_mask
        self.val_mask = dataset.val_mask
        self.test_mask = dataset.test_mask
        self.name = dname

        return self


    def read_specifications(self, 
                            data: type):
        """
        Load dataset specifications for dgb datasets
        Parameters:
            data: str, name of the dataset
        """
        self.name = data
        self.discretize = Data_specifications[data]['discretize']
        self.time_scale = Data_specifications[data]['time_scale']
        return self

__init__(dname, edge_feat=False, w=False, edge_label=False, edge_idxs=False)

Data class for loading default (in-package) temporal datasets

In order to use "tgb" datasets install tgb package for more detals visit here: https://tgb.complexdatalab.com/

In order to use dgb datasets download and extract dataset file from here: https://zenodo.org/record/7213796#.Y1cO6y8r30o and locate them in ./data/ directory.

Source code in tgx/data/tgb.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
def __init__(self, dname: str, 
        edge_feat: bool = False,
        w: bool = False,
        edge_label: bool = False,
        edge_idxs: bool = False):
    """
    Data class for loading default (in-package) temporal datasets

    In order to use "tgb" datasets install tgb package
    for more detals visit here: https://tgb.complexdatalab.com/

    In order to use dgb datasets download and extract dataset file
    from here: https://zenodo.org/record/7213796#.Y1cO6y8r30o
    and locate them in ./data/ directory.
    """
    self.tgb(dname, 
            edge_feat = edge_feat,
            w = w,
            edge_label = edge_label,
            edge_idxs = edge_idxs)

    return

read_specifications(data)

Load dataset specifications for dgb datasets Parameters: data: str, name of the dataset

Source code in tgx/data/tgb.py 
 98
 99
100
101
102
103
104
105
106
107
108
def read_specifications(self, 
                        data: type):
    """
    Load dataset specifications for dgb datasets
    Parameters:
        data: str, name of the dataset
    """
    self.name = data
    self.discretize = Data_specifications[data]['discretize']
    self.time_scale = Data_specifications[data]['time_scale']
    return self

tgb(dname, edge_feat=False, w=False, edge_label=False, edge_idxs=False) classmethod

Load datasets from "tgb" package. To load these datasets you need to install tgb package. Parameters: dname: str, name of the dataset from the list: ["tgbl-wiki", "tgbl-review", "tgbl-coin", "tgbl-comment", "tgbl-flight","tgbn-trade", "tgbn-genre", "tgbn-reddit"] edge_feat: list of edge features w: edge weights edge_label: edge labels edge_idxs: edge indexes

Source code in tgx/data/tgb.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
@classmethod
def tgb(self, dname: str, 
        edge_feat: bool = False,
        w: bool = False,
        edge_label: bool = False,
        edge_idxs: bool = False):
    """
    Load datasets from "tgb" package. To load these datasets you need to install tgb package.
    Parameters:
        dname: str, name of the dataset from the list:
                    ["tgbl-wiki", "tgbl-review", 
                    "tgbl-coin", "tgbl-comment", 
                    "tgbl-flight","tgbn-trade", 
                    "tgbn-genre", "tgbn-reddit"]
        edge_feat: list of edge features
        w: edge weights
        edge_label: edge labels
        edge_idxs: edge indexes

    """
    try:
        from tgb.linkproppred.dataset import LinkPropPredDataset
        from tgb.nodeproppred.dataset import NodePropPredDataset
    except:
        print("First install TGB package using 'pip install py-tgb'")

    #TODO not hard code the dataset name anymore
    link_pred = ["tgbl-wiki", "tgbl-review", "tgbl-coin", "tgbl-comment", "tgbl-flight"]
    node_pred = ["tgbn-trade", "tgbn-genre", "tgbn-reddit", "tgbn-token"]
    if dname in link_pred:
        dataset = LinkPropPredDataset(name=dname, root="datasets", preprocess=True)
    elif dname in node_pred:
        dataset = NodePropPredDataset(name=dname, root="datasets", preprocess=True)
    else:
        raise ValueError("Invalid tgb dataset name")

    data = dataset.full_data
    data = np.array([data['sources'], data["destinations"], data["timestamps"]])
    self.data = np.transpose(data)

    if edge_feat:
        self.edge_feat = data['edge_feat']
    if w:
        self.w = data['w']
    if edge_label:
        self.edge_label = data['edge_label']
    if edge_idxs:
        self.edge_idxs = data['edge_idxs']

    self.discretize = Data_specifications[dname]['discretize']
    self.time_scale = Data_specifications[dname]['time_scale']
    self.train_mask = dataset.train_mask
    self.val_mask = dataset.val_mask
    self.test_mask = dataset.test_mask
    self.name = dname

    return self