optuna.pruners.PercentilePruner

class optuna.pruners.PercentilePruner(percentile, n_startup_trials=5, n_warmup_steps=0, interval_steps=1, *, n_min_trials=1)[源代码]

用于保留指定百分位数的试验的 Pruner。

如果中间最佳值处于同一步试验的最低百分位数,则进行剪枝。

示例

import numpy as np
from sklearn.datasets import load_iris
from sklearn.linear_model import SGDClassifier
from sklearn.model_selection import train_test_split

import optuna

X, y = load_iris(return_X_y=True)
X_train, X_valid, y_train, y_valid = train_test_split(X, y)
classes = np.unique(y)


def objective(trial):
    alpha = trial.suggest_float("alpha", 0.0, 1.0)
    clf = SGDClassifier(alpha=alpha)
    n_train_iter = 100

    for step in range(n_train_iter):
        clf.partial_fit(X_train, y_train, classes=classes)

        intermediate_value = clf.score(X_valid, y_valid)
        trial.report(intermediate_value, step)

        if trial.should_prune():
            raise optuna.TrialPruned()

    return clf.score(X_valid, y_valid)


study = optuna.create_study(
    direction="maximize",
    pruner=optuna.pruners.PercentilePruner(
        25.0, n_startup_trials=5, n_warmup_steps=30, interval_steps=10
    ),
)
study.optimize(objective, n_trials=20)
参数:
  • percentile (float) – 百分位数,必须包含 0 和 100(例如,当给定 25.0 时,将保留 25% 百分位数试验中的最佳试验)。

  • n_startup_trials (int) – 在同一研究中,在给定数量的试验完成之前,禁用剪枝。

  • n_warmup_steps (int) – 在试验超过给定的步数之前,禁用剪枝。请注意,此功能假设 step 从零开始。

  • interval_steps (int) – 剪枝检查之间的步数间隔,偏移了预热步数。如果在剪枝检查时没有报告任何值,则该特定检查将推迟到报告值为止。值必须至少为 1。

  • n_min_trials (int) – 用于判断是否进行剪枝的、在同一步报告的试验结果的最小数量。如果当前步所有试验报告的中间值数量少于 n_min_trials,则该试验不会被剪枝。这可用于确保至少有一定数量的试验能够完成而不会被剪枝。

方法

prune(study, trial)

根据报告的值判断试验是否应被剪枝。

prune(study, trial)[源代码]

根据报告的值判断试验是否应被剪枝。

请注意,此方法不应由库用户调用。相反,optuna.trial.Trial.report()optuna.trial.Trial.should_prune() 提供了在目标函数中实现剪枝机制的用户界面。

参数:
  • study (Study) – 目标 study 的 study 对象。

  • trial (FrozenTrial) – 目标 trial 的 FrozenTrial 对象。修改此对象之前请复制一份。

返回:

一个布尔值,表示试验是否应被剪枝。

返回类型:

bool