{"id":27615388,"url":"https://github.com/optuna/optuna-dashboard","last_synced_at":"2025-04-23T03:03:44.697Z","repository":{"id":38254302,"uuid":"306847592","full_name":"optuna/optuna-dashboard","owner":"optuna","description":"Real-time Web Dashboard for Optuna.","archived":false,"fork":false,"pushed_at":"2025-03-26T02:21:22.000Z","size":16590,"stargazers_count":585,"open_issues_count":26,"forks_count":95,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-26T03:23:56.094Z","etag":null,"topics":["dashboard","hyperparameter-optimization","optuna"],"latest_commit_sha":null,"homepage":"https://optuna-dashboard.readthedocs.io/en/latest/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/optuna.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"optuna"}},"created_at":"2020-10-24T09:19:45.000Z","updated_at":"2025-03-26T02:21:25.000Z","dependencies_parsed_at":"2023-09-22T21:14:06.808Z","dependency_job_id":"4381aa24-fc34-4681-81dc-c12e54906ea8","html_url":"https://github.com/optuna/optuna-dashboard","commit_stats":{"total_commits":863,"total_committers":22,"mean_commits":39.22727272727273,"dds":"0.26419466975666284","last_synced_commit":"8a9904de699461a061ca55fe157106fcfa8d2eeb"},"previous_names":[],"tags_count":51,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/optuna%2Foptuna-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/optuna%2Foptuna-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/optuna%2Foptuna-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/optuna%2Foptuna-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/optuna","download_url":"https://codeload.github.com/optuna/optuna-dashboard/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250360479,"owners_count":21417720,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dashboard","hyperparameter-optimization","optuna"],"created_at":"2025-04-23T03:02:16.711Z","updated_at":"2025-04-23T03:03:44.690Z","avatar_url":"https://github.com/optuna.png","language":"TypeScript","funding_links":["https://github.com/sponsors/optuna"],"categories":["others"],"sub_categories":[],"readme":"# optuna-dashboard\n\n![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/optuna-dashboard)](https://pypistats.org/packages/optuna-dashboard)\n[![Read the Docs](https://readthedocs.org/projects/optuna-dashboard/badge/?version=latest)](https://optuna-dashboard.readthedocs.io/en/latest/?badge=latest)\n[![Codecov](https://codecov.io/gh/optuna/optuna-dashboard/branch/main/graph/badge.svg)](https://codecov.io/gh/optuna/optuna-dashboard)\n\n:link: [**Website**](https://optuna.org/)\n| :page_with_curl: [**Docs**](https://optuna-dashboard.readthedocs.io/en/stable/)\n| :gear: [**Install Guide**](https://optuna-dashboard.readthedocs.io/en/stable/getting-started.html#installation)\n| :pencil: [**Tutorial**](https://optuna-dashboard.readthedocs.io/en/stable/tutorials/index.html)\n| :bulb: [**Examples**](https://github.com/optuna/optuna-examples/tree/main/dashboard)\n\nReal-time dashboard for [Optuna](https://github.com/optuna/optuna).\nCode files were originally taken from [Goptuna](https://github.com/c-bata/goptuna).\n\n## Installation\n\nYou can install optuna-dashboard via [PyPI](https://pypi.org/project/optuna-dashboard/) or [Anaconda Cloud](https://anaconda.org/conda-forge/optuna-dashboard).\n\n```\n$ pip install optuna-dashboard\n```\n\n## Getting Started\n\nFirst, please specify the storage URL to persistent your study using the [RDB backend](https://optuna.readthedocs.io/en/stable/tutorial/20_recipes/001_rdb.html).\n\n```python\nimport optuna\n\ndef objective(trial):\n    x = trial.suggest_float(\"x\", -100, 100)\n    y = trial.suggest_categorical(\"y\", [-1, 0, 1])\n    return x**2 + y\n\nif __name__ == \"__main__\":\n    study = optuna.create_study(\n        storage=\"sqlite:///db.sqlite3\",  # Specify the storage URL here.\n        study_name=\"quadratic-simple\"\n    )\n    study.optimize(objective, n_trials=100)\n    print(f\"Best value: {study.best_value} (params: {study.best_params})\")\n```\n\nAfter running the above script, please execute the `optuna-dashboard` command with Optuna storage URL.\n\n```\n$ optuna-dashboard sqlite:///db.sqlite3\nListening on http://localhost:8080/\nHit Ctrl-C to quit.\n```\n\n\u003cimg src=\"./docs/_static/optuna-dashboard.gif\" style=\"width:600px;\" alt=\"VSCode Extension\"\u003e\n\nPlease check out [our documentation](https://optuna-dashboard.readthedocs.io/en/latest/getting-started.html) for more details.\n\n## Using an official Docker image\n\nYou can also use [an official Docker image](https://github.com/optuna/optuna-dashboard/pkgs/container/optuna-dashboard) instead of setting up your Python environment.\nThe Docker image only supports SQLite3, MySQL(PyMySQL), and PostgreSQL(Psycopg2).\n\n```\n$ docker run -it --rm -p 8080:8080 -v `pwd`:/app -w /app \\\n\u003e ghcr.io/optuna/optuna-dashboard sqlite:///db.sqlite3\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eMySQL (PyMySQL)\u003c/summary\u003e\n\n```\n$ docker run -it --rm -p 8080:8080 ghcr.io/optuna/optuna-dashboard mysql+pymysql://username:password@hostname:3306/dbname\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003ePostgreSQL (Psycopg2)\u003c/summary\u003e\n\n```\n$ docker run -it --rm -p 8080:8080 ghcr.io/optuna/optuna-dashboard postgresql+psycopg2://username:password@hostname:5432/dbname\n```\n\n\u003c/details\u003e\n\n## Jupyter Lab Extension (Experimental)\n\nYou can install the Jupyter Lab extension via [PyPI](https://pypi.org/project/jupyterlab-optuna/).\n\n```\n$ pip install jupyterlab jupyterlab-optuna\n```\n\n\u003cimg src=\"./docs/_static/jupyterlab-extension.png\" style=\"width:600px;\" alt=\"Jupyter Lab Extension\"\u003e\n\nTo use, click the tile to launch the extension, and enter your Optuna’s storage URL (e.g. `sqlite:///db.sqlite3`) in the dialog.\n\n## Browser-only version (Experimental)\n\n\u003cimg src=\"./docs/_static/browser-app.gif\" style=\"width:600px;\" alt=\"Browser-only version\"\u003e\n\nWe’ve developed the version that operates solely within your web browser, which internally uses SQLite3 Wasm and Rust.\nThere’s no need to install Python or any other dependencies.\nSimply open the following URL in your browser, drag and drop your SQLite3 file onto the page, and you’re ready to view your Optuna studies!\n\nhttps://optuna.github.io/optuna-dashboard/\n\n*Please note that only a subset of features is available. However, you can still check the optimization history, hyperparameter importances, and etc. in graphs and tables.*\n\n## VS Code and code-server Extension (Experimental)\n\nYou can install the VS Code extension via [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Optuna.optuna-dashboard#overview),\nor install the code-server extension via [Open VSX](https://open-vsx.org/extension/Optuna/optuna-dashboard).\n\n\u003cimg src=\"./docs/_static/vscode-extension.png\" style=\"width:600px;\" alt=\"VS Code Extension\"\u003e\n\nPlease right-click the SQLite3 files (`*.db` or `*.sqlite3`) in the VS Code file explorer and select the \"Open in Optuna Dashboard\" command from the dropdown menu.\nThis extension leverages the browser-only version of Optuna Dashboard, so the same limitations apply.\n\n## Submitting patches\n\nIf you want to contribute, please check [Developers Guide](./CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foptuna%2Foptuna-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foptuna%2Foptuna-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foptuna%2Foptuna-dashboard/lists"}