Examples 🧪#
This section contains a collection of examples that demonstrate how you can use the GHONN Models library. Examples are in general provided in the form of Jupyter notebooks, which can be run interactively. New examples will be added over time, so check back every now and then.
Available Jupyter notebooks#
Dataset loader API#
- ghonn_models_pytorch.datasets.load_example_dataset(name, **kwargs)[source]#
Unified dataset loader interface from collections module.
This function loads datasets from the collections module based on the provided name, which corresponds to the function names in the collections module.
- Parameters:
name (str) – Name of the dataset to load which matches function names in the collections module.
**kwargs (dict[str, Any]) – Additional keyword arguments for pandas readers.
- Returns:
The requested dataset as a DataFrame.
- Raises:
ValueError – If the dataset name is not recognized.
- Return type:
DataFrame
Available Datasets#
This module provides API to datasets for experimentation with the repository.
- ghonn_models_pytorch.datasets.collections.air_passenger()[source]#
Returns the URL for the Air Passenger dataset.
This dataset is taken from the Kats Repository in the Facebook research repo, see [Jiang_KATS_2022].
- Return type:
str