fetch_banknote_authentication

mlquantify.datasets.fetch_banknote_authentication(*, 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)

Banknote authentication from wavelet image features (binary).

1372 banknote specimens, each summarised by four continuous features (variance, skewness, kurtosis and entropy of the wavelet-transformed image). Genuine vs. forged is an easy, low-dimensional binary problem.

Quantification: a clean, low-dimensional easy binary baseline distinct from Mushroom.

Samples	1372
Features	4 (real)
Classes	2 (~55% / ~45%)
Missing	0

Source: https://archive.ics.uci.edu/dataset/267/banknote+authentication

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

Lohweg, V. (2012). Banknote authentication, UCI ML Repository (#267).

Examples

>>> b = fetch_banknote_authentication(); b.data.shape  
(1372, 4)