Commit 9ea0e66a authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI

[general][doc] added naming convention to Algorithms

parent 3d1a9e90
Pipeline #25313 passed with stages
in 10 minutes and 37 seconds
......@@ -64,6 +64,20 @@ algorithms. This drives the synchronization of information-flow through the
toolchain. Flow synchronization is determined by data units produced from a
dataset and injected into the toolchain.
.. note:: **Naming Convention**
Algorithms are named using three values joined by a ``/`` (slash) operator:
* **username**: indicates the author of the algorithm
* **name**: indicates the name of the algorithm
* **version**: indicates the version (integer starting from ``1``) of the
algorithm
Each tuple of these three components defines a *unique* algorithm name
inside the BEAT ecosystem.
.. _beat-system-algorithms-types:
......
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