optuna_dashboard.streamlit.render_objective_form_widgets

optuna_dashboard.streamlit.render_objective_form_widgets(study, trial, on_success_callback=None)

Render user input widgets to UI with streamlit.

Submitted values to the forms are telled to optuna trial object. All submitted values should be float. Multiple widgets correspond to multi-objective optimization.

Parameters:
  • study (optuna.Study) – The optuna study object to get widget specification.

  • trial (FrozenTrial) – The optuna trial object to tell user feedbacks.

  • on_success_callback (Optional[Callable[[], None]]) – The callback function which will be executed when feedback submission is succeeded.

Raises:
  • ValueError – If No form widgets registered.

  • ValueError – If ‘output_type’ of form widgets is not ‘objective’.

  • ValueError – If any submitted values cannot be converted to float.

Return type:

None