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
tonimare.decode.base
.New in version 0.0.3.
Methods
fit
(dataset[, drop_invalid])Fit Decoder to Dataset.
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 Dataset.
- Parameters:
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 callfit
.Selection of features based on requested features and feature group is performed in
Decoder._preprocess_input
.
- classmethod load(filename, compressed=True)[source]
Load a pickled class instance from file.
- Parameters:
- Returns:
obj – Loaded class object.
- Return type:
class object
- 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