Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs #4732

Merged
merged 1 commit into from
Jun 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions optuna/samplers/_nsgaiii.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,14 @@ class NSGAIIISampler(BaseSampler):
`target` points since the algorithm prioritizes individuals around reference points.

dividing_parameter:
An parameter to determine the density of default reference points. This parameter
A parameter to determine the density of default reference points. This parameter
determines how many divisions are made between reference points on each axis. The
smaller this value is, the less reference points you have. The default value is 3.
Note that this parameter is not used when ``reference_points`` is not :obj:`None`.

.. note::
Other parameters than ``reference_points`` and ``dividing_parameter`` are the same as
:class:`~optuna.samplers.nsgaii.NSGAIISampler`.
:class:`~optuna.samplers.NSGAIISampler`.

"""

Expand Down
2 changes: 1 addition & 1 deletion optuna/terminator/callback.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class TerminatorCallback:
A terminator object which determines whether to terminate the optimization by
assessing the room for optimization and statistical error. Defaults to a
:class:`~optuna.terminator.Terminator` object with default
improvement_evaluator and error_evaluator.
``improvement_evaluator`` and ``error_evaluator``.

Example:

Expand Down
2 changes: 1 addition & 1 deletion optuna/terminator/erroreval.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def evaluate(

Args:
trials:
A list of trials to consider. The best trial in `trials` is used to compute the
A list of trials to consider. The best trial in ``trials`` is used to compute the
statistical error.

study_direction:
Expand Down
2 changes: 1 addition & 1 deletion optuna/terminator/terminator.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ class Terminator(BaseTerminator):
break

.. seealso::
Please refer to :class:`~optuna.terminator.TerminationCallback` for how to use
Please refer to :class:`~optuna.terminator.TerminatorCallback` for how to use
the terminator mechanism with the :func:`~optuna.study.Study.optimize` method.

"""
Expand Down
6 changes: 3 additions & 3 deletions optuna/visualization/_terminator_improvement.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ def plot_terminator_improvement(
"""Plot the potentials for future objective improvement.

This function visualizes the objective improvement potentials, evaluated
with `improvement_evaluator`.
with ``improvement_evaluator``.
It helps to determine whether we should continue the optimization or not.
You can also plot the error evaluated with
`error_evaluator` if the `plot_error` argument is set to :obj:`True`.
``error_evaluator`` if the ``plot_error`` argument is set to :obj:`True`.
Note that this function may take some time to compute
the improvement potentials.

Expand Down Expand Up @@ -94,7 +94,7 @@ def objective(trial):
for their improvement.
plot_error:
A flag to show the error. If it is set to :obj:`True`, errors
evaluated by `error_evaluator` are also plotted as line graph.
evaluated by ``error_evaluator`` are also plotted as line graph.
Defaults to :obj:`False`.
improvement_evaluator:
An object that evaluates the improvement of the objective function.
Expand Down
6 changes: 3 additions & 3 deletions optuna/visualization/matplotlib/_terminator_improvement.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ def plot_terminator_improvement(
"""Plot the potentials for future objective improvement.

This function visualizes the objective improvement potentials, evaluated
with `improvement_evaluator`.
with ``improvement_evaluator``.
It helps to determine whether we should continue the optimization or not.
You can also plot the error evaluated with
`error_evaluator` if the `plot_error` argument is set to :obj:`True`.
``error_evaluator`` if the ``plot_error`` argument is set to :obj:`True`.
Note that this function may take some time to compute
the improvement potentials.

Expand Down Expand Up @@ -83,7 +83,7 @@ def objective(trial):
A :class:`~optuna.study.Study` object whose trials are plotted for their improvement.
plot_error:
A flag to show the error. If it is set to :obj:`True`, errors
evaluated by `error_evaluator` are also plotted as line graph.
evaluated by ``error_evaluator`` are also plotted as line graph.
Defaults to :obj:`False`.
improvement_evaluator:
An object that evaluates the improvement of the objective function.
Expand Down
Loading