torch_geometric.data

Data Objects

Data

A data object describing a homogeneous graph.

HeteroData

A data object describing a heterogeneous graph, holding multiple node and/or edge types in disjunct storage objects.

Batch

A data object describing a batch of graphs as one big (disconnected) graph.

TemporalData

A data object composed by a stream of events describing a temporal graph.

Dataset

Dataset base class for creating graph datasets.

InMemoryDataset

Dataset base class for creating graph datasets which easily fit into CPU memory.

OnDiskDataset

Dataset base class for creating large graph datasets which do not easily fit into CPU memory at once by leveraging a Database backend for on-disk storage and access of data objects.

LargeGraphIndexer

For a dataset that consists of multiple subgraphs that are assumed to be part of a much larger graph, collate the values into a large graph store to save resources.

TripletLike

alias of Tuple[str, str, str]

Remote Backend Interfaces

FeatureStore

An abstract base class to access features from a remote feature store.

GraphStore

An abstract base class to access edges from a remote graph store.

TensorAttr

Defines the attributes of a FeatureStore tensor.

EdgeAttr

Defines the attributes of a GraphStore edge.

Databases

Database

Base class for inserting and retrieving data from a database.

SQLiteDatabase

An index-based key/value database based on sqlite3.

RocksDatabase

An index-based key/value database based on RocksDB.

PyTorch Lightning Wrappers

LightningDataset

Converts a set of Dataset objects into a pytorch_lightning.LightningDataModule variant.

LightningNodeData

Converts a Data or HeteroData object into a pytorch_lightning.LightningDataModule variant.

LightningLinkData

Converts a Data or HeteroData object into a pytorch_lightning.LightningDataModule variant.

Helper Functions

makedirs

Recursively creates a directory.

download_url

Downloads the content of an URL to a specific folder.

download_google_url

Downloads the content of a Google Drive ID to a specific folder.

extract_tar

Extracts a tar archive to a specific folder.

extract_zip

Extracts a zip archive to a specific folder.

extract_bz2

Extracts a bz2 archive to a specific folder.

extract_gz

Extracts a gz archive to a specific folder.

get_features_for_triplets

For a given set of triplets retrieve a Data object containing the

get_features_for_triplets_groups

Given an indexer and a series of triplet groups (like a dataset), retrieve the specified node and edge features for each triplet from the index.