fetch_cifar10

mlquantify.datasets.fetch_cifar10(*, 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, subset='train')

CIFAR-10 natural images (image, 10-class, balanced).

60000 32x32 colour images (50000 train / 10000 test) in 10 object classes (airplane, automobile, bird, cat, …), flattened to 3072 uint8 features. Perfectly class-balanced; commonly used for label/prior-shift quantification.

Quantification: standard image label-shift quantification (Alexandari-style).

Samples	60000 (50000 / 10000)
Features	3072 (32x32x3 uint8)
Classes	10 (balanced)

Source: https://www.cs.toronto.edu/~kriz/cifar.html

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.

subset{‘train’, ‘test’, ‘all’}, default=’train’

Which split to return.

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

Krizhevsky, A. (2009). Learning multiple layers of features from tiny images.

Examples

>>> b = fetch_cifar10(subset='test'); b.data.shape  
(10000, 3072)