fetch_electricity_elec2

mlquantify.datasets.fetch_electricity_elec2(*, data_home=None, download_if_missing=True, return_X_y=False, as_frame=False, n_retries=3, delay=1.0, protocol=None, n_samples=1000, sample_size=500, random_state=None, target_col=None)

Electricity (Elec2): NSW market price up/down stream (binary, drift).

45312 half-hourly records from the Australian New South Wales electricity market (May 1996 - Dec 1998), kept in chronological order. Features describe day, period and NSW/Victoria demand and transfer; the label is whether the price moved UP or DOWN relative to a moving average. A canonical concept-drift stream.

Quantification: time-ordered drifting stream – the workhorse for quantification-over-time.

Samples	45312
Features	6 (real, as served)
Classes	2 (UP 42.5% / DOWN 57.5%)
Order	chronological

Source: https://www.openml.org/d/151 (scikit-multiflow mirror)

Parameters:

data_homestr or path-like, default=None

Folder used to cache the downloaded file(s); defaults to _data/ next to the package.

download_if_missingbool, default=True

If False, raise instead of downloading when the cache is empty.

return_X_ybool, default=False

Return (X, y) instead of a Bunch.

as_framebool, default=False

Return .data as a DataFrame, .target as a Series, and a combined .frame (features + a "target" column).

n_retriesint, default=3

Number of download attempts before giving up.

delayfloat, default=1.0

Seconds to wait between attempts.

protocol{None, “app”, “npp”, “upp”, “ppp”} or mlquantify protocol, default=None

If set, draw evaluation sample-bags with an mlquantify protocol; the Bunch then also has .samples (index bags into .data), .prevalences and .protocol.

n_samplesint, default=1000

Number of prevalence points (bags) generated by the protocol.

sample_sizeint, default=500

Instances per bag (the protocol batch_size).

random_stateint or None, default=None

Seed forwarded to the protocol.

Returns:

dataBunch

Dictionary-like object. Attributes: data (features), target (labels), feature_names, target_names, DESCR; frame when as_frame=True; and samples / prevalences / protocol when protocol is set.

(X, y)tuple

Returned instead when return_X_y=True.

References

Harries, M. (1999). SPLICE-2 Comparative Evaluation, UNSW tech. report.

Examples

>>> b = fetch_electricity_elec2(); b.data.shape  
(45312, 6)