https://github.com/thesage21/expt
Hypothesis based Experiment manager
https://github.com/thesage21/expt
Last synced: about 1 month ago
JSON representation
Hypothesis based Experiment manager
- Host: GitHub
- URL: https://github.com/thesage21/expt
- Owner: theSage21
- Created: 2017-06-14T09:46:11.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-14T18:45:38.000Z (almost 8 years ago)
- Last Synced: 2025-01-28T21:29:26.974Z (3 months ago)
- Language: Python
- Size: 13.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Expt
====
A program to manage and store experiments performed in proper folders. It also generates reports and summaries.
A report is a fully detailed text for all the experiments in bench/archive or both. A summary on the other hand is a smaller version which let's you get an overview quickly.
Why?
----
Handling experiments as notebooks becomes unwieldly very quickly. You lose track of what you were working on and what needs work.
How?
----
You start a new hypothesis based experiment. The software creates a new directory for you rooted in the current directory. It starts up a new jupyter notebook for this purpose. You can close and exit safely. You can continue to work on different hypothesis separately.
Folder Structure
---------
```
-experiments
|
|\__REPORT
|
|\__SUMMARY
|
|
|\___expt1
| |
| |\__meta.json
| |\__notes.json
| \__notebook.ipynb
|
|
|\___expt2
| |
| |\__meta.json
| |\__notes.json
| \__notebook.ipynb
|
|
\___expt3
|
|\__meta.json
|\__notes.json
\__notebook.ipynb
Usage
-----
```bash
cd ~/experiments
expt list
```
- `expt new ` creates a new expt
- `expt work ` start jupyter server in said expt
- `expt note ` creates a new note in the give blob
- `expt stop ` stops work in an expt
- `expt archive ` compresses and stores the expt folder in archives
- `expt summary` creates a summary of expts currently in bench
- `expt report` creates a summary of expts currently in bench
Todo
----
- [x] list
- [x] new
- [x] work
- [x] note
- [x] stop
- [ ] summary
- [ ] report
- [ ] archive
- [ ] Brow archive