Skip to content

Commit

Permalink
Merge pull request optuna#4943 from cross32768/add_more_doc_for_fast_…
Browse files Browse the repository at this point in the history
…fanova

Add introduction of `optuna-fast-fanova` in documents
  • Loading branch information
c-bata authored Sep 26, 2023
2 parents a920a91 + ea3085e commit a1b43b2
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/source/reference/importance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ optuna.importance

The :mod:`~optuna.importance` module provides functionality for evaluating hyperparameter importances based on completed trials in a given study. The utility function :func:`~optuna.importance.get_param_importances` takes a :class:`~optuna.study.Study` and optional evaluator as two of its inputs. The evaluator must derive from :class:`~optuna.importance.BaseImportanceEvaluator`, and is initialized as a :class:`~optuna.importance.FanovaImportanceEvaluator` by default when not passed in. Users implementing custom evaluators should refer to either :class:`~optuna.importance.FanovaImportanceEvaluator` or :class:`~optuna.importance.MeanDecreaseImpurityImportanceEvaluator` as a guide, paying close attention to the format of the return value from the Evaluator's ``evaluate`` function.

.. note::

:class:`~optuna.importance.FanovaImportanceEvaluator` takes over 1 minute when given a study that contains 1000+ trials.
We published `optuna-fast-fanova <https://github.com/optuna/optuna-fast-fanova>`_ library,
that is a Cython accelerated fANOVA implementation. By using it, you can get hyperparameter
importances within a few seconds.

.. autosummary::
:toctree: generated/
Expand Down
8 changes: 8 additions & 0 deletions optuna/importance/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,14 @@ def get_param_importances(
assessment on.
Defaults to
:class:`~optuna.importance.FanovaImportanceEvaluator`.
.. note::
:class:`~optuna.importance.FanovaImportanceEvaluator` takes over 1 minute
when given a study that contains 1000+ trials. We published
`optuna-fast-fanova <https://github.com/optuna/optuna-fast-fanova>`_ library,
that is a Cython accelerated fANOVA implementation.
By using it, you can get hyperparameter importances within a few seconds.
params:
A list of names of parameters to assess.
If :obj:`None`, all parameters that are present in all of the completed trials are
Expand Down
8 changes: 8 additions & 0 deletions optuna/visualization/_param_importances.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,14 @@ def objective(trial):
assessment on.
Defaults to
:class:`~optuna.importance.FanovaImportanceEvaluator`.
.. note::
:class:`~optuna.importance.FanovaImportanceEvaluator` takes over 1 minute
when given a study that contains 1000+ trials. We published
`optuna-fast-fanova <https://github.com/optuna/optuna-fast-fanova>`_ library,
that is a Cython accelerated fANOVA implementation.
By using it, you can get hyperparameter importances within a few seconds.
params:
A list of names of parameters to assess.
If :obj:`None`, all parameters that are present in all of the completed trials are
Expand Down

0 comments on commit a1b43b2

Please sign in to comment.