Commit 3d1a9e90 authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI

[general][doc] added naming convention to the experiments

parent d31165b6
Pipeline #25238 passed with stages
in 5 minutes and 44 seconds
......@@ -35,6 +35,22 @@ 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.
.. note:: **Naming Convention**
Experiments are named using five values joined by a ``/`` (slash)
operator:
* **username**: indicates the author of the experiment
* **toolchain username**: indicates the author of the toolchain used for
that experiment
* **toolchain name**: indicates the name of the toolchain used for that
experiment
* **toolchain version**: indicates the version (integer starting from
``1``) of the toolchain used for the experiment
* **name**: an identifier for the object
Each tuple of these five components defines a *unique* experiment name.
.. _beat-system-experiments-declaration:
......
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