API Reference
General APIs
Start running optuna-dashboard and blocks until the server terminates. |
|
This function exposes WSGI interface for people who want to run on the production-class WSGI servers like Gunicorn or uWSGI. |
|
Set the names of objectives. |
|
Save the note (Markdown format) to the Study or Trial. |
|
Save the user-defined plotly's graph object to the study. |
Human-in-the-loop
Form Widgets
Register a list of form widgets to an Optuna study. |
|
Register a list of form widgets to an Optuna study. |
|
Restore form widget objects from the dictionary. |
|
A widget representing a choice with associated values. |
|
A widget representing a slider for selecting a value within a range. |
|
A text input widget class that defines a text input field. |
|
A class representing a reference to a value of trial.user_attrs. |
Preferential Optimization
Like |
|
Like |
|
A Study-like class for preferential optimization. |
|
|
Sampler for preferential optimization using Gaussian process. |
Register a preference feedback component to the study. |
Streamlit
Write a trial note to UI with streamlit as a markdown format. |
|
Render user input widgets to UI with streamlit. |
|
Render user input widgets to UI with streamlit. |
Artifact
Upload an artifact (files), which is associated with the trial. |
|
An artifact backend for file systems. |
|
An artifact backend for S3. |
|
An artifact backend middleware for exponential backoff. |
|
An artifact backend middleware that appends a prefix string to artifact ids. |
|
A protocol defining the interface for an artifact backend. |
|
Exception raised when an artifact is not found. |