Commit 6be71aa1 authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI

[general][doc] More fixes on Algorithms and fixes on Libraries

parent 462b94cb
Pipeline #24398 passed with stages
in 6 minutes and 22 seconds
......@@ -124,7 +124,8 @@ subsections. Finally, the field `description` is optional and gives a short
description of the algorithm.
The graphical interface of BEAT provides editor for algorithm,
which simplifies its `JSON`_ declaration definition.
which simplifies its `JSON`_ declaration definition. It also includes a simple
Python code editor.
.. _beat-system-algorithms-definition-analyzer:
......@@ -136,8 +137,8 @@ At the end of the processing workflow of an experiment, there is a special
kind of algorithm, which does not yield any output, but in contrast so called
`results`. These algorithms are called **analyzers**.
`Results` of an experiment are reported back to the user. Since the BEAT
is concerned about data privacy, only a limited number of data formats can be
`Results` of an experiment are reported back to the user. Data privacy is very
important in the BEAT system and therefore only a limited number of data formats can be
employed as results in an analyzer, such as boolean, integers, floating point
values, strings (of limited size), as well as plots (such as scatter or bar
plots).
......
......@@ -34,7 +34,7 @@ needs to be applied in a slightly different processing block, this may, hence,
lead to a lot of code duplication. Duplicate code is undesirable for a number
of reasons such as high maintenance cost.
To address this problem, the platform defines the concept of **libraries**.
To address this problem, the concept of **libraries** has been defined.
Libraries allow users to put code required by several different algorithms
into a common location. Once done, code from a library may be used by any
algorithm as long as the algorithm mentions its dependency to it in its
......@@ -77,8 +77,8 @@ Similarly to algorithms, a library consists of two folds:
def function_from_my_library(value):
return value * self.multiplier
The web client of the BEAT platform provides a graphical editor for algorithm,
which simplifies its `JSON`_ declaration definition. It also includes a simple
The graphical interface of BEAT provides editor for algorithm, which simplifies
its JSON declaration definition. It also includes a simple
Python code editor.
......
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