wassname/optuna-dashboard
1
0 Fork 0
mirror of https://github.com/wassname/optuna-dashboard.git synced 2026-10-05 13:00:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix some mypy error

Browse Source
This commit is contained in:
cross32768 committed 2023-06-30 13:59:01 +09:00
1 parent 9eeffba342
commit 5645ca5393
1 file changed
+89 -37
Download Patch File Download Diff File Expand all files Collapse all files
optuna_dashboard/_streamlit_helper.py
+89 -37
View File
@@ -4,7 +4,10 @@ import optuna
from optuna.trial import FrozenTrial
import streamlit as st
from ._form_widget import ChoiceWidgetJSON
from ._form_widget import get_form_widgets_json
from ._form_widget import SliderWidgetJSON
from ._form_widget import TextInputWidgetJSON
from ._note import get_note_from_system_attrs
@@ -19,44 +22,22 @@ def render_trial_note(study: optuna.Study, trial: FrozenTrial) -> None:
st.markdown(note["body"], unsafe_allow_html=True)
def render_user_attr_form_widgets(study: optuna.Study, trial: FrozenTrial) -> None:
"""Render user input widgets to UI with streamlit.
Submitted values to the forms are registered as each trial's user_attrs.
Args:
study: The optuna study object to get widget specification.
trial: The optuna trial object to tell user feedbacks.
Raises:
ValueError: If No form widgets registered.
ValueError: If 'output_type' of form widgets is not 'user_attr'.
ValueError: If any widget["type"] is not in ["choice", "slider", "text"].
"""
form_widgets_dict = get_form_widgets_json(study.system_attrs)
if form_widgets_dict is None:
raise ValueError("No form widgets registered.")
if (
"output_type" not in form_widgets_dict.keys()
or form_widgets_dict["output_type"] != "user_attr"
):
raise ValueError("'output_type' should be 'user_attr'.")
widgets = form_widgets_dict["widgets"]
def _render_widgets(
widgets: list[ChoiceWidgetJSON | SliderWidgetJSON | TextInputWidgetJSON],
) -> tuple[bool, list[str]]:
values = []
with st.form("user_input", clear_on_submit=False):
for widget in widgets:
if widget["description"] is None: # type: ignore
if widget["description"] is None:
description = ""
else:
description = widget["description"] # type: ignore
description = widget["description"]
if widget["type"] == "choice":
value = st.radio(
description,
widget["values"],
format_func=lambda choice, widget=widget: widget["choices"][ # type: ignore
format_func=lambda choice, widget=widget: widget["choices"][
widget["values"].index(choice)
],
horizontal=True,
@@ -72,18 +53,89 @@ def render_user_attr_form_widgets(study: optuna.Study, trial: FrozenTrial) -> No
)
values.append(value)
elif widget["type"] == "text":
# TODO (kaitos): Resolve that current implementation ignores "optional"
# (always optional on streamlit)
values.append(st.text_input(description)) # type: ignore
# NOTE: Current implementation ignores "optional".
value = st.text_input(description)
values.append(value)
else:
raise ValueError("Widget type should be 'choice', 'slider', or 'text'.")
raise ValueError("Widget type should be 'choice', 'slider' or 'text'.")
submitted = st.form_submit_button("Submit")
return submitted, values
def render_user_attr_form_widgets(study: optuna.Study, trial: FrozenTrial) -> None:
"""Render user input widgets to UI with streamlit.
Submitted values to the forms are registered as each trial's user_attrs.
"type" of widgets should be "choice", "slider", or "text".
Args:
study: The optuna study object to get widget specification.
trial: The optuna trial object to save user feedbacks.
Raises:
ValueError: If No form widgets registered.
ValueError: If 'output_type' of form widgets is not 'user_attr'.
ValueError: If any widget['type'] is not in ['choice', 'slider', 'text'].
ValueError: if any widget does not have 'user_attr_key'.
"""
form_widgets_dict = get_form_widgets_json(study.system_attrs)
if form_widgets_dict is None:
raise ValueError("No form widgets registered.")
if form_widgets_dict["output_type"] != "user_attr":
raise ValueError("'output_type' should be 'user_attr'.")
widgets = form_widgets_dict["widgets"]
for widget in widgets:
if widget["type"] not in ["choice", "slider", "text"]:
raise ValueError("Widget type should be 'choice', 'slider' or 'text'.")
if widget["user_attr_key"] is None: # type: ignore
raise ValueError("Widget should have 'user_attr_key'.")
submitted, values = _render_widgets(widget) # type: ignore
if submitted:
for widget, value in zip(widgets, values):
if widget["user_attr_key"] is not None: # type: ignore
study._storage.set_trial_user_attr(
trial._trial_id, key=widget["user_attr_key"], value=value # type: ignore
)
study._storage.set_trial_user_attr(
trial._trial_id, key=widget["user_attr_key"], value=value # type: ignore
)
st.success("Submitted!")
def render_objective_form_widgets(study: optuna.Study, trial: FrozenTrial) -> None:
"""Render user input widgets to UI with streamlit.
Submitted values to the forms are telled to optuna trial object.
"type" of widgets should be "choice" or "slider".
Multiple widgets correspond to multi-objective optimization.
Args:
study: The optuna study object to get widget specification.
trial: The optuna trial object to tell user feedbacks.
Raises:
ValueError: If No form widgets registered.
ValueError: If 'output_type' of form widgets is not 'objective'.
ValueError: If any widget['type'] is not in ['choice', 'slider'].
"""
form_widgets_dict = get_form_widgets_json(study.system_attrs)
if form_widgets_dict is None:
raise ValueError("No form widgets registered.")
if form_widgets_dict["output_type"] != "user_attr":
raise ValueError("'output_type' should be 'user_attr'.")
widgets = form_widgets_dict["widgets"]
for widget in widgets:
if widget["type"] not in ["choice", "slider"]:
raise ValueError("Widget type should be 'choice' or 'slider'.")
submitted, values = _render_widgets(widgets) # type: ignore
if submitted:
study.tell(trial.number, values)
st.success("Submitted!")