ElectricityTiny#

class capymoa.datasets.ElectricityTiny[source]#

Bases: _DownloadableARFF

A truncated version of the Electricity dataset with 1000 instances.

This is a tiny version (2k instances) of the Electricity widely used dataset described by M. Harries. This should only be used for quick tests, not for benchmarking algorithms.

See Electricity for the widely used electricity dataset.

__init__(
directory: str | Path = get_download_dir(),
auto_download: bool = True,
)[source]#

Setup a stream from an ARFF file and optionally download it if missing.

Parameters:
__iter__() Iterator[_AnyInstance][source]#

Get an iterator over the stream.

This will NOT restart the stream if it has already been iterated over. Please use the restart() method to restart the stream.

Yield:

An iterator over the stream.

__next__() _AnyInstance[source]#

Get the next instance in the stream.

Returns:

The next instance in the stream.

cli_help() str[source]#

Return cli help string for the stream.

get_moa_stream() InstanceStream | None[source]#

Get the MOA stream object if it exists.

get_schema() Schema[source]#

Return the schema of the stream.

has_more_instances() bool[source]#

Return True if the stream have more instances to read.

next_instance() _AnyInstance[source]#

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()[source]#

Restart the stream to read instances from the beginning.

classmethod to_stream(
path: Path,
) InstanceStream[source]#

Convert the downloaded and unpacked dataset into a datastream.

schema: Schema#