plot_rank

optuna.visualization.matplotlib.plot_rank(study, params=None, *, target=None, target_name='目标值')[源代码]

绘制参数关系散点图,颜色表示目标值的排名。

请注意,缺少指定参数的试验将不会被绘制。

另请参阅

请参考 optuna.visualization.plot_rank() 获取示例。

参数:
  • study (Study) – 一个 Study 对象,其试验的目标值将被绘制。

  • params (list[str] | None) – 要可视化的参数列表。默认为所有参数。

  • target (Callable[[FrozenTrial], float] | None) –

    一个用于指定要显示值的函数。如果为 None 并且 study 用于单目标优化,则绘制目标值。

    注意

    如果 study 用于多目标优化,请指定此参数。

  • target_name (str) – 要显示在颜色条上的目标名称。

返回:

一个 matplotlib.axes.Axes 对象。

返回类型:

Axes

注意

在 v3.2.0 中作为实验性功能添加。该接口可能在更高版本中更改,恕不另行通知。请参阅 https://github.com/optuna/optuna/releases/tag/v3.2.0

以下代码片段展示了如何将参数关系绘制为排名图。

Rank (Objective Value)
/home/docs/checkouts/readthedocs.org/user_builds/optuna/envs/stable/lib/python3.12/site-packages/optuna/_experimental.py:31: ExperimentalWarning:

Argument ``constraints_func`` is an experimental feature. The interface can change in the future.

/home/docs/checkouts/readthedocs.org/user_builds/optuna/checkouts/stable/docs/visualization_matplotlib_examples/optuna.visualization.matplotlib.rank.py:33: ExperimentalWarning:

plot_rank is experimental (supported from v3.2.0). The interface can change in the future.


<Axes: title={'center': 'Rank (Objective Value)'}, xlabel='x', ylabel='y'>

import optuna


def objective(trial):
    x = trial.suggest_float("x", -100, 100)
    y = trial.suggest_categorical("y", [-1, 0, 1])

    c0 = 400 - (x + y) ** 2
    trial.set_user_attr("constraint", [c0])

    return x**2 + y


def constraints(trial):
    return trial.user_attrs["constraint"]


sampler = optuna.samplers.TPESampler(seed=10, constraints_func=constraints)
study = optuna.create_study(sampler=sampler)
study.optimize(objective, n_trials=30)

optuna.visualization.matplotlib.plot_rank(study, params=["x", "y"])

脚本总运行时间: (0 分钟 0.177 秒)

Gallery generated by Sphinx-Gallery