Introducing Custom User Widget

[c-bata]

Contributor License Agreement

This repository (optuna-dashboard) and Goptuna share common code.
This pull request may therefore be ported to Goptuna.
Make sure that you understand the consequences concerning licenses and check the box below if you accept the term before creating this pull request.

• I agree this patch may be ported to Goptuna by other Goptuna contributors.

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Preferential Optimization

import optuna
from optuna.distributions import CategoricalDistribution
from optuna.distributions import FloatDistribution
from optuna_dashboard import ObjectiveChoiceWidget
from optuna_dashboard import register_objective_form_widgets
from optuna_dashboard import set_objective_names
from optuna_dashboard._app import create_app


host = "127.0.0.1"
port = 8080


def create_optuna_storage() -> optuna.storages.InMemoryStorage:
    storage = optuna.storages.InMemoryStorage()

    study = optuna.create_study(study_name="Preferential Optimization", storage=storage, directions=["minimize"])
    set_objective_names(study, ["Human Perception"])
    register_objective_form_widgets(study, widgets=[
        ObjectiveChoiceWidget(
            choices=["Good 👍", "Bad 👎"],
            values=[-1, 1],
            description="Choose Good 👍 or Bad 👎.",
        ),
    ])

    # Sample new parameters
    study.ask({"x": FloatDistribution(0, 10), "y": CategoricalDistribution(["Foo", "Bar"])})

    return storage


def main() -> None:
    storage = create_optuna_storage()
    app = create_app(storage, debug=True)
    app.run(host=host, port=port, reloader=True)


if __name__ == "__main__":
    main()

More complex example

import optuna
from optuna.distributions import CategoricalDistribution
from optuna.distributions import FloatDistribution
from optuna_dashboard import ObjectiveChoiceWidget, ObjectiveTextInputWidget, ObjectiveSliderWidget, \
    ObjectiveUserAttrRef
from optuna_dashboard import register_objective_form_widgets
from optuna_dashboard import set_objective_names
from optuna_dashboard._app import create_app


host = "127.0.0.1"
port = 8080


def create_optuna_storage() -> optuna.storages.InMemoryStorage:
    storage = optuna.storages.InMemoryStorage()

    study = optuna.create_study(study_name="objective-form-widgets", storage=storage, directions=["minimize", "minimize", "minimize", "minimize"])
    set_objective_names(study, ["Slider Objective", "Good or Bad", "Text Input Objective", "Validation Loss"])
    register_objective_form_widgets(study, widgets=[
        ObjectiveSliderWidget(
            min=0.0,
            max=1.0,
            step=0.1,
            #labels=[(0.0, "Better"), (0.5, "0.5"), (1.0, "Worse")],
            labels=[],
            description="Select a value.",
        ),
        ObjectiveChoiceWidget(
            choices=["Good 👍", "Bad 👎"],
            values=[-1, 1],
            description="Choose Good 👍 or Bad 👎.",
        ),
        ObjectiveTextInputWidget(
            description="Enter the objective value via TextInput.",
        ),
        ObjectiveUserAttrRef(
            key="val_loss",
        ),
    ])
    trial = study.ask({"x": FloatDistribution(0, 10), "y": CategoricalDistribution(["Foo", "Bar"])})
    trial.set_user_attr("val_loss", 0.2)
    study.ask({"x": FloatDistribution(0, 10), "y": CategoricalDistribution(["Foo", "Bar"])})
    trial.set_user_attr("val_loss", 0.5)

    return storage


def main() -> None:
    storage = create_optuna_storage()
    app = create_app(storage, debug=True)
    app.run(host=host, port=port, reloader=True)


if __name__ == "__main__":
    main()