Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chovanecm/sacredboard
Dashboard for sacred. Monitor and access your past machine learning experiments.
https://github.com/chovanecm/sacredboard
dashboard experiments machine-learning mongodb-database sacred
Last synced: about 1 month ago
JSON representation
Dashboard for sacred. Monitor and access your past machine learning experiments.
- Host: GitHub
- URL: https://github.com/chovanecm/sacredboard
- Owner: chovanecm
- License: mit
- Created: 2016-11-12T14:25:11.000Z (about 8 years ago)
- Default Branch: develop
- Last Pushed: 2019-03-06T15:26:21.000Z (over 5 years ago)
- Last Synced: 2024-09-30T10:20:40.609Z (about 1 month ago)
- Topics: dashboard, experiments, machine-learning, mongodb-database, sacred
- Language: Python
- Homepage:
- Size: 1.97 MB
- Stars: 184
- Watchers: 12
- Forks: 39
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sacredboard
Sacredboard is a web dashboard for the [Sacred](https://github.com/IDSIA/sacred)
machine learning experiment management tool.
It connects to the MongoDB database used by Sacred
and displays a list of experiments, their state, Sacred configuration and
the standard output from the running program.
Python 3.5 and a modern web browser are required for it to work properly.
### Project Background (is Sacredboard dead?)
Sacredboard was written as a part of a [master's thesis](https://dspace.cvut.cz/bitstream/handle/10467/69995/F8-DP-2017-Chovanec-Martin-thesis.pdf?sequence=1&isAllowed=y) at Czech Technical University in 2016 and 2017. Supervised by the main developer of Sacred (Klaus Greff from the [Swiss AI Lab IDSIA](http://www.idsia.ch/)), who promoted Sacredboard on the Sacred homepage and at the end of his talk at the [SciPy 2017 Python conference](https://www.youtube.com/watch?v=qqg7RO0o1OE), it has become used by more people that I expected.
Unfortunately, the days I was full-time working on the tool as a student writing his thesis are gone. Sacredboard is now a side project, updated rather once in a while than on a regular basis, mainly because of its active users that deserve their requests for improvements and bugfixes to be addressed.
**Please consider trying [Omniboard](https://github.com/vivekratnavel/omniboard)**, a new (and actively developed!) Sacredboard alternative by Vivek Ratnavel Subramanian and Yusaku Sako.
A big thanks to everyone who has helped improving Sacredboad!
# Features in version 0.4.2
- Get an overview of running and finished experiments in a table,
such as experiment name, machine on which it runs etc.
- Filter experiments
- Get detailed information of the experiment,
such as the text output produced by the experiment.
- Run [Tensorboard](https://www.tensorflow.org/versions/r0.10/how_tos/summaries_and_tensorboard/)
directly from the web console in order to see detailed information,
charts and [Tensorflow](https://www.tensorflow.org) graph visualisations,
provided that the experiment uses Sacred's
[Integration with Tensorflow](http://sacred.readthedocs.io/en/latest/tensorflow.html)
- Visualise [Metrics](http://sacred.readthedocs.io/en/latest/collected_information.html#metrics-api) in a chart.
- Use the MongoDB and newly also FileStorage backend (experimental, thanks to [Gideon Dresdner](https://github.com/gideonite))
- Delete experiments from the UI
## Roadmap
### Further Versions (maybe…)
- Deleting experiments including related records, such as artifacts
- [Customized formatting of the result column](https://github.com/chovanecm/sacredboard/issues/63)
- Write wiki for developers :-)
- TBD
## Screenshots
Screenshots are available on a separate [Screenshots](./docs/screenshots.md) page.
## Installation and Running Sacredboard
Install sacredboard using `pip`:
pip install sacredboard
To install the latest development version with new features, run:
pip install https://github.com/chovanecm/sacredboard/archive/develop.zip
### Dependencies
Sacredboard may require additional dependencies to install, especilly Python3 development files and a C compiler:
On Ubuntu/Debian:
libpython3-dev
build-essential
### Running
Sacredboard can be run simply by typing ``sacredboard`` to connect to
a local MongoDB database listening on port 27017, database name `sacred`.
To connect to another machine or database name, specifiy the connection string
using the `-m host:port:db` option.
sacredboard -m sacred
or, if you wish to connect to another machine and/or use a non-default
name of the Sacred *runs* collection (`-mc`):
sacredboard -m 192.168.1.1:27017:sacred -mc default.runs
For setting more advanced connection properties, use the `-mu` option
together with the Sacred database name ("sacred" in the example):
sacredboard -mu mongodb://user:pwd@host/admin?authMechanism=SCRAM-SHA-1 sacred
See [MongoDB Connection String](https://docs.mongodb.com/manual/reference/connection-string/)
for more information.
The web browser with Sacredboard should open automatically.
To display help, run
sacredboard --help
## Contributing
Contributions to Sacred are welcome (see issues for inspiration).
The project tries to follow the git-flow workflow. Therefore,
contributions of new features should be developed against the `develop` branch. Thank you!
## References
- [Sacred](http://github.com/IDSIA/sacred)
Feel free to open new issues in case of requests or bugs found.
Maintainer / Developer: Martin Chovanec, [email protected]
Current master branch status:
[](https://travis-ci.org/chovanecm/sacredboard)
[](https://coveralls.io/github/chovanecm/sacredboard?branch=master)
Current develop branch status:
[](https://travis-ci.org/chovanecm/sacredboard)
[](https://coveralls.io/github/chovanecm/sacredboard?branch=develop)