Commit ea5220cc authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI

[general][doc] combining the information about experiments on beat.core and beat.web

parent c054de7a
Pipeline #24916 passed with stage
in 9 minutes and 20 seconds
......@@ -171,9 +171,8 @@ Here are the description for each of the fields in the example above:
* The field **description** is optional and gives a short description of the algorithm.
The graphical interface of BEAT provides editors for the main components of the
system (for example: algorithms, data formats, etc.), which simplifies their
`JSON`_ declaration definition.
The graphical interface of BEAT provides user-friendly editors to configure the main components of the system (for example: algorithms, data formats, etc.), which simplifies their `JSON`_ declaration definition. One needs only to declare an algorithm using the described specifications when not using this graphical interface.
.. _beat-system-algorithms-definition-analyzer:
......
......@@ -33,18 +33,13 @@ to produce displayable results. Defining a BEAT experiment can be seen as
configuring the processing blocks of a toolchain, such as selecting which
database, algorithms and algorithm parameters to use.
The graphical interface of BEAT provides user-friendly editors to configure the main components of the system (for example: experiments, data formats, etc.), which simplifies their `JSON`_ declaration definition. One needs only to declare an experiment using the described specifications when not using this graphical interface.
.. _beat-system-experiments-declaration:
Declaration of an experiment
----------------------------
.. note::
One needs only to declare an experiment using those specifications when not
using the web interface (i.e. when doing local development or using the web
api). The web interface provides a user-friendly way to configure an
experiment.
An experiment is declared in a JSON file, and must contain at least the following
fields:
......@@ -139,14 +134,22 @@ toolchain. Then, four fields must be given:
* `parameters`: the algorithm parameters to use for this processing block
.. note::
.. note:: **Algorithms, Datasets and Blocks**
While configuring the experiment, your objective is to fill-in all
containers defined by the toolchain with valid datasets and algorithms or
analyzers. **BEAT will check connected datasets, algorithms and
analyzers produce or consume data in the right format**. It only presents
options which are *compatible* with adjacent blocks.
When setting an algorithm in a processing block, this will also set the
dataformats of the outputs (and inputs) of this block. In particular,
this has an impact on all the inputs of blocks connected to those outputs,
which must have the same data formats (or be an extension of these data
formats). The compatibility of the data formats of consecutive blocks is
validated automatically.
For example, if you chose dataset ``A`` for block ``train`` of your
experiment that outputs objects in the format ``user/format/1``, then the
algorithm running on the block following ``train``, **must** consume
``user/format/1`` on its input. Therefore, the choices for algorithms that
can run after ``train`` become limited at the moment you chose the dataset
``A``. The configuration system will *dynamically* update to take those
constraints into consideration every time you make a selection, increasing
the global constraints for the experiment.
.. _beat-system-experiments-analyzers:
......@@ -197,3 +200,4 @@ declaration. For instance:
...
}
.. include:: links.rst
\ No newline at end of file
......@@ -89,9 +89,8 @@ Similarly to algorithms, a library consists of two folds:
def function_from_my_library(value):
return value * self.multiplier
The graphical interface of BEAT provides editors for the main components of the
system (for example: libraries, data formats, etc.), which simplifies their
`JSON`_ declaration definition.
The graphical interface of BEAT provides user-friendly editors to configure the main components of the system (for example: libraries, data formats, etc.), which simplifies their `JSON`_ declaration definition. One needs only to declare a library using the described specifications when not using this graphical interface.
Usage
......
......@@ -163,9 +163,8 @@ For display purposes, the JSON file may contain an additional field called
a graphical way.
The graphical interface of BEAT provides editors for the main components of the
system (for example: toolchains, data formats, etc.), which simplifies their
`JSON`_ declaration definition.
The graphical interface of BEAT provides user-friendly editors to configure the main components of the system (for example: toolchains, data formats, etc.), which simplifies their `JSON`_ declaration definition. One needs only to declare a toolchain using the described specifications when not using this graphical interface.
.. _beat-system-toolchains-datasets:
......
Markdown is supported
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