topobench.data.loaders package

Init file for load module.

class AbstractLoader(parameters)

Bases: ABC

Abstract class that provides an interface to load data.

Parameters:

parametersDictConfig

Configuration parameters.

__init__(parameters)

get_data_dir()

Get the data directory.

Returns:

Path

The path to the dataset directory.

load(**kwargs)

Load data.

Parameters:

**kwargsdict

Additional keyword arguments.

Returns:

tuple[torch_geometric.data.Data, str]

Tuple containing the loaded data and the data directory.

abstract load_dataset()

Load data into a dataset.

Returns:

Union[torch_geometric.data.Dataset, torch.utils.data.Dataset]

The loaded dataset, which could be a PyG or PyTorch dataset.

Raises:

NotImplementedError

If the method is not implemented.

class CitationHypergraphDatasetLoader(parameters)

Bases: AbstractLoader

Load Citation Hypergraph dataset with configurable parameters.

Parameters:

parametersDictConfig

Configuration parameters containing:

• data_dir: Root directory for data

• data_name: Name of the dataset

• other relevant parameters

__init__(parameters)

load_dataset()

Load the Citation Hypergraph dataset.

Returns:

CitationHypergraphDataset

The loaded Citation Hypergraph dataset with the appropriate data_dir.

Raises:

RuntimeError

If dataset loading fails.

class GeometricShapesDatasetLoader(parameters)

Bases: AbstractLoader

Load GeometricShapes dataset.

Parameters:

parametersDictConfig

Configuration parameters containing:

• data_dir: Root directory for data

__init__(parameters)

load_dataset()

Load GeometricShapes dataset.

Returns:

Dataset

The loaded GeometricShapes dataset.

Raises:

RuntimeError

If dataset loading fails.

class HeterophilousGraphDatasetLoader(parameters)

Bases: AbstractLoader

Load Heterophilous Graph datasets.

Parameters:

parametersDictConfig

Configuration parameters containing:

• data_dir: Root directory for data

• data_name: Name of the dataset

• data_type: Type of the dataset (e.g., “heterophilous”)

__init__(parameters)

load_dataset()

Load Heterophilous Graph dataset.

Returns:

Dataset

The loaded Heterophilous Graph dataset.

Raises:

RuntimeError

If dataset loading fails.

class HypergraphDatasetLoader(parameters)

Bases: AbstractLoader

Load Citation Hypergraph dataset with configurable parameters.

Parameters:

parametersDictConfig

Configuration parameters containing:

• data_dir: Root directory for data

• data_name: Name of the dataset

• other relevant parameters

__init__(parameters)

load_dataset()

Load the Citation Hypergraph dataset.

Returns:

HypergraphDataset

The loaded Citation Hypergraph dataset with the appropriate data_dir.

Raises:

RuntimeError

If dataset loading fails.

class MantraSimplicialDatasetLoader(parameters, **kwargs)

Bases: AbstractLoader

Load Mantra dataset with configurable parameters.

Note: for the simplicial datasets it is necessary to include DatasetLoader into the name of the class!

Parameters:

parametersDictConfig

Configuration parameters containing:

• data_dir: Root directory for data

• data_name: Name of the dataset

• other relevant parameters

**kwargsdict

Additional keyword arguments.

__init__(parameters, **kwargs)

load_dataset(**kwargs)

Load the Citation Hypergraph dataset.

Parameters:

**kwargsdict

Additional keyword arguments for dataset initialization.

Returns:

CitationHypergraphDataset

The loaded Citation Hypergraph dataset with the appropriate data_dir.

Raises:

RuntimeError

If dataset loading fails.

class ManualGraphDatasetLoader(parameters)

Bases: AbstractLoader

Load manually provided graph datasets.

Parameters:

parametersDictConfig

Configuration parameters containing:

• data_name: Name of the dataset

• data_dir: Root directory for data

__init__(parameters)

get_data_dir()

Get the data directory.

Returns:

Path

The path to the dataset directory.

load_dataset()

Load the manual graph dataset.

Returns:

DataloadDataset

The dataset object containing the manually loaded graph.

class MoleculeDatasetLoader(parameters)

Bases: AbstractLoader

Load molecule datasets (ZINC and AQSOL) with predefined splits.

Parameters:

parametersDictConfig

Configuration parameters containing:

• data_dir: Root directory for data

• data_name: Name of the dataset

• data_type: Type of the dataset (e.g., “molecule”)

__init__(parameters)

get_data_dir()

Get the data directory.

Returns:

Path

The path to the dataset directory.

load_dataset()

Load the molecule dataset with predefined splits.

Returns:

Dataset

The combined dataset with predefined splits.

Raises:

RuntimeError

If dataset loading fails.

class OGBGDatasetLoader(parameters)

Bases: AbstractLoader

Load molecule datasets (molhiv, molpcba, ppa) with predefined splits.

Parameters:

parametersDictConfig

Configuration parameters containing:

• data_dir: Root directory for data

• data_name: Name of the dataset

• data_type: Type of the dataset (e.g., “molecule”)

__init__(parameters)

get_data_dir()

Get the data directory.

Returns:

Path

The path to the dataset directory.

load_dataset()

Load the molecule dataset with predefined splits.

Returns:

Dataset

The combined dataset with predefined splits.

Raises:

RuntimeError

If dataset loading fails.

class PlanetoidDatasetLoader(parameters)

Bases: AbstractLoader

Load PLANETOID datasets.

Parameters:

parametersDictConfig

Configuration parameters containing:

• data_dir: Root directory for data

• data_name: Name of the dataset

• data_type: Type of the dataset (e.g., “cocitation”)

__init__(parameters)

load_dataset()

Load Planetoid dataset.

Returns:

Dataset

The loaded Planetoid dataset.

Raises:

RuntimeError

If dataset loading fails.

class TUDatasetLoader(parameters)

Bases: AbstractLoader

Load TU datasets.

Parameters:

parametersDictConfig

Configuration parameters containing:

• data_dir: Root directory for data

• data_name: Name of the dataset

• data_type: Type of the dataset (e.g., “graph_classification”)

__init__(parameters)

load_dataset()

Load TU dataset.

Returns:

Dataset

The loaded TU dataset.

Raises:

RuntimeError

If dataset loading fails.

class USCountyDemosDatasetLoader(parameters)

Bases: AbstractLoader

Load US County Demos dataset with configurable year and task variable.

Parameters:

parametersDictConfig

Configuration parameters containing:

• data_dir: Root directory for data

• data_name: Name of the dataset

• year: Year of the dataset (if applicable)

• task_variable: Task variable for the dataset

__init__(parameters)

load_dataset()

Load the US County Demos dataset.

Returns:

USCountyDemosDataset

The loaded US County Demos dataset with the appropriate data_dir.

Raises:

RuntimeError

If dataset loading fails.

Subpackages

• topobench.data.loaders.graph package
  • HeterophilousGraphDatasetLoader
    • HeterophilousGraphDatasetLoader.__init__()
    • HeterophilousGraphDatasetLoader.load_dataset()
  • MantraSimplicialDatasetLoader
    • MantraSimplicialDatasetLoader.__init__()
    • MantraSimplicialDatasetLoader.load_dataset()
  • ManualGraphDatasetLoader
    • ManualGraphDatasetLoader.__init__()
    • ManualGraphDatasetLoader.get_data_dir()
    • ManualGraphDatasetLoader.load_dataset()
  • MoleculeDatasetLoader
    • MoleculeDatasetLoader.__init__()
    • MoleculeDatasetLoader.get_data_dir()
    • MoleculeDatasetLoader.load_dataset()
  • OGBGDatasetLoader
    • OGBGDatasetLoader.__init__()
    • OGBGDatasetLoader.get_data_dir()
    • OGBGDatasetLoader.load_dataset()
  • PlanetoidDatasetLoader
    • PlanetoidDatasetLoader.__init__()
    • PlanetoidDatasetLoader.load_dataset()
  • TUDatasetLoader
    • TUDatasetLoader.__init__()
    • TUDatasetLoader.load_dataset()
  • USCountyDemosDatasetLoader
    • USCountyDemosDatasetLoader.__init__()
    • USCountyDemosDatasetLoader.load_dataset()
  • Submodules
    • topobench.data.loaders.graph.hetero_datasets module
      • AbstractLoader
      • Dataset
      • DictConfig
      • HeterophilousGraphDataset
      • HeterophilousGraphDatasetLoader
    • topobench.data.loaders.graph.mantra_dataset module
      • AbstractLoader
      • DictConfig
      • MantraDataset
      • MantraSimplicialDatasetLoader
    • topobench.data.loaders.graph.manual_graph_dataset_loader module
      • AbstractLoader
      • Any
      • DataloadDataset
      • DictConfig
      • ManualGraphDatasetLoader
      • Path
      • load_manual_graph()
    • topobench.data.loaders.graph.modecule_datasets module
      • AQSOL
      • AbstractLoader
      • Dataset
      • DictConfig
      • MoleculeDatasetLoader
      • Path
      • ZINC
    • topobench.data.loaders.graph.ogbg_datasets module
      • AbstractLoader
      • Dataset
      • DictConfig
      • OGBGDatasetLoader
      • Path
      • PygGraphPropPredDataset
    • topobench.data.loaders.graph.planetoid_datasets module
      • AbstractLoader
      • Dataset
      • DictConfig
      • Planetoid
      • PlanetoidDatasetLoader
    • topobench.data.loaders.graph.tu_datasets module
      • AbstractLoader
      • Dataset
      • DictConfig
      • TUDataset
      • TUDatasetLoader
    • topobench.data.loaders.graph.us_county_demos_dataset_loader module
      • AbstractLoader
      • DictConfig
      • Path
      • USCountyDemosDataset
      • USCountyDemosDatasetLoader
• topobench.data.loaders.hypergraph package
  • CitationHypergraphDatasetLoader
    • CitationHypergraphDatasetLoader.__init__()
    • CitationHypergraphDatasetLoader.load_dataset()
  • HypergraphDatasetLoader
    • HypergraphDatasetLoader.__init__()
    • HypergraphDatasetLoader.load_dataset()
  • Submodules
    • topobench.data.loaders.hypergraph.citation_hypergraph_dataset_loader module
      • AbstractLoader
      • CitationHypergraphDataset
      • CitationHypergraphDatasetLoader
      • DictConfig
    • topobench.data.loaders.hypergraph.hypergraph_dataset_loader module
      • AbstractLoader
      • DictConfig
      • HypergraphDataset
      • HypergraphDatasetLoader
• topobench.data.loaders.pointcloud package
  • GeometricShapesDatasetLoader
    • GeometricShapesDatasetLoader.__init__()
    • GeometricShapesDatasetLoader.load_dataset()
  • Submodules
    • topobench.data.loaders.pointcloud.geometric_shapes module
      • AbstractLoader
      • Dataset
      • DictConfig
      • GeometricShapes
      • GeometricShapesDatasetLoader
      • rename_pos_to_x()
• topobench.data.loaders.simplicial package
  • MantraSimplicialDatasetLoader
    • MantraSimplicialDatasetLoader.__init__()
    • MantraSimplicialDatasetLoader.load_dataset()
  • Submodules
    • topobench.data.loaders.simplicial.mantra_dataset_loader module
      • AbstractLoader
      • DictConfig
      • MantraDataset
      • MantraSimplicialDatasetLoader

Submodules

• topobench.data.loaders.base module
  • ABC
  • AbstractLoader
    • AbstractLoader.__init__()
    • AbstractLoader.get_data_dir()
    • AbstractLoader.load()
    • AbstractLoader.load_dataset()
  • DictConfig
    • DictConfig.__init__()
    • DictConfig.copy()
    • DictConfig.get()
    • DictConfig.items()
    • DictConfig.items_ex()
    • DictConfig.keys()
    • DictConfig.pop()
    • DictConfig.setdefault()
  • Path
    • Path.absolute()
    • Path.chmod()
    • Path.cwd()
    • Path.exists()
    • Path.expanduser()
    • Path.glob()
    • Path.group()
    • Path.hardlink_to()
    • Path.home()
    • Path.is_block_device()
    • Path.is_char_device()
    • Path.is_dir()
    • Path.is_fifo()
    • Path.is_file()
    • Path.is_mount()
    • Path.is_socket()
    • Path.is_symlink()
    • Path.iterdir()
    • Path.lchmod()
    • Path.link_to()
    • Path.lstat()
    • Path.mkdir()
    • Path.open()
    • Path.owner()
    • Path.read_bytes()
    • Path.read_text()
    • Path.readlink()
    • Path.rename()
    • Path.replace()
    • Path.resolve()
    • Path.rglob()
    • Path.rmdir()
    • Path.samefile()
    • Path.stat()
    • Path.symlink_to()
    • Path.touch()
    • Path.unlink()
    • Path.write_bytes()
    • Path.write_text()
  • abstractmethod()