From 0e3b037a71ad93d0700c29b1ffb1253b633aee94 Mon Sep 17 00:00:00 2001 From: John Date: Wed, 2 Feb 2022 22:20:33 +1100 Subject: [PATCH] Docs update and prep for release --- docs/source/usage.rst | 43 +++++++++++++++++++++++++++++++++++++++++++ projit/__init__.py | 2 +- 2 files changed, 44 insertions(+), 1 deletion(-) diff --git a/docs/source/usage.rst b/docs/source/usage.rst index a687a1a..51fc0a3 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -135,6 +135,49 @@ The execution record with contain start and end times, the git hash (if present) and any optional parameters or hyperparameters you wish to record. +You can list the experiments you have registered and executed using the CLI: + +.. code-block:: bash + + >projit list experiments + + __Experiments___________________________________________________________________ + __Name_____________Runs__MeanTime____Path_______________________________________ + Initial Exp 4 42s experiments/exp_one.py + Second Exp 2 19s experiments/exp_two.py + + +This will produce a table that includes a count of the executions and the mean execution time. + +You can also produce a simple ascii plot of the execution time over all iterations of a particular experiment. + +.. code-block:: bash + + >projit plot "Initial Exp" execution + + __Experiment_[Initial Exp]_execution_time____________________________________ + Seconds + 84.0 + + | + |o + | + | + | + 57.3333+ + | + | + | o + | + 30.6667+ o + | + | o + 0 +---------+---------+---------+---------+---------+---------+---------+ + 1.0 1.428571 1.857143 2.285714 2.714286 3.142857 3.571429 4.0 + Iteration + + + + Manage Results ^^^^^^^^^^^^^^^^^^^^^ diff --git a/projit/__init__.py b/projit/__init__.py index feb62f5..9c97ecf 100644 --- a/projit/__init__.py +++ b/projit/__init__.py @@ -1,4 +1,4 @@ -__version__ = "0.1.8" +__version__ = "0.1.9" from .utils import locate_projit_config from .projit import projit_load