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)	检查试验状态是否可更新。
`create_new_study`(directions[, study_name])	从名称创建一个新的研究。
`create_new_trial`(study_id[, template_trial])	创建新试验并添加到研究中。
`delete_study`(study_id)	删除研究。
`get_all_studies`()	读取 FrozenStudy 对象列表。
`get_all_trials`(study_id[, deepcopy, states])	读取研究中的所有试验。
`get_best_trial`(study_id)	返回研究中具有最佳值的试验。
`get_n_trials`(study_id[, state])	计算研究中的试验数量。
`get_study_directions`(study_id)	读取研究是最大化还是最小化目标。
`get_study_id_from_name`(study_name)	读取研究的ID。
`get_study_name_from_id`(study_id)	读取研究的研究名称。
`get_study_system_attrs`(study_id)	读取研究的Optuna内部属性。
`get_study_user_attrs`(study_id)	读取研究的用户定义属性。
`get_trial`(trial_id)	读取试验。
`get_trial_id_from_study_id_trial_number`(...)	读取试验的试验ID。
`get_trial_number_from_id`(trial_id)	读取试验的试验编号。
`get_trial_param`(trial_id, param_name)	读取试验的参数。
`get_trial_params`(trial_id)	读取试验的参数字典。
`get_trial_system_attrs`(trial_id)	读取试验的Optuna内部属性。
`get_trial_user_attrs`(trial_id)	读取试验的用户定义属性。
`remove_session`()	清理与数据库的所有连接。
`set_study_system_attr`(study_id, key, value)	注册Optuna内部属性到研究。
`set_study_user_attr`(study_id, key, value)	注册用户定义属性到研究。
`set_trial_intermediate_value`(trial_id, step, ...)	报告目标函数的中间值。
`set_trial_param`(trial_id, param_name, ...)	设置试验的参数。
`set_trial_state_values`(trial_id, state[, values])	更新试验的状态和值。
`set_trial_system_attr`(trial_id, key, value)	设置Optuna内部属性到试验。
`set_trial_user_attr`(trial_id, key, value)	设置用户定义属性到试验。

check_trial_is_updatable(trial_id, trial_state)

检查试验状态是否可更新。

参数:

trial_id (int) – 试验的ID。仅用于错误消息。
trial_state (TrialState) – 要检查的试验状态。

引发异常:

UpdateFinishedTrialError – 如果试验已完成。

返回类型:

None

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

从名称创建一个新的研究。

如果未指定名称，存储类将生成一个名称。返回的研究ID在所有当前和已删除的研究中是唯一的。

参数:

directions (Sequence[StudyDirection]) – 一个方向序列，其元素为 MAXIMIZE 或 MINIMIZE。
study_name (str | None) – 要创建的新研究的名称。

返回:

创建的研究的ID。

引发异常:

optuna.exceptions.DuplicatedStudyError – 如果已存在具有相同 study_name 的研究。

返回类型:

int

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

创建新试验并添加到研究中。

返回的试验ID在所有当前和已删除的试验中是唯一的。

参数:

study_id (int) – 研究的ID。
template_trial (FrozenTrial | None) – 带有默认用户属性、系统属性、中间值和状态的 FrozenTrial 模板。

返回:

创建的试验的ID。

引发异常:

KeyError – 如果不存在匹配 study_id 的研究。

返回类型:

int

delete_study(study_id)[source]

删除研究。

参数:: study_id (int) – 研究的ID。
引发异常:: KeyError – 如果不存在匹配 study_id 的研究。
返回类型:: None

get_all_studies()[source]

读取 FrozenStudy 对象列表。

返回:: FrozenStudy 对象的列表，按 study_id 排序。
返回类型:: list[FrozenStudy]

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

读取研究中的所有试验。

参数:

study_id (int) – 研究的ID。
deepcopy (bool) – 返回前是否复制试验列表。如果您打算更新列表或列表中的元素，请设置为 True。
states (Container[TrialState] | None) – 要过滤的试验状态。如果为 None，则包含所有状态。

返回:

研究中的试验列表，按 trial_id 排序。

引发异常:

KeyError – 如果不存在匹配 study_id 的研究。

返回类型:

list[FrozenTrial]

get_best_trial(study_id)[source]

返回研究中具有最佳值的试验。

此方法仅在单目标优化期间有效。

参数:

study_id (int) – 研究的ID。

返回:

研究中所有已完成试验中具有最佳目标值的试验。

引发异常:

KeyError – 如果不存在匹配 study_id 的研究。
RuntimeError – 如果研究有多个方向。
ValueError – 如果没有试验已完成。

返回类型:

FrozenTrial

get_n_trials(study_id, state=None)

计算研究中的试验数量。

参数:

study_id (int) – 研究的ID。
state (tuple[TrialState, ...] | TrialState | None) – 要过滤的试验状态。如果为 None，则包含所有状态。

返回:

研究中的试验数量。

引发异常:

KeyError – 如果不存在匹配 study_id 的研究。

返回类型:

int

get_study_directions(study_id)[source]

读取研究是最大化还是最小化目标。

参数:: study_id (int) – 研究的ID。
返回:: 研究的优化方向列表。
引发异常:: KeyError – 如果不存在匹配 study_id 的研究。
返回类型:: list[StudyDirection]

get_study_id_from_name(study_name)[source]

读取研究的ID。

参数:: study_name (str) – 研究的名称。
返回:: 研究的ID。
引发异常:: KeyError – 如果不存在匹配 study_name 的研究。
返回类型:: int

get_study_name_from_id(study_id)[source]

读取研究的研究名称。

参数:: study_id (int) – 研究的ID。
返回:: 研究的名称。
引发异常:: KeyError – 如果不存在匹配 study_id 的研究。
返回类型:: str

get_study_system_attrs(study_id)[source]

读取研究的Optuna内部属性。

参数:: study_id (int) – 研究的ID。
返回:: 包含研究的optuna内部属性的字典。
引发异常:: KeyError – 如果不存在匹配 study_id 的研究。
返回类型:: dict[str, Any]

get_study_user_attrs(study_id)[source]

读取研究的用户定义属性。

参数:: study_id (int) – 研究的ID。
返回:: 包含研究的用户属性的字典。
引发异常:: KeyError – 如果不存在匹配 study_id 的研究。
返回类型:: dict[str, Any]

get_trial(trial_id)[source]

读取试验。

参数:: trial_id (int) – 试验的ID。
返回:: 具有匹配试验ID的试验。
引发异常:: KeyError – 如果不存在匹配 trial_id 的试验。
返回类型:: FrozenTrial

get_trial_id_from_study_id_trial_number(study_id, trial_number)[source]

读取试验的试验ID。

参数:

study_id (int) – 研究的ID。
trial_number (int) – 试验的编号。

返回:

试验的ID。

引发异常:

KeyError – 如果不存在匹配 study_id 和 trial_number 的试验。

返回类型:

int

get_trial_number_from_id(trial_id)[source]

读取试验的试验编号。

注意

试验编号在研究中是唯一的，并且是顺序的。

参数:: trial_id (int) – 试验的ID。
返回:: 试验的编号。
引发异常:: KeyError – 如果不存在匹配 trial_id 的试验。
返回类型:: int

get_trial_param(trial_id, param_name)[source]

读取试验的参数。

参数:

trial_id (int) – 试验的ID。
param_name (str) – 参数的名称。

返回:

参数的内部表示。

引发异常:

KeyError – 如果不存在匹配 trial_id 的试验。如果参数不存在。

返回类型:

float

get_trial_params(trial_id)

读取试验的参数字典。

参数:: trial_id (int) – 试验的ID。
返回:: 参数字典。键是参数名称，值是参数值的外部表示。
引发异常:: KeyError – 如果不存在匹配 trial_id 的试验。
返回类型:: dict[str, Any]

get_trial_system_attrs(trial_id)

读取试验的Optuna内部属性。

参数:: trial_id (int) – 试验的ID。
返回:: 包含试验的optuna内部属性的字典。
引发异常:: KeyError – 如果不存在匹配 trial_id 的试验。
返回类型:: dict[str, Any]

get_trial_user_attrs(trial_id)

读取试验的用户定义属性。

参数:: trial_id (int) – 试验的ID。
返回:: 包含试验的用户定义属性的字典。
引发异常:: KeyError – 如果不存在匹配 trial_id 的试验。
返回类型:: dict[str, Any]

remove_session()

清理与数据库的所有连接。

返回类型:: None

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

注册Optuna内部属性到研究。

此方法将覆盖任何现有属性。

参数:

study_id (int) – 研究的ID。
key (str) – 属性键。
value (Mapping[str, JSONSerializable] | Sequence[JSONSerializable] | str | int | float | bool | None) – 属性值。它应该是JSON可序列化的。

引发异常:

KeyError – 如果不存在匹配 study_id 的研究。

返回类型:

None

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

注册用户定义属性到研究。

此方法将覆盖任何现有属性。

参数:

study_id (int) – 研究的ID。
key (str) – 属性键。
value (Any) – 属性值。它应该是JSON可序列化的。

引发异常:

KeyError – 如果不存在匹配 study_id 的研究。

返回类型:

None

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

报告目标函数的中间值。

此方法将覆盖与给定步骤关联的任何现有中间值。

参数:

trial_id (int) – 试验的ID。
step (int) – 试验的步骤（例如，训练神经网络时的epoch）。
intermediate_value (float) – 对应于该步骤的中间值。

引发异常:

KeyError – 如果不存在匹配 trial_id 的试验。
UpdateFinishedTrialError – 如果试验已完成。

返回类型:

None

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

设置试验的参数。

参数:

trial_id (int) – 试验的ID。
param_name (str) – 参数的名称。
param_value_internal (float) – 参数值的内部表示。
distribution (BaseDistribution) – 参数的采样分布。

引发异常:

KeyError – 如果不存在匹配 trial_id 的试验。
UpdateFinishedTrialError – 如果试验已完成。

返回类型:

None

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

更新试验的状态和值。

将目标函数的返回值设置为 values 参数。如果 values 参数不是 None，此方法将覆盖任何现有的试验值。

参数:

trial_id (int) – 试验的ID。
state (TrialState) – 试验的新状态。
values (Sequence[float] | None) – 目标函数的值。

返回:

True 如果状态成功更新。 False 如果状态保持不变。后一种情况发生在此方法尝试将处于 RUNNING 状态的试验更新为 RUNNING 时。

引发异常:

KeyError – 如果不存在匹配 trial_id 的试验。
UpdateFinishedTrialError – 如果试验已完成。

返回类型:

bool

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

设置Optuna内部属性到试验。

此方法将覆盖任何现有属性。

参数:

trial_id (int) – 试验的ID。
key (str) – 属性键。
value (Mapping[str, JSONSerializable] | Sequence[JSONSerializable] | str | int | float | bool | None) – 属性值。它应该是JSON可序列化的。

引发异常:

KeyError – 如果不存在匹配 trial_id 的试验。
UpdateFinishedTrialError – 如果试验已完成。

返回类型:

None

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

设置用户定义属性到试验。

此方法将覆盖任何现有属性。

参数:

trial_id (int) – 试验的ID。
key (str) – 属性键。
value (Any) – 属性值。它应该是JSON可序列化的。

引发异常:

KeyError – 如果不存在匹配 trial_id 的试验。
UpdateFinishedTrialError – 如果试验已完成。

返回类型:

None