optuna_dashboard.ObjectiveUserAttrRef

class optuna_dashboard.ObjectiveUserAttrRef(key)

A class representing a reference to a value of trial.user_attrs. When combined with register_objective_form_widgets, users can tell values that are registered to trial.user_attrs during the human-in-the-loop optimization.

Parameters:

key (str) – The key of trial.user_attrs being referenced.

Example

from optuna_dashboard import ObjectiveUserAttrRef


user_attr_ref = ObjectiveUserAttrRef(key="key")

Methods

to_dict()

Converts the ObjectiveUserAttrRef instance to a dictionary representation.

Attributes

key

to_dict()

Converts the ObjectiveUserAttrRef instance to a dictionary representation.

Returns:

The dictionary representation of the ObjectiveUserAttrRef instance.

Return type:

UserAttrRefJSON