From 6fd1d115883312fbbfd964c0978c881678e268d9 Mon Sep 17 00:00:00 2001
From: dcarron <daniel.carron@idiap.ch>
Date: Tue, 23 Jan 2024 15:05:18 +0100
Subject: [PATCH] [doc] Add documentation on experiments

---
 doc/usage/experiment.rst | 28 ++++++++++++++++++++++++++++
 doc/usage/index.rst      |  7 ++++---
 2 files changed, 32 insertions(+), 3 deletions(-)
 create mode 100644 doc/usage/experiment.rst

diff --git a/doc/usage/experiment.rst b/doc/usage/experiment.rst
new file mode 100644
index 00000000..52f55f2b
--- /dev/null
+++ b/doc/usage/experiment.rst
@@ -0,0 +1,28 @@
+.. Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
+..
+.. SPDX-License-Identifier: GPL-3.0-or-later
+
+.. _mednet.experiment:
+
+==============================
+ Running complete experiments
+==============================
+
+We provide an :ref:`experiment command <mednet.cli>`
+that runs training, followed by prediction and evaluation.
+After running, you will be able to find results from model fitting,
+prediction and evaluation under a single output directory.
+
+For example, to train a pasa model on the montgomery database
+evaluate its performance and output predictions and performance curves,
+run the following:
+
+.. code-block:: sh
+
+   $ mednet experiment -vv pasa montgomery
+   # check results in the "results" folder
+
+You may run the system on a GPU by using the ``--device=cuda:0`` option.
+
+
+.. include:: ../links.rst
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index df365264..de0ab1f2 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -79,10 +79,11 @@ Commands
 --------
 
 .. toctree::
-   :maxdepth: 2
+  :maxdepth: 2
 
-   training
-   evaluation
+  experiment
+  training
+  evaluation
 
 
 .. include:: ../links.rst
-- 
GitLab