aboutsummaryrefslogtreecommitdiff
path: root/doc/utils.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/utils.rst')
-rw-r--r--doc/utils.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/utils.rst b/doc/utils.rst
new file mode 100644
index 0000000..6df8a0c
--- /dev/null
+++ b/doc/utils.rst
@@ -0,0 +1,13 @@
+Utils
+=============
+
+.. autoclass:: rumba.utils.ExperimentManager
+ :member-order: bysource
+
+Example usage of the class:
+
+.. code-block:: python
+
+ with ExperimentManager(exp, swap_out_strategy=PROMPT_SWAPOUT):
+ exp.swap_in()
+ exp.bootstrap_prototype()