Commit c66e0439 authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI

[web][doc] fixing some links

parent a575849c
Pipeline #25508 passed with stage
in 14 minutes and 13 seconds
......@@ -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:`beat-system-dataformats`.
communicate in an orderly manner. For more detailed information see :ref:`beataformats`.
.. note::
......
......@@ -38,7 +38,7 @@ provides an attestation mechanism for your reports (scientific papers,
technical documents or certifications).
This guide contains detailed and illustrated information on how to interact
with the |project| platform using its web interface. Before you continue with this guide you should familiar yourself with different components of BEAT (see :ref:`beat-system`).
with the |project| platform using its web interface. Before you continue with this guide you should familiar yourself with different components of BEAT (see `Getting Started with BEAT`_).
In order to take full advantage of the guide, we recommend you register_ into
the platform and follow the tutorials in the order defined in this guide.
......
......@@ -51,3 +51,8 @@
.. _numpy: http://www.numpy.org/
.. _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 :ref:`beat-system-experiments` in the |project| platform is a
A fundamental part of the `Experiments`_ in the |project| platform is a
toolchain. You can see an example of a toolchain below:
.. image:: img/toolchain.*
:ref:`beat-system-toolchains` are sequences of blocks and links (like a block diagram)
`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 :ref:`beat-system-dataformats`. The platform
experiment is formally defined using `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 :ref:`beat-system-algorithms` section. A special kind of algorithms are
looking at our `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
......
......@@ -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 :ref:`beat-system-toolchains`.
determine the data flow for experiments in the |project| platform. For more information about toolchanis see `Toolchains`.
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