optuna.storages.InMemoryStorage

class optuna.storages.InMemoryStorage[source]

Pythonプロセスのメモリ上にデータを保存するストレージクラス。

使用例

InMemoryStorage インスタンスの作成例。

import optuna

def objective(trial):
    x = trial.suggest_float("x", -100, 100)
    return x**2

storage = optuna.storages.InMemoryStorage()

study = optuna.create_study(storage=storage)
study.optimize(objective, n_trials=10)

メソッド一覧

`check_trial_is_updatable`(trial_id, trial_state)	Check whether a trial state is updatable.
`create_new_study`(directions[, study_name])	Create a new study from a name.
`create_new_trial`(study_id[, template_trial])	Create and add a new trial to a study.
`delete_study`(study_id)	Delete a study.
`get_all_studies`()	Read a list of `FrozenStudy` objects.
`get_all_trials`(study_id[, deepcopy, states])	Read all trials in a study.
`get_best_trial`(study_id)	Return the trial with the best value in a study.
`get_n_trials`(study_id[, state])	Count the number of trials in a study.
`get_study_directions`(study_id)	Read whether a study maximizes or minimizes an objective.
`get_study_id_from_name`(study_name)	Read the ID of a study.
`get_study_name_from_id`(study_id)	Read the study name of a study.
`get_study_system_attrs`(study_id)	Read the optuna-internal attributes of a study.
`get_study_user_attrs`(study_id)	Read the user-defined attributes of a study.
`get_trial`(trial_id)	Read a trial.
`get_trial_id_from_study_id_trial_number`(...)	Read the trial ID of a trial.
`get_trial_number_from_id`(trial_id)	Read the trial number of a trial.
`get_trial_param`(trial_id, param_name)	Read the parameter of a trial.
`get_trial_params`(trial_id)	Read the parameter dictionary of a trial.
`get_trial_system_attrs`(trial_id)	Read the optuna-internal attributes of a trial.
`get_trial_user_attrs`(trial_id)	Read the user-defined attributes of a trial.
`remove_session`()	Clean up all connections to a database.
`set_study_system_attr`(study_id, key, value)	Register an optuna-internal attribute to a study.
`set_study_user_attr`(study_id, key, value)	Register a user-defined attribute to a study.
`set_trial_intermediate_value`(trial_id, step, ...)	Report an intermediate value of an objective function.
`set_trial_param`(trial_id, param_name, ...)	Set a parameter to a trial.
`set_trial_state_values`(trial_id, state[, values])	Update the state and values of a trial.
`set_trial_system_attr`(trial_id, key, value)	Set an optuna-internal attribute to a trial.
`set_trial_user_attr`(trial_id, key, value)	Set a user-defined attribute to a trial.

check_trial_is_updatable(trial_id, trial_state)

トライアルの状態が更新可能かどうかを確認します。

Parameters:

trial_id (int) – 対象トライアルのID。エラーメッセージの表示にのみ使用されます。
trial_state (TrialState) – 状態を確認するトライアル。

Raises:

UpdateFinishedTrialError – トライアルが既に終了している場合。

Return type:

None

create_new_study(directions, study_name=None)[source]

名前を指定して新しいスタディを作成します。

名前を指定しない場合、ストレージクラスが自動的に名前を生成します。返されるスタディIDは、現在および削除済みのスタディの中で一意です。

Parameters:

directions (Sequence[StudyDirection]) – 要素が MAXIMIZE または MINIMIZE のいずれかである方向のシーケンス。
study_name (str | None) – 作成する新しいスタディの名前。

Returns:

作成されたスタディのID。

Raises:

optuna.exceptions.DuplicatedStudyError – 同じ study_name のスタディが既に存在する場合。

Return type:

int

create_new_trial(study_id, template_trial=None)[source]

スタディに新しいトライアルを作成して追加します。

返されるトライアルIDは、現在および削除済みのトライアルの中で一意です。

Parameters:

study_id (int) – 対象スタディのID。
template_trial (FrozenTrial | None) – デフォルトのユーザ属性、システム属性、中間値、および状態を持つテンプレート FrozenTrial。

Returns:

作成されたトライアルのID。

Raises:

KeyError – 指定された study_id のスタディが存在しない場合。

Return type:

int

delete_study(study_id)[source]

スタディを削除します。

Parameters:: study_id (int) – 対象スタディのID。
Raises:: KeyError – 指定された study_id のスタディが存在しない場合。
Return type:: None

get_all_studies()[source]

FrozenStudy オブジェクトのリストを取得します。

Returns:: study_id でソートされた FrozenStudy オブジェクトのリスト。
Return type:: list[FrozenStudy]

get_all_trials(study_id, deepcopy=True, states=None)[source]

スタディ内のすべてのトライアルを取得します。

Parameters:

study_id (int) – 対象スタディのID。
deepcopy (bool) – リストを返す前にコピーするかどうか。リストや要素を更新する場合に True に設定します。
states (Container[TrialState] | None) – フィルタするトライアル状態。None の場合、すべての状態を含めます。

Returns:

trial_id でソートされたスタディ内のトライアルリスト。

Raises:

KeyError – 指定された study_id のスタディが存在しない場合。

Return type:

list[FrozenTrial]

get_best_trial(study_id)[source]

スタディ内で最も良い値を持つトライアルを返します。

このメソッドは単一目的最適化の場合のみ有効です。

Parameters:

study_id (int) – 対象スタディのID。

Returns:

スタディ内のすべての終了トライアルの中で最も良い目的値を持つトライアル。

Raises:

KeyError – 指定された study_id のスタディが存在しない場合。
RuntimeError – スタディが複数の方向を持つ場合。
ValueError – 終了トライアルがない場合。

Return type:

FrozenTrial

get_n_trials(study_id, state=None)

スタディ内のトライアル数をカウントします。

Parameters:

study_id (int) – 対象スタディのID。
state (tuple[TrialState, ...] | TrialState | None) – フィルタするトライアル状態。None の場合、すべての状態を含めます。

Returns:

スタディ内のトライアル数。

Raises:

KeyError – 指定された study_id のスタディが存在しない場合。

Return type:

int

get_study_directions(study_id)[source]

スタディが目的値を最大化または最小化するかを取得します。

Parameters:: study_id (int) – 対象スタディのID。
Returns:: スタディの最適化方向リスト。
Raises:: KeyError – 指定された study_id のスタディが存在しない場合。
Return type:: list[StudyDirection]

get_study_id_from_name(study_name)[source]

スタディのIDを取得します。

Parameters:: study_name (str) – 対象スタディの名前。
Returns:: スタディのID。
Raises:: KeyError – 指定された study_name のスタディが存在しない場合。
Return type:: int

get_study_name_from_id(study_id)[source]

スタディの名前を取得します。

Parameters:: study_id (int) – 対象スタディのID。
Returns:: スタディの名前。
Raises:: KeyError – 指定された study_id のスタディが存在しない場合。
Return type:: str

get_study_system_attrs(study_id)[source]

スタディの内部属性を取得します。

Parameters:: study_id (int) – 対象スタディのID。
Returns:: スタディの内部属性を含む辞書。
Raises:: KeyError – 指定された study_id のスタディが存在しない場合。
Return type:: dict[str, Any]

get_study_user_attrs(study_id)[source]

スタディのユーザー定義属性を取得します。

Parameters:: study_id (int) – 対象スタディのID。
Returns:: スタディのユーザー属性を含む辞書。
Raises:: KeyError – 指定された study_id のスタディが存在しない場合。
Return type:: dict[str, Any]

get_trial(trial_id)[source]

トライアルを取得します。

Parameters:: trial_id (int) – 対象トライアルのID。
Returns:: 指定された trial_id のトライアル。
Raises:: KeyError – 指定された trial_id のトライアルが存在しない場合。
Return type:: FrozenTrial

get_trial_id_from_study_id_trial_number(study_id, trial_number)[source]

トライアルのIDを取得します。

Parameters:

study_id (int) – 対象スタディのID。
trial_number (int) – 対象トライアルの番号。

Returns:

指定された study_id と trial_number のトライアルID。

Raises:

KeyError – 指定された study_id と trial_number のトライアルが存在しない場合。

Return type:

int

get_trial_number_from_id(trial_id)[source]

トライアルの番号を取得します。

Note

トライアル番号はスタディ内で一意であり、連番です。

Parameters:: trial_id (int) – 対象トライアルのID。
Returns:: トライアルの番号。
Raises:: KeyError – 指定された trial_id のトライアルが存在しない場合。
Return type:: int

get_trial_param(trial_id, param_name)[source]

トライアルのパラメータを取得します。

Parameters:

trial_id (int) – 対象トライアルのID。
param_name (str) – 対象パラメータの名前。

Returns:

パラメータの内部表現。

Raises:

KeyError – 指定された trial_id のトライアルが存在しない場合。

Return type:

float

パラメータが存在しない場合。

get_trial_params(trial_id)

トライアルのパラメータ辞書を取得します。

Parameters:: trial_id (int) – 対象トライアルのID。
Returns:: パラメータの辞書。キーはパラメータ名、値は外部表現されたパラメータ値。
Raises:: KeyError – 指定された trial_id のトライアルが存在しない場合。
Return type:: dict[str, Any]

get_trial_system_attrs(trial_id)

トライアルの内部属性を取得します。

Parameters:: trial_id (int) – 対象トライアルのID。
Returns:: トライアルの内部属性辞書。
Raises:: KeyError – 指定された trial_id のトライアルが存在しない場合。
Return type:: dict[str, Any]

get_trial_user_attrs(trial_id)

トライアルのユーザー定義属性を取得します。

Parameters:: trial_id (int) – 対象トライアルのID。
Returns:: トライアルのユーザー定義属性辞書。
Raises:: KeyError – 指定された trial_id のトライアルが存在しない場合。
Return type:: dict[str, Any]

remove_session()

データベースへの接続をすべて切断します。

Return type:: None

set_study_system_attr(study_id, key, value)[source]

スタディに内部属性を登録します。

このメソッドは既存の属性を上書きします。

Parameters:

study_id (int) – 対象スタディのID。
key (str) – 属性キー。
value (Mapping[str, JSONSerializable] | Sequence[JSONSerializable] | str | int | float | bool | None) – 属性値。JSONシリアライズ可能である必要があります。

Raises:

KeyError – 指定された study_id のスタディが存在しない場合。

Return type:

None

set_study_user_attr(study_id, key, value)[source]

スタディにユーザー定義属性を登録します。

このメソッドは既存の属性を上書きします。

Parameters:

study_id (int) – 対象スタディのID。
key (str) – 属性キー。
value (Any) – 属性値。JSONシリアライズ可能である必要があります。

Raises:

KeyError – 指定された study_id のスタディが存在しない場合。

Return type:

None

set_trial_intermediate_value(trial_id, step, intermediate_value)[source]

目的関数の中間値を報告します。

このメソッドは指定されたステップに関連付けられた既存の中間値を上書きします。

Parameters:

trial_id (int) – 対象トライアルのID。
step (int) – トライアルのステップ（例：ニューラルネットワークのエポック数）。
intermediate_value (float) – ステップに対応する中間値。

Raises:

KeyError – 指定された trial_id のトライアルが存在しない場合。
UpdateFinishedTrialError – トライアルが既に終了している場合。

Return type:

None

set_trial_param(trial_id, param_name, param_value_internal, distribution)[source]

トライアルにパラメータを設定します。

Parameters:

trial_id (int) – 対象トライアルのID。
param_name (str) – パラメータ名。
param_value_internal (float) – パラメータ値の内部表現。
distribution (BaseDistribution) – パラメータのサンプリング分布。

Raises:

KeyError – 指定された trial_id のトライアルが存在しない場合。
UpdateFinishedTrialError – トライアルが既に終了している場合。

Return type:

None

set_trial_state_values(trial_id, state, values=None)[source]

トライアルの状態と値を更新します。

目的関数の戻り値を values 引数に設定します。 values 引数が None でない場合、このメソッドは既存のトライアル値を上書きします。

Parameters:

trial_id (int) – 対象トライアルのID。
state (TrialState) – トライアルの新しい状態。
values (Sequence[float] | None) – 目的関数の値。

Returns:

状態が正常に更新された場合は True。状態が変更されなかった場合は False。この場合、RUNNING 状態のトライアルを RUNNING 状態に更新しようとした場合に発生します。

Raises:

KeyError – 指定された trial_id のトライアルが存在しない場合。
UpdateFinishedTrialError – トライアルが既に終了している場合。

Return type:

bool

set_trial_system_attr(trial_id, key, value)[source]

トライアルに内部属性を設定します。

このメソッドは既存の属性を上書きします。

Parameters:

trial_id (int) – 対象トライアルのID。
key (str) – 属性キー。
value (Mapping[str, JSONSerializable] | Sequence[JSONSerializable] | str | int | float | bool | None) – 属性値。JSONシリアライズ可能である必要があります。

Raises:

KeyError – 指定された trial_id のトライアルが存在しない場合。
UpdateFinishedTrialError – トライアルが既に終了している場合。

Return type:

None

set_trial_user_attr(trial_id, key, value)[source]

トライアルにユーザー定義属性を設定します。

このメソッドは既存の属性を上書きします。

Parameters:

trial_id (int) – 対象トライアルのID。
key (str) – 属性キー。
value (Any) – 属性値。JSONシリアライズ可能である必要があります。

Raises:

KeyError – 指定された trial_id のトライアルが存在しない場合。
UpdateFinishedTrialError – トライアルが既に終了している場合。

Return type:

None