Commit 1df4dc8c authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI

[general][doc] Fixes in algorithms and images

parent 194bb0b2
Pipeline #24794 passed with stages
in 5 minutes and 56 seconds
......@@ -54,7 +54,7 @@ defines two type of algorithms:
- Autonomous
The sequential algorithm type is the direct successor of the v1 algorithm. For
migration information, see :ref:`_beat-system-algorithms-api-migration`.
migration information, see :ref:`beat-system-algorithms-api-migration`.
Sequential
..........
......@@ -268,7 +268,7 @@ At the very minimum, an algorithm class must look like this:
The class must be called ``Algorithm`` and must have a method called
``process()``, that takes as parameters a list of inputs (see section
:ref:`beat-system-algorithms-input-inputlist`), a list of data loader (see section
:ref:`beat-system-algorithms-dataloader-dataloaderlist`) and a list of outputs
:ref:`beat-system-algorithms-dataloaders-dataloaderlist`) and a list of outputs
(see section :ref:`beat-system-algorithms-output-outputlist`). This method must
return ``True`` if everything went correctly, and ``False`` if an error
occurred.
......@@ -307,11 +307,11 @@ the appropriate amount of data and process it.
.. _beat-system-algorithms-examples-parameterizable:
Parameterizable algorithm
........................
.........................
The following is valid for all types of algorithms
To implement a parametrizable algorithm, two things must be added to the class:
To implement a parameterizable algorithm, two things must be added to the class:
(1) a field in the JSON declaration of the algorithm containing their default
values as well as the type of the parameters, and (2) a method called
``setup()``, that takes one argument, a map containing the parameters of the
......@@ -667,7 +667,7 @@ Data loaders
DataLoader list
...............
An algorithm is given accessto the **list of data loaders** of the processing
An algorithm is given access to the **list of data loaders** of the processing
block. This list can be used to access each data loader individually, either by
their channel name (see :ref:`beat-system-algorithms-dataloaders-name`), their
index or by iterating over the list:
......@@ -1012,7 +1012,7 @@ the data block on the output.
return True
.. _beat-system-algorithms-api-migration
.. _beat-system-algorithms-api-migration:
Migrating from API v1 to API v2
-------------------------------
......@@ -1038,6 +1038,7 @@ which will require only a few changes regarding the code.
API V1:
.. code-block:: python
class Algorithm:
def setup(self, parameters):
......@@ -1057,6 +1058,7 @@ API V1:
API V2 sequential:
.. code-block:: python
class Algorithm:
def setup(self, parameters):
......@@ -1076,6 +1078,7 @@ API V2 sequential:
API V2 automous:
.. code-block:: python
class Algorithm:
def setup(self, parameters):
......
......@@ -68,7 +68,7 @@ only a few color-coded components:
results (that, at this point, are also unspecified).
.. Simple toolchain representation for the BEAT platform
.. graphviz:: img/toolchain-triangle.dot
.. image:: img/toolchain-triangle.png
The toolchain only defines the very basic data flow and connections that must
be respected by experiments. It does not define what is the type of data that
......@@ -120,7 +120,7 @@ produce quantifiable results you can use to measure the performance of your
experimental setup.
.. Simple experiment representation for the BEAT platform
.. graphviz:: img/experiment-triangle.dot
.. image:: img/experiment-triangle.png
.. _beat-system-design:
......
.. _tutorial:
* introduce the file system organisation
......@@ -8,8 +8,9 @@
.. note::
All these building blocks are stored in a folder typically named `prefix`.
We will get back to this in :ref:`tutorial`
We will get back to this in :ref:`tutorial-`
.. _tutorial-:
=====================
A Hands-On Tutorial
......
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