diff --git a/doc/develop.rst b/doc/develop.rst index 34434b9a7cb1e8744b8566049056281c4066baf9..d2b3083e45e4cb185fa2c3c5dcaac4d71e907066 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -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 diff --git a/doc/introduction.rst b/doc/introduction.rst index d7695219f42a4b4a725fb218d594747966d27f59..b68b07825393bf0962b6339edcc06dce02ac4262 100644 --- a/doc/introduction.rst +++ b/doc/introduction.rst @@ -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. diff --git a/doc/links.rst b/doc/links.rst index cbf31ace3cf2922d0d7ecb7d893eb70c6b7fb93c..1f95bde1d154c6944fbf00490bdede13ae4ce3a9 100644 --- a/doc/links.rst +++ b/doc/links.rst @@ -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