Sacredboard is a web dashboard for the 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.
- Get an overview of running and finished experiments in a table, such as experiment name, machine on which it runs etc.
- Get detailed information of the experiment, such as the text output produced by the experiment.
- Run Tensorboard directly from the web console in order to see detailed information, charts and Tensorflow graph visualisations, provided that the experiment uses Sacred's Integration with Tensorflow (currently in the development branch of Sacred).
- Added a command line option to specify a custom connection string for MongoDB, thus enabling connections to password-protected databases etc.
- Added a command line option to specify the MongoDB collection that contains the runs. This is useful when using a custom collection name or for compatibility reasons.
- Filtering experiments based on their configuration
- Displaying the
infodictionary
- Filtering experiments based on custom queries on the data produced by experiments.
- In addition, to support the users in using Sacredboard features, sacred will be enhanced with API to store common experiment information (such as error, accuracy etc).
- TBD
Screenshots are available on a separate Screenshots page.
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
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 for more information.
The web browser with Sacredboard should open automatically.
To display help, run
sacredboard --help
Contributions to Sacred are welcomed (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!
Feel free to open new issues in case of requests or bugs found.
Maintainer / Developer: Martin Chovanec, chovamar@fit.cvut.cz
Current master branch status:
Current develop branch status:
