Commit 0803f370 authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI
Browse files

[core][doc] added index and introduction

parent 0dace768
......@@ -27,7 +27,7 @@
Core BEAT components
This package provides the core components of BEAT ecosystem that are the building blocks for all the other BEAT packages to use.
This package provides the core components of BEAT ecosystem. These core components are the building blocks of BEAT experiments that are used by all the other BEAT packages.
.. toctree::
......@@ -23,10 +23,13 @@
.. _beat-core-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 metrics 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 :ref:`beat-system` are all defined and managed by ``beat.core``. For example, as it is explained in :ref:`beat-system-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 for developers for local development of the package and its API.
.. include:: links.rst
Supports Markdown
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