Load Benchmark Datasets

class NeuroGraphDataset(root: str, name: str, transform: Callable | None = None, pre_transform: Callable | None = None, pre_filter: Callable | None = None)

Bases: InMemoryDataset

The NeuroGraph benchmark datasets from the “NeuroGraph: Benchmarks for Graph Machine Learning in Brain Connectomics” paper. NeuroGraphDataset holds a collection of five neuroimaging graph learning datasets that span multiple categories of demographics, mental states, and cognitive traits. See the documentation and the Github for more details.

Dataset	#Graphs	Task
HCPTask	7,443	Graph Classification
HCPGender	1,078	Graph Classification
HCPAge	1,065	Graph Classification
HCPFI	1,071	Graph Regression
HCPWM	1,078	Graph Regression

Args:

root (str): Root directory where the dataset should be saved. name (str): The name of the dataset (one of "HCPGender",

"HCPTask", "HCPAge", "HCPFI", "HCPWM").

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

torch_geometric.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 torch_geometric.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

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

download()

Downloads the dataset to the self.raw_dir folder.

filenames = {'HCPAge': 'lzzks4472czy9f9vc8aikp7pdbknmtfe.zip', 'HCPFI': 'g2md9h9snh7jh6eeay02k1kr9m4ido9f.zip', 'HCPGender': 'r6hlz2arm7yiy6v6981cv2nzq3b0meax.zip', 'HCPTask': '8wzz4y17wpxg2stip7iybtmymnybwvma.zip', 'HCPWM': 'xtmpa6712fidi94x6kevpsddf9skuoxy.zip'}

process()

Processes the dataset to the self.processed_dir folder.

property processed_dir: str

property processed_file_names: str

The name of the files in the self.processed_dir folder that must be present in order to skip processing.

property raw_dir: str

property raw_file_names: str

The name of the files in the self.raw_dir folder that must be present in order to skip downloading.

url = 'https://vanderbilt.box.com/shared/static'

class NeuroGraphDynamic(root, name)

Bases: object

Graph-based neuroimaging benchmark datasets, e.g., "DynHCPGender", "DynHCPAge", "DynHCPActivity", "DynHCPWM", or "DynHCPFI"

Args:

root (str): Root directory where the dataset should be saved. name (str): The name of the dataset.

Returns:

list: A list of graphs in PyTorch Geometric (pyg) format. Each graph contains a list of dynamic graphs batched in pyg batch.

download()

filenames = {'DynHCPActivity': '2so3fnfqakeu6hktz322o3nm2c8ocus7.zip', 'DynHCPAge': '195f9teg4t4apn6kl6hbc4ib4g9addtq.zip', 'DynHCPFI': 'un7w3ohb2mmyjqt1ou2wm3g87y1lfuuo.zip', 'DynHCPGender': 'mj0z6unea34lfz1hkdwsinj7g22yohxn.zip', 'DynHCPWM': 'mxy8fq3ghm60q6h7uhnu80pgvfxs6xo2.zip'}

load_data()

url = 'https://vanderbilt.box.com/shared/static'