Commit 4b7735f5 authored by Samuel GAIST's avatar Samuel GAIST
Browse files

[doc] Add quick start guide

parent 5b5af08a
Pipeline #37278 passed with stage
in 16 minutes and 25 seconds
......@@ -35,6 +35,7 @@ In the following sections different parts of the graphical interface will be exp
.. toctree::
editor
quick_start_guide
contribute
......
......@@ -26,3 +26,4 @@
.. _PyQt: https://www.riverbankcomputing.com/software/pyqt/intro
.. _PyQt documentation: http://pyqt.sourceforge.net/Docs/PyQt5/index.html
.. _pytest-qt: https://pytest-qt.readthedocs.io/en/latest/
.. _installation: https://www.idiap.ch/software/beat/install
.. vim: set fileencoding=utf-8 :
.. Copyright (c) 2020 Idiap Research Institute, http://www.idiap.ch/ ..
.. Contact: beat.support@idiap.ch ..
.. ..
.. This file is part of the beat.editor module of the BEAT platform. ..
.. ..
.. Commercial License Usage ..
.. Licensees holding valid commercial BEAT licenses may use this file in ..
.. accordance with the terms contained in a written agreement between you ..
.. and Idiap. For further information contact tto@idiap.ch ..
.. ..
.. Alternatively, this file may be used under the terms of the GNU Affero ..
.. Public License version 3 as published by the Free Software and appearing ..
.. in the file LICENSE.AGPL included in the packaging of this file. ..
.. The BEAT platform is distributed in the hope that it will be useful, but ..
.. WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY ..
.. or FITNESS FOR A PARTICULAR PURPOSE. ..
.. ..
.. 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-editor-quick-start-guide:
===========================
Quick Start Guide
===========================
Installation
============
Follow the same `installation`_ procedure as other beat package to setup a conda environment ready for development.
#. Start the editor: ::
$ beat editor start
#. Start the editor for a specific prefix:
In order to use a specific prefix, use the `--prefix` option. ::
$ beat --prefix /path/to/prefix editor start
Work flow
=========
The goal of the BEAT editor is to allow you to implement and test your solution
locally on either a reduced or different dataset. Then, once you have
everything working as expected, push the resulting code to the platform and
execute it there.
1. Get the experience you would like to work on: ::
$ beat pull user/author/toolchain/version/name_of_experiment
This will pull the experiment as well as all its dependencies from the platform
so that it can be run locally.
2. Edit the code: ::
$ beat algorithm edit author/name_of_algo/version_number
This will open your default configured editor to edit the code of the algorithm
passed in parameter.
3. Edit an asset: ::
$ beat editor start
This will start the BEAT editor so that you will have an easy access to your
asset. You'll be able to edit them visually. The editor also allows to start
your favorite editor for code or documentation modification.
4. Run an experiment:
To run an experiment locally: ::
$ beat exp run user/author/toolchain/version/name_of_experiment
Once the experiment runs successfully on your machine, you can upload it to
the online platform and run it there. ::
$ beat exp push user/author/toolchain/version/name_of_experiment
$ beat exp start user/author/toolchain/version/name_of_experiment
You can monitor the execution of your experiment at any moment with: ::
$ beat exp monitor user/author/toolchain/version/name_of_experiment
.. include:: links.rst
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment