Commit 835cad09 authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI

[core][doc] minor fixes

parent 0a01942a
Pipeline #25452 passed with stage
in 25 minutes and 39 seconds
......@@ -90,7 +90,7 @@ To run an experiment using docker you should specify the docker image when defin
$ beat experiment run --docker <experiment name>
You can find more information about running experiments locally using different executors in `here <beat cmdline experiments running>`_.
You can find more information about running experiments locally using different executors in `here <https://www.idiap.ch/software/beat/docs/beat/docs/master/beat.cmdline/doc/experiments.html#how-to-run-an-experiment>`_.
Documentation
......
......@@ -26,7 +26,8 @@
==============
Introduction
==============
A typical BEAT experiment is composed of several building blocks. Datasets that provide data to the system, algorithms that handles the functions introduced by user, analyzers that is in charge of interpreting the output result and producing the appropriate results and figures, and toolchains that determines the data flow between the blocks from datasets to the final results. In addition, each block accepts specific data formats and the data is synchronized between blocks neatly without users need to interfere. These basic functionalities that are introduced in `Getting Started with BEAT <beat system>`_ are all defined and managed by ``beat.core``. For example, as it is explained in `Algorithms <beat system algorithms>`_, algorithm objects should be derived from the class
A typical BEAT experiment is composed of several building blocks. Datasets that provide data to the system, algorithms that handles the functions introduced by user, analyzers that is in charge of interpreting the output result and producing the appropriate results and figures, and toolchains that determines the data flow between the blocks from datasets to the final results. In addition, each block accepts specific data formats and the data is synchronized between blocks neatly without users need to interfere. These basic functionalities that are introduced in `Getting Started with BEAT`_ are all defined and managed by ``beat.core``. For example, as it is explained in `Algorithms`_, algorithm objects should be derived from the class
``Algorithm`` when using Python or in case of C++, they should be derived from ``IAlgorithmLagacy``, ``IAlgorithmSequential``, or ``IAlgorithmAutonomous`` depending of the algorithm type. All these parent classes are defined in ``beat.core`` package.
The rest of this document includes information about the backend api used to handle data through the BEAT ecosystem. For developers and advanced user there is information for local development of the package.
......
......@@ -15,6 +15,5 @@
.. _python bindings: http://zeromq.org/bindings:python
.. _markdown: http://daringfireball.net/projects/markdown/
.. _restructuredtext: http://docutils.sourceforge.net/rst.html
.. _beat cmdline experiments running: https://www.idiap.ch/software/beat/docs/beat/docs/master/beat.cmdline/doc/experiments.html#how-to-run-an-experiment
.. _beat system: https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/introduction.html
.. _beat system algorithms: https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/algorithms.html
.. _Getting Started with BEAT: https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/introduction.html
.. _Algorithms: https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/algorithms.html
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