topobench.data.loaders.graph.us_county_demos_dataset_loader module#

Loaders for US County Demos 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 Path(*args, **kwargs)#

Bases: PurePath

PurePath subclass that can make system calls.

Path represents a filesystem path but unlike PurePath, also offers methods to do system calls on path objects. Depending on your system, instantiating a Path will return either a PosixPath or a WindowsPath object. You can also instantiate a PosixPath or WindowsPath directly, but cannot instantiate a WindowsPath on a POSIX system or vice versa.

absolute()#

Return an absolute version of this path by prepending the current working directory. No normalization or symlink resolution is performed.

Use resolve() to get the canonical path to a file.

chmod(mode, *, follow_symlinks=True)#: Change the permissions of the path, like os.chmod().

classmethod cwd()#: Return a new path pointing to the current working directory (as returned by os.getcwd()).

exists()#: Whether this path exists.

expanduser()#: Return a new path with expanded ~ and ~user constructs (as returned by os.path.expanduser)

glob(pattern)#: Iterate over this subtree and yield all existing files (of any kind, including directories) matching the given relative pattern.

group()#: Return the group name of the file gid.

hardlink_to(target)#

Make this path a hard link pointing to the same file as target.

Note the order of arguments (self, target) is the reverse of os.link’s.

classmethod home()#: Return a new path pointing to the user’s home directory (as returned by os.path.expanduser(‘~’)).

is_block_device()#: Whether this path is a block device.

is_char_device()#: Whether this path is a character device.

is_dir()#: Whether this path is a directory.

is_fifo()#: Whether this path is a FIFO.

is_file()#: Whether this path is a regular file (also True for symlinks pointing to regular files).

is_mount()#: Check if this path is a POSIX mount point

is_socket()#: Whether this path is a socket.

is_symlink()#: Whether this path is a symbolic link.

iterdir()#: Iterate over the files in this directory. Does not yield any result for the special paths ‘.’ and ‘..’.

lchmod(mode)#: Like chmod(), except if the path points to a symlink, the symlink’s permissions are changed, rather than its target’s.

link_to(target)#

Make the target path a hard link pointing to this path.

Note this function does not make this path a hard link to target, despite the implication of the function and argument names. The order of arguments (target, link) is the reverse of Path.symlink_to, but matches that of os.link.

Deprecated since Python 3.10 and scheduled for removal in Python 3.12. Use hardlink_to() instead.

lstat()#: Like stat(), except if the path points to a symlink, the symlink’s status information is returned, rather than its target’s.

mkdir(mode=511, parents=False, exist_ok=False)#: Create a new directory at this given path.

open(mode='r', buffering=-1, encoding=None, errors=None, newline=None)#: Open the file pointed by this path and return a file object, as the built-in open() function does.

owner()#: Return the login name of the file owner.

read_bytes()#: Open the file in bytes mode, read it, and close the file.

read_text(encoding=None, errors=None)#: Open the file in text mode, read it, and close the file.

readlink()#: Return the path to which the symbolic link points.

rename(target)#

Rename this path to the target path.

The target path may be absolute or relative. Relative paths are interpreted relative to the current working directory, not the directory of the Path object.

Returns the new Path instance pointing to the target path.

replace(target)#

Rename this path to the target path, overwriting if that path exists.

The target path may be absolute or relative. Relative paths are interpreted relative to the current working directory, not the directory of the Path object.

Returns the new Path instance pointing to the target path.

resolve(strict=False)#: Make the path absolute, resolving all symlinks on the way and also normalizing it.

rglob(pattern)#: Recursively yield all existing files (of any kind, including directories) matching the given relative pattern, anywhere in this subtree.

rmdir()#: Remove this directory. The directory must be empty.

samefile(other_path)#: Return whether other_path is the same or not as this file (as returned by os.path.samefile()).

stat(*, follow_symlinks=True)#: Return the result of the stat() system call on this path, like os.stat() does.

symlink_to(target, target_is_directory=False)#: Make this path a symlink pointing to the target path. Note the order of arguments (link, target) is the reverse of os.symlink.

touch(mode=438, exist_ok=True)#: Create this file with the given access mode, if it doesn’t exist.

unlink(missing_ok=False)#: Remove this file or link. If the path is a directory, use rmdir() instead.

write_bytes(data)#: Open the file in bytes mode, write to it, and close the file.

write_text(data, encoding=None, errors=None, newline=None)#: Open the file in text mode, write to it, and close the file.

class USCountyDemosDataset(root, name, parameters)#

Bases: InMemoryDataset

Dataset class for US County Demographics 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 = {'US-county-demos': 'zip'}#

RAW_FILE_NAMES: ClassVar = {}#

URLS: ClassVar = {'US-county-demos': 'https://drive.google.com/file/d/1FNF_LbByhYNICPNdT6tMaJI9FxuSvvLK/view?usp=sharing'}#

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