nimare.base
.Estimator
- class Estimator[source]
Bases:
nimare.base.NiMAREBase
Estimators take in Datasets and return MetaResults.
- fit(dataset, drop_invalid=True)[source]
Fit Estimator to Dataset.
- Parameters
dataset (
nimare.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
nimare.results.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 callfit
.