Skip to content

Commit

Permalink
Merge pull request #250 from datmo/Add-readme-feature-commands
Browse files Browse the repository at this point in the history
Add readme feature command table
  • Loading branch information
asampat3090 committed Aug 4, 2018
2 parents 04a8f34 + 5bda605 commit ba46aad
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,18 @@ feel free contribute by adding issues so the contributors can address them.
- **Experiment reproducibility** (re-run tasks)
- **Visualize + export** experiment history


| Feature | Commands|
| ------------- | ---------------------------- |
| Initializing a Project | `$ datmo init` |
| Setup a new environment | `$ datmo environment setup` |
| Run an experiment | `$ datmo run "python filename.py"` |
| Reproduce a previous experiment | `$ datmo ls` (Find the desired ID) <br> `$ datmo rerun EXPERIMENT_ID` |
| Open a workspace | `$ datmo notebook` (Jupyter Notebook) <br> `$ datmo jupyterlab` (JupyterLab) <br> `$ datmo rstudio` (RStudio) <br> `$ datmo terminal` (Terminal)|
| Record your project state <br> (Files, code, env, config, stats) | `$ datmo snapshot create -m "My first snapshot!"` |
| Switch to a previous project state | `$ datmo snapshot ls` (Find the desired ID) <br> `$ datmo snapshot checkout SNAPSHOT_ID` |
| Visualize project entities | `$ datmo ls` (Experiments) <br> `$ datmo snapshot ls` (Snapshots) <br> `$ datmo environment ls` (Environments) |

---

### Table of Contents
Expand Down

0 comments on commit ba46aad

Please sign in to comment.