optuna.trial.FixedTrial

class optuna.trial.FixedTrial(params, number=0)[source]

各パラメータに対して固定値を提案するトライアルクラス。

このオブジェクトは Trial と同じメソッドを持ち、事前に定義された パラメータ値を提案します。パラメータ値は FixedTrial オブジェクトの 構築時に決定されます。Trial とは異なり、FixedTrial は Study に依存せず、最適化結果のデプロイメントに有用です。

使用例

ユーザーが指定したパラメータ値で目的関数を評価する。

import optuna


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


assert objective(optuna.trial.FixedTrial({"x": 1, "y": 0})) == 1

Note

メソッドとプロパティの詳細については Trial を参照してください。

Parameters:

  • params (dict[str, Any]) – すべてのパラメータを含む辞書

  • number (int) – トライアル番号。デフォルトは 0

メソッド

report(value, step)

set_system_attr(key, value)

set_user_attr(key, value)

should_prune()

suggest_categorical()

suggest_discrete_uniform(name, low, high, q)

suggest_float(name, low, high, *[, step, log])

suggest_int(name, low, high, *[, step, log])

suggest_loguniform(name, low, high)

suggest_uniform(name, low, high)

属性

datetime_start

distributions

number

params

system_attrs

user_attrs

set_system_attr(key, value)[source]

Warning

v3.1.0 で非推奨。この機能は将来削除される予定です。現在の削除予定は v5.0.0 ですが、 このスケジュールは変更される可能性があります。詳細は https://github.com/optuna/optuna/releases/tag/v3.1.0 を参照してください。

Parameters:
Return type:

None

suggest_discrete_uniform(name, low, high, q)[source]

Warning

v3.0.0 で非推奨。この機能は将来削除される予定です。現在の削除予定は v6.0.0 ですが、 このスケジュールは変更される可能性があります。詳細は https://github.com/optuna/optuna/releases/tag/v3.0.0 を参照してください。

suggest_float(…, step=…) を使用してください。

Parameters:
Return type:

float

suggest_loguniform(name, low, high)[source]

Warning

v3.0.0 で非推奨。この機能は将来削除される予定です。現在の削除予定は v6.0.0 ですが、 このスケジュールは変更される可能性があります。詳細は https://github.com/optuna/optuna/releases/tag/v3.0.0 を参照してください。

suggest_float(…, log=True) を使用してください。

Parameters:
Return type:

float

suggest_uniform(name, low, high)[source]

Warning

v3.0.0 で非推奨。この機能は将来削除される予定です。現在の削除予定は v6.0.0 ですが、 このスケジュールは変更される可能性があります。詳細は https://github.com/optuna/optuna/releases/tag/v3.0.0 を参照してください。

suggest_float を使用してください。

Parameters:
Return type:

float