optuna-dashboard

软件许可证

:link: 网站 | :page_with_curl: 文档 | :gear: 安装指南 | :pencil: 教程 | :bulb: 示例

Optuna的实时仪表板。代码文件最初来自Goptuna。

安装

你可以通过PyPI或Anaconda Cloud安装optuna-dashboard。

$ pip install optuna-dashboard

入门

首先，请使用RDB后端指定存储URL以持久化你的研究。

import optuna

def objective(trial):
    x = trial.suggest_float("x", -100, 100)
    y = trial.suggest_categorical("y", [-1, 0, 1])
    return x**2 + y

if __name__ == "__main__":
    study = optuna.create_study(
        storage="sqlite:///db.sqlite3",  # 在此处指定存储URL。
        study_name="quadratic-simple"
    )
    study.optimize(objective, n_trials=100)
    print(f"最佳值：{study.best_value}（参数：{study.best_params}）")

运行上述脚本后，请使用Optuna存储URL执行optuna-dashboard命令。

$ optuna-dashboard sqlite:///db.sqlite3
正在监听 http://localhost:8080/
按Ctrl-C退出。

请查看我们的文档以获取更多详细信息。

使用官方Docker镜像

你也可以使用官方Docker镜像，而不是设置Python环境。 Docker镜像仅支持SQLite3、MySQL(PyMySQL)和PostgreSQL(Psycopg2)。

$ docker run -it --rm -p 8080:8080 -v `pwd`:/app -w /app \
> ghcr.io/optuna/optuna-dashboard sqlite:///db.sqlite3

MySQL (PyMySQL)

$ docker run -it --rm -p 8080:8080 ghcr.io/optuna/optuna-dashboard mysql+pymysql://username:password@hostname:3306/dbname

PostgreSQL (Psycopg2)

$ docker run -it --rm -p 8080:8080 ghcr.io/optuna/optuna-dashboard postgresql+psycopg2://username:password@hostname:5432/dbname

Jupyter Lab扩展（实验性）

你可以通过PyPI安装Jupyter Lab扩展。

$ pip install jupyterlab jupyterlab-optuna

使用时，点击图标启动扩展，并在对话框中输入你的Optuna存储URL（例如sqlite:///db.sqlite3）。

仅浏览器版本（实验性）

我们开发了一个完全在Web浏览器中运行的版本，内部使用SQLite3 Wasm和Rust。无需安装Python或任何其他依赖。只需在浏览器中打开以下URL，将你的SQLite3文件拖放到页面上，即可查看你的Optuna研究！

https://optuna.github.io/optuna-dashboard/

请注意，只有部分功能可用。但你仍然可以在图表和表格中查看优化历史、超参数重要性等。

VS Code和code-server扩展（实验性）

你可以通过Visual Studio Marketplace安装VS Code扩展，或通过Open VSX安装code-server扩展。

请在VS Code文件资源管理器中右键单击SQLite3文件（*.db或*.sqlite3），并从下拉菜单中选择"在Optuna Dashboard中打开"命令。此扩展利用了Optuna Dashboard的仅浏览器版本，因此存在相同的限制。

提交补丁

如果你想贡献，请查看开发者指南。