From 83c1f7c6a3e443506eb36c554e1607f38713a09b Mon Sep 17 00:00:00 2001 From: Zohreh MOSTAANI <zohreh.mostaani@idiap.ch> Date: Mon, 10 Dec 2018 15:43:58 +0100 Subject: [PATCH] [core][doc] modification in the develop guide --- doc/develop.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/develop.rst b/doc/develop.rst index 0122526b..ef0d86b9 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -20,6 +20,7 @@ .. You should have received a copy of the GNU Affero Public License along .. .. with the BEAT platform. If not, see http://www.gnu.org/licenses/. .. +.. _beat-core-local-development: =================== Local Development @@ -79,6 +80,12 @@ downloaded from the BEAT platform (not required for unit testing). These docker $ docker pull docker.idiap.ch/beat/beat.env.python:1.0.0 $ docker pull docker.idiap.ch/beat/beat.env.db:1.2.2 +To run an experiment using docker you should specify the docker image when defining the experiment, then use the `--docker` flag when using `beat.cmdline`:: + + $ beat experiment run --docker <experiment name> + +You can find more information about running experiments locally using different executors in :ref:`here <beat-cmdline-experiments-running>`. + Documentation ------------- -- GitLab