topobench.data.loaders.hypergraph.hypergraph_dataset_loader module

Loaders for Citation Hypergraph dataset.

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 DictConfig(content, key=None, parent=None, ref_type=typing.Any, key_type=typing.Any, element_type=typing.Any, is_optional=True, flags=None)

Bases: BaseContainer, MutableMapping[Any, Any]

__init__(content, key=None, parent=None, ref_type=typing.Any, key_type=typing.Any, element_type=typing.Any, is_optional=True, flags=None)

copy()

get(key, default_value=None)

Return the value for key if key is in the dictionary, else default_value (defaulting to None).

items() → a set-like object providing a view on D's items

items_ex(resolve=True, keys=None)

keys() → a set-like object providing a view on D's keys

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

class HypergraphDataset(root, name, parameters)

Bases: InMemoryDataset

Dataset class for Hypergaph dataset.

Parameters:

rootstr

Root directory where the dataset will be saved.

namestr

Name of the dataset.

parametersDictConfig

Configuration parameters for the dataset.

Attributes:

URLS (dict): Dictionary containing the URLs for downloading the dataset.

FILE_FORMAT (dict): Dictionary containing the file formats for the dataset.

RAW_FILE_NAMES (dict): Dictionary containing the raw file names for the dataset.

__init__(root, name, parameters)

download()

Download the dataset from a URL and saves it to the raw directory.

Raises:

FileNotFoundError – If the dataset URL is not found.

process()

Handle the data for the dataset.

This method loads the US county demographics data, applies any pre- processing transformations if specified, and saves the processed data to the appropriate location.

FILE_FORMAT: ClassVar = {'20newsW100': 'zip', 'ModelNet40': 'zip', 'Mushroom': 'zip', 'NTU2012': 'zip', 'zoo': 'zip'}

RAW_FILE_NAMES: ClassVar = {}

URLS: ClassVar = {'20newsW100': 'https://drive.google.com/file/d/1D1NtyS4g9LZJPlnxOOySGlRR2km1wGMm/view?usp=drive_link', 'ModelNet40': 'https://drive.google.com/file/d/1u3-SFCjOIh1G0U8pVclfGIlDCceJ0qxr/view?usp=drive_link', 'Mushroom': 'https://drive.google.com/file/d/1iad2l9w58UJvMMXOz6PtrbZkvGyFjWK6/view?usp=drive_link', 'NTU2012': 'https://drive.google.com/file/d/1g9P-uEVSATg6B_JRnyey78YbliIfst3Z/view?usp=drive_link', 'zoo': 'https://drive.google.com/file/d/18TuuGv3qiBfU-wqB3USB3HiiI9G-8X71/view?usp=drive_link'}

property processed_dir: str

Return the path to the processed directory of the dataset.

Returns:

str

Path to the processed directory.

property processed_file_names: str

Return the processed file name for the dataset.

Returns:

str

Processed file name.

property raw_dir: str

Return the path to the raw directory of the dataset.

Returns:

str

Path to the raw directory.

property raw_file_names: list[str]

Return the raw file names for the dataset.

Returns:

list[str]

List of raw file names.

slices: Dict[str, Tensor] | None

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.