Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

nilearn.utils.all_estimators¶

nilearn.utils.all_estimators(type_filter=None)[source]¶

Get a list of all estimators from nilearn.

This function crawls the module and gets all classes that inherit from sklearn BaseEstimator. Classes that are defined in test-modules are not included.

Parameters:

type_filter{“classifier”, “cluster”, “regressor”, “masker”, “multi_masker”, “transformer”} or list of such strings, default=None: Which kind of estimators should be returned. If None, no filter is applied and all estimators are returned. Possible values are “classifier”, “cluster”, “regressor”, “masker”, “multi_masker”, “transformer” to get estimators only of these specific types, or a list of these to get the estimators that fit at least one of the types.

Returns:

estimatorslist of tuple: List of (name, class), where name is the class name as string and class is the actual type of the class.