diff --git a/doc/usage/experiment.rst b/doc/usage/experiment.rst new file mode 100644 index 0000000000000000000000000000000000000000..52f55f2b040145d73d2da83a9417dfba7a1829a1 --- /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 df365264fe67993c78b484976f52d0e883740e6a..de0ab1f287ed4ec39cf11c97d8389867aaa83d52 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