API Reference

General APIs

optuna_dashboard.run_server	Start running optuna-dashboard and blocks until the server terminates.
optuna_dashboard.wsgi	This function exposes WSGI interface for people who want to run on the production-class WSGI servers like Gunicorn or uWSGI.
optuna_dashboard.set_objective_names	Set the names of objectives.
optuna_dashboard.save_note	Save the note (Markdown format) to the Study or Trial.

Human-in-the-loop

optuna_dashboard.register_objective_form_widgets	Register a list of form widgets to an Optuna study.
optuna_dashboard.register_user_attr_form_widgets	Register a list of form widgets to an Optuna study.
optuna_dashboard.dict_to_form_widget	Restore form widget objects from the dictionary.
optuna_dashboard.ChoiceWidget	A widget representing a choice with associated values.
optuna_dashboard.SliderWidget	A widget representing a slider for selecting a value within a range.
optuna_dashboard.TextInputWidget	A text input widget class that defines a text input field.
optuna_dashboard.ObjectiveUserAttrRef	A class representing a reference to a value of trial.user_attrs.

Artifact

optuna_dashboard.artifact.upload_artifact	Upload an artifact (files), which is associated with the trial.
optuna_dashboard.artifact.file_system.FileSystemBackend	An artifact backend for file systems.
optuna_dashboard.artifact.boto3.Boto3Backend	An artifact backend for S3.