optuna.importance.FanovaImportanceEvaluator

class optuna.importance.FanovaImportanceEvaluator[source]

fANOVA parameter importance evaluator.

Note

Requires the fanova Python package.

Note

Added in v1.3.0 as an experimental feature. The interface may change in newer versions without prior notice. See https://github.com/optuna/optuna/releases/tag/v1.3.0.

__init__()None[source]

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__()

Initialize self.

evaluate(study, params)

Evaluate parameter importances based on completed trials in the given study.

evaluate(study: optuna.study.Study, params: Optional[List[str]]) → Dict[str, float][source]

Evaluate parameter importances based on completed trials in the given study.

Note

This method is not meant to be called by library users.

See also

Please refer to get_param_importances() for how a concrete evaluator should implement this method.

Parameters
  • study – An optimized study.

  • params – A list of names of parameters to assess. If None, all parameters that are present in all of the completed trials are assessed.

Returns

An collections.OrderedDict where the keys are parameter names and the values are assessed importances.