Commit 009fe2f2 authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI

[web][doc] more fix in links

parent 0edcbd49
Pipeline #25521 passed with stage
in 14 minutes and 33 seconds
......@@ -29,7 +29,7 @@
Algorithms are user-defined piece of software that run within the blocks of a
toolchain. An algorithm can read data on the input(s) of the block and write
processed data on its output(s). For detailed information see :ref:`beat-system-algorithms`
processed data on its output(s). For detailed information see `BEAT Algorithms <https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/algorithms.html>`_
.. _Algorithm Editor:
......@@ -62,7 +62,7 @@ Usually, biometric data processing algorithms are *Splittable*, indicating
to the platform that these algorithms can be executed in a distributed fashion,
depending on the available computing resources.
There are also two types of algorithms depending on the way they handle data samples that are fed to them. They can be *Sequential* or *Autonomous*. For more information see :ref:`beat-system-algorithms-types`.
There are also two types of algorithms depending on the way they handle data samples that are fed to them. They can be *Sequential* or *Autonomous*. For more information see `BEAT Algorithms Types <https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/algorithms.html#algorithm-types>`_.
There are two basic ways to create an algorithm at the |project| platform. You
may either start from scratch or fork a new copy of an existing algorithm and edit that.
......@@ -79,8 +79,7 @@ You should see a web-page similar to what is displayed below:
.. image:: img/algorithm_new.*
For instructions on how to create an algorithm from scratch, please refer to the Section of `algorithm editor`_ and see :ref:`beat-system-algorithms-definition-code:
` to understand how to write the source code for new algorithms.
For instructions on how to create an algorithm from scratch, please refer to the Section of `algorithm editor`_ and see `BEAT Algorithm Definition Code <https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/algorithms.html#source-code>`_ to understand how to write the source code for new algorithms.
Edit an existing algorithm
......
......@@ -36,7 +36,7 @@ configuration page, the declaration of this experiment transmitted to the
scheduler, that now must run the experiment until it finishes, you press the
``stop`` button, or an error condition is produced.
As it is described in the :ref:`beat-system-toolchains` section, the scheduler first breaks
As it is described in the `Toolchains <https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/toolchains.html>`_ section, the scheduler first breaks
the toolchain into a sequence of executable blocks with dependencies. For
example: block ``B`` must be run after block ``A``. Each block is then
scheduled for execution depending on current resource availability. If no more
......
......@@ -30,7 +30,7 @@
Data formats specify the transmitted data between the blocks of a toolchain.
They describe the format of the data blocks that circulate between algorithms
and formalize the interaction between algorithms and data sets, so they can
communicate in an orderly manner. For more detailed information see :ref:`beataformats`.
communicate in an orderly manner. For more detailed information see `BEAT Dataformats <https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/dataformats.html#beat-system-dataformats>`_.
.. note::
......
......@@ -178,7 +178,7 @@ toolchain:
.. note::
As mentioned in :ref:`beat-system-experiments-blocks`, BEAT checks that connected datasets, algorithms and
As mentioned in `Declaration of the block <https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/experiments.html#declaration-of-the-block-s>`_, BEAT checks that connected datasets, algorithms and
analyzers produce or consume data in the right format. It only presents
options which are *compatible* with adjacent blocks.
......
......@@ -31,7 +31,7 @@ Libraries
functions. Instead of re-implementing every function from scratch, you can
reuse functions already implemented by other users and published in the form of
|project| libraries. Similarly, you can create and publish your own libraries
of functions that you consider may be useful to other users. For more information see :ref:`beat-system-libraries`
of functions that you consider may be useful to other users. For more information see `BEAT Libraries <https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/libraries.html>`_
Usage of libraries in encouraged in the |project| platform. Besides saving you
time and effort, this also promotes reproducibility in research.
......
......@@ -52,7 +52,3 @@
.. _our gitlab repository: https://gitlab.idiap.ch/beat/
.. _gnu affero gpl v3 license: http://www.gnu.org/licenses/agpl-3.0.en.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
.. _Experiments: https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/experiments.html#beat-system-experiments
.. _Toolchains: https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/toolchains.html#beat-system-toolchains
.. _Dataformats: https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/dataformats.html#beat-system-dataformats
......@@ -35,20 +35,20 @@ reproducible and experiments share parts with each other as much as possible.
For example in a simple experiment, the database, the algorithm, and the
environment used to run the experiment can be shared between experiments.
A fundamental part of the `Experiments`_ in the |project| platform is a
A fundamental part of the :ref:`Experiments` in the |project| platform is a
toolchain. You can see an example of a toolchain below:
.. image:: img/toolchain.*
`Toolchains`_ are sequences of blocks and links (like a block diagram)
:ref:`Toolchains` are sequences of blocks and links (like a block diagram)
which represent the data flow on an experiment. Once you have defined the
toolchain against which you'd like to run, the experiment can be further
configured by assigning different datasets, algorithms and analyzers to the
different toolchain blocks.
The data that circulates at each toolchain connection in a configured
experiment is formally defined using `Dataformats`_. The platform
experiment is formally defined using :ref:`Dataformats`. The platform
experiment configuration system will prevent you from using incompatible
data formats between connecting blocks. For example, in the toolchain depicted
above, if one decides to use a dataset on the block ``train`` (top-left of the
......@@ -68,7 +68,7 @@ toolchain, datasets, and algorithms.
:ref:`faq` for more information.
- You can learn about how to develop new algorithms or change existing ones by
looking at our `Algorithms`_ section. A special kind of algorithms are
looking at our :ref:`Algorithms` section. A special kind of algorithms are
result *analyzers* that are used to generate the results of the experiments.
You can check the results of an experiment once it finishes and share the
......
......@@ -58,7 +58,7 @@ This is a panel with two buttons. The green button which says ``Show``, makes a
pop-up window appear showing your current API token. You may use this token
(64-byte character string) in outside programs that communicate with the
platform programmatically. For example, our command-line interface requires a
token to be able to pull/push contributions for the user (see :ref:`beat-cmdline-configuration`).
token to be able to pull/push contributions for the user (see `Command line Configurations <https://www.idiap.ch/software/beat/docs/beat/docs/master/beat.cmdline/doc/configuration.html>`_
If your token is compromised, you may change it by clicking on the ``Modify``
button. A pop-up window will appear confirming the modification. You may cancel
......
......@@ -28,7 +28,7 @@
============
Toolchains are the backbone of experiments within the |project| platform. They
determine the data flow for experiments in the |project| platform. For more information about toolchanis see `Toolchains`.
determine the data flow for experiments in the |project| platform. For more information about toolchanis see `BEAT Toolchains <https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/toolchains.html>`_.
The *Toolchains* tab
......
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