Commit d89076f3 authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI

[web][doc] mostly relinking to the beat general documentation for blocks mentioned in overview

parent 414349e5
......@@ -38,8 +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. It is the primary resource
for information concerning how to use and run evaluations using the platform.
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`).
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.
......
......@@ -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:`experiments` in the |project| platform is a
A fundamental part of the :ref:`beat-system-experiments` in the |project| platform is a
toolchain. You can see an example of a toolchain below:
.. image:: img/toolchain.*
:ref:`toolchains` are sequences of blocks and links (like a block diagram)
:ref:`beat-system-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:`dataformats`. The platform
experiment is formally defined using :ref:`beat-system-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:`algorithms` section. A special kind of algorithms are
looking at our :ref:`beat-system-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
......
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