"""County level chicken pox cases in Hungary."""
from __future__ import annotations
import numpy as np
from stgraph.dataset.temporal.stgraph_temporal_dataset import STGraphTemporalDataset
[docs]class HungaryCPDataLoader(STGraphTemporalDataset):
r"""County level chicken pox cases in Hungary.
This dataset comprises information on weekly occurrences of chickenpox
in Hungary from 2005 to 2015. The graph structure is static with nodes
representing the counties and edges are neighbourhoods between them.
Vertex features are lagged weekly counts of the chickenpox cases.
This class provides functionality for loading, processing, and accessing
the Hungary Chickenpox dataset for use in deep learning tasks such as
County level case count prediction.
.. list-table:: gdata
:widths: 33 33 33
:header-rows: 1
* - num_nodes
- num_edges
- total_timestamps
* - 20
- 102
- 521
Example
-------
.. code-block:: python
from stgraph.dataset import HungaryCPDataLoader
hungary = HungaryCPDataLoader(verbose=True)
num_nodes = hungary.gdata["num_nodes"]
edge_list = hungary.get_edges()
Parameters
----------
verbose : bool, optional
Flag to control whether to display verbose info (default is False)
lags : int, optional
The number of time lags (default is 4)
cutoff_time : int, optional
The cutoff timestamp for the temporal dataset (default is None)
redownload : bool, optional (default is False)
Redownload the dataset online and save to cache
Attributes
----------
name : str
The name of the dataset.
gdata : dict
Graph meta data.
"""
def __init__(
self: HungaryCPDataLoader,
verbose: bool = False,
lags: int = 4,
cutoff_time: int | None = None,
redownload: bool = False,
) -> None:
"""County level chicken pox cases in Hungary."""
super().__init__()
if not isinstance(lags, int):
raise TypeError("lags must be of type int")
if lags < 0:
raise ValueError("lags must be a positive integer")
if cutoff_time is not None and not isinstance(cutoff_time, int):
raise TypeError("cutoff_time must be of type int")
if cutoff_time is not None and cutoff_time < 0:
raise ValueError("cutoff_time must be a positive integer")
self.name = "Hungary_Chickenpox"
self._url = "https://raw.githubusercontent.com/bfGraph/STGraph-Datasets/main/HungaryCP.json"
self._verbose = verbose
self._lags = lags
self._cutoff_time = cutoff_time
self._edge_list = None
self._edge_weights = None
self._all_targets = None
if redownload and self._has_dataset_cache():
self._delete_cached_dataset()
if self._has_dataset_cache():
self._load_dataset()
else:
self._download_dataset()
self._save_dataset()
self._process_dataset()
def _process_dataset(self: HungaryCPDataLoader) -> None:
self._set_total_timestamps()
self._set_num_nodes()
self._set_num_edges()
self._set_edges()
self._set_edge_weights()
self._set_targets_and_features()
def _set_total_timestamps(self: HungaryCPDataLoader) -> None:
r"""Set the total timestamps present in the dataset.
It sets the total timestamps present in the dataset into the
gdata attribute dictionary. It is the minimum of the cutoff time
choosen by the user and the total time periods present in the
original dataset.
"""
if self._cutoff_time is not None:
self.gdata["total_timestamps"] = min(
len(self._dataset["FX"]),
self._cutoff_time,
)
else:
self.gdata["total_timestamps"] = len(self._dataset["FX"])
def _set_num_nodes(self: HungaryCPDataLoader) -> None:
r"""Set the total number of nodes present in the dataset."""
node_set = set()
max_node_id = 0
for edge in self._dataset["edges"]:
node_set.add(edge[0])
node_set.add(edge[1])
max_node_id = max(max_node_id, edge[0], edge[1])
if max_node_id != len(node_set) - 1:
raise RuntimeError("Node ID labelling is not continuous")
self.gdata["num_nodes"] = len(node_set)
def _set_num_edges(self: HungaryCPDataLoader) -> None:
r"""Set the total number of edges present in the dataset."""
self.gdata["num_edges"] = len(self._dataset["edges"])
def _set_edges(self: HungaryCPDataLoader) -> None:
r"""Set the edge list of the dataset."""
self._edge_list = [(edge[0], edge[1]) for edge in self._dataset["edges"]]
def _set_edge_weights(self: HungaryCPDataLoader) -> None:
r"""Set the edge weights of the dataset."""
self._edge_weights = np.ones(self.gdata["num_edges"])
def _set_targets_and_features(self: HungaryCPDataLoader) -> None:
r"""Calculate and set the target and feature attributes."""
stacked_target = np.array(self._dataset["FX"])
self._all_targets = [
stacked_target[i + self._lags, :].T
for i in range(self.gdata["total_timestamps"] - self._lags)
]
[docs] def get_edges(self: HungaryCPDataLoader) -> list:
r"""Return the edge list."""
return self._edge_list
[docs] def get_edge_weights(self: HungaryCPDataLoader) -> np.ndarray:
r"""Return the edge weights."""
return self._edge_weights
[docs] def get_all_targets(self: HungaryCPDataLoader) -> np.ndarray:
r"""Return the targets for each timestamp."""
return self._all_targets