Bases: nimare.base.NiMAREBase
Estimators take in Datasets and return MetaResults.
All Estimators must have a _fit
method implemented, which applies algorithm-specific
methods to a dataset and returns a dictionary of arrays to be converted into a MetaResult.
Users will interact with the _fit
method by calling the user-facing fit
method.
fit
takes in a Dataset
, calls _validate_input
, then _preprocess_input
,
then _fit
, and finally converts the dictionary returned by _fit
into a MetaResult
.
-
fit(dataset, drop_invalid=True)[source]
Fit Estimator 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 False.
- Returns
MetaResult
– Results of Estimator fitting.
- Variables
inputs_ (dict
) – Inputs used in _fit.
Notes
The fit
method is a light wrapper that runs input validation and
preprocessing before fitting the actual model. Estimators’ individual
“fitting” methods are implemented as _fit
, although users should
call fit
.
-
get_params(deep=True)[source]
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)[source]
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)[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.
- Returns
self