DownloadableDataset

class capymoa.datasets.downloader.DownloadableDataset

Bases: ABC, Stream

__init__(

directory: str = PosixPath('data'),

auto_download: bool = True,

CLI: str | None = None,

schema: str | None = None,

)

get_path()

abstract download(working_directory: Path) → Path

Download the dataset and return the path to the downloaded dataset within the working directory.

Parameters:

working_directory – The directory to download the dataset to.

Returns:

The path to the downloaded dataset within the working directory.

abstract extract(stream_archive: Path) → Path

Extract the dataset from the archive and return the path to the extracted dataset.

Parameters:

stream_archive – The path to the archive containing the dataset.

Returns:

The path to the extracted dataset.

abstract to_stream(stream: Path)

Convert the dataset to a MOA stream.

Parameters:

stream – The path to the dataset.

Returns:

A MOA stream.

CLI_help() → str

Return cli help string for the stream.

get_moa_stream() → InstanceStream | None

Get the MOA stream object if it exists.

get_schema() → Schema

Return the schema of the stream.

has_more_instances() → bool

Return True if the stream have more instances to read.

next_instance() → LabeledInstance | RegressionInstance

Return the next instance in the stream.

Raises:

ValueError – If the machine learning task is neither a regression nor a classification task.

Returns:

A labeled instances or a regression depending on the schema.

restart()

Restart the stream to read instances from the beginning.