nimare.base.Decoder

class Decoder

Bases: nimare.base.NiMAREBase

Base class for decoders in decode.

New in version 0.0.3.

fit(dataset, drop_invalid=True)

Fit Decoder to Dataset.

Parameters

• dataset (Dataset) – Dataset object to analyze.

• drop_invalid (bool, optional) – Whether to automatically ignore any studies without the required data or not. Default is True.

Returns

MetaResult – Results of Decoder fitting.

Notes

The fit method is a light wrapper that runs input validation and preprocessing before fitting the actual model. Decoders’ individual “fitting” methods are implemented as _fit, although users should call fit.

Selection of features based on requested features and feature group is performed in Decoder._preprocess_input.

get_params(deep=True)

Get parameters for this estimator.

Parameters

deep (bool, optional) – If True, will return the parameters for this estimator and contained subobjects that are estimators.

Returns

params (dict) – Parameter names mapped to their values.

classmethod load(filename, compressed=True)

Load a pickled class instance from file.

Parameters

• filename (str) – Name of file containing object.

• compressed (bool, optional) – If True, the file is assumed to be compressed and gzip will be used to load it. Otherwise, it will assume that the file is not compressed. Default = True.

Returns

obj (class object) – Loaded class object.

save(filename, compress=True)

Pickle the class instance to the provided file.

Parameters

• filename (str) – File to which object will be saved.

• compress (bool, optional) – If True, the file will be compressed with gzip. Otherwise, the uncompressed version will be saved. Default = True.

set_params(**params)

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects (such as pipelines). The latter have parameters of the form <component>__<parameter> so that it’s possible to update each component of a nested object.

Returns

self

Examples using nimare.base.Decoder

Discrete functional decoding