nimare.decode.base.Decoder

class Decoder[source]

Bases: NiMAREBase

Base class for decoders in decode.

Changed in version 0.0.12: Moved from nimare.base to nimare.decode.base.

Added in version 0.0.3.

Methods

fit(dataset[, drop_invalid])

Fit Decoder to a Studyset/Dataset collection.

get_params([deep])

Get parameters for this estimator.

load(filename[, compressed])

Load a pickled class instance from file.

save(filename[, compress])

Pickle the class instance to the provided file.

set_params(**params)

Set the parameters of this estimator.
fit(dataset, drop_invalid=True)[source]

Fit Decoder to a Studyset/Dataset collection.

Parameters:

  • dataset (Studyset or Dataset) – Studyset-backed collection object to analyze.

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

  • warning:: (..) – Support for Dataset inputs is deprecated and will be removed in a future release. Prefer Studyset.

  • and (The fit method is a light wrapper that runs input validation)

  • individual (preprocessing before fitting the actual model. Decoders')

  • _fit ("fitting" methods are implemented as)

  • should (although users)

  • fit. (call)

  • in (Selection of features based on requested features and feature group is performed)

  • Decoder._preprocess_input.

get_params(deep=True)[source]

Get parameters for this estimator.

Parameters:

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

Returns:

params – Parameter names mapped to their values.

Return type:

dict

classmethod load(filename, compressed=True)[source]

Load a pickled class instance from file.

Parameters:

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

  • compressed (bool, default=True) – 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 – Loaded class object.

Return type:

class object

save(filename, compress=True)[source]

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

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.

Return type:

self

Examples using nimare.decode.base.Decoder

Discrete functional decoding

Discrete functional decoding