`nimare.estimator`.Estimator

class Estimator(memory=Memory(location=None), memory_level=0, generate_description=True)[source]

Bases: NiMAREBase

Estimators take in collections and return fitted result objects.

All Estimators must have a _fit method implemented, which applies algorithm-specific methods to a collection and returns a dictionary of arrays to be converted into a fitted result object.

Users will interact with the _fit method by calling the user-facing fit method. fit takes in a Dataset, calls _collect_inputs, then _preprocess_input, then _fit, and finally converts the dictionary returned by _fit into a result object via _make_result.

Warning

Support for Dataset inputs is deprecated and will be removed in a future release. Prefer Studyset.

Methods

`fit`(dataset[, drop_invalid])	Fit Estimator to a 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 Estimator to a collection.

Parameters:

dataset (Studyset or Dataset) – Collection object to analyze.
drop_invalid (bool, optional) – Whether to automatically ignore any studies without the required data or not. Default is True.

Returns:

Result of Estimator fitting. Subclasses may return a MetaResult subclass.

Return type:

MetaResult

Variables:

inputs (dict) – Inputs used in _fit.
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. Estimators')
should ("fitting" methods are implemented as _fit, although users)
fit. (call)

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.