Metadata-Version: 2.1
Name: optdash
Version: 0.0.2
Summary: A third-party dashboard for optuna.
Home-page: UNKNOWN
Author: Yusuke Tsuzuku
Author-email: ytsmiling@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: optuna
Requires-Dist: sklearn
Requires-Dist: sqlalchemy
Provides-Extra: checking
Requires-Dist: black ; extra == 'checking'
Requires-Dist: mypy ; extra == 'checking'
Requires-Dist: flake8 ; extra == 'checking'
Provides-Extra: doc
Requires-Dist: sphinx ; extra == 'doc'
Requires-Dist: sphinx-rtd-theme ; extra == 'doc'
Provides-Extra: mysql
Provides-Extra: postgres
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-dependency ; extra == 'test'

# optdash

**Optdash** is a third-party dashboard for optuna.

![README GIF](docs/images/optdash-readme.gif)

## Key features

* Simple usage
* Interactive visualization
* Minimal dependencies
    * Optdash depends solely on Optuna (and sklearn, which is an optional depedency of optuna).


## Quick start

```shell script
optdash your/db/url
```

The db url is the same with optuna, whose format follows [RFC-1738](https://tools.ietf.org/html/rfc1738.html).

## Install

### From pypi

```shell script
pip install optdash
```


### From source

```shell script
cd optdash/frontend
npm i
npm run build
cd ../../
python -m pip install .
```


