Commit 7963ff07 authored by Amir MOHAMMADI's avatar Amir MOHAMMADI

Reorganize docs for improved flow and navigation

parent 4a5dbdff
Pipeline #40193 passed with stage
in 3 minutes and 52 seconds
......@@ -407,7 +407,7 @@ the appropriate amount of data and process it.
.. _beat-system-algorithms-examples-simple-processor:
Simple autonomous processor algorithm (no parametrization)
................................................
..........................................................
At the very minimum, a processor algorithm class must look like this:
......@@ -442,7 +442,7 @@ The platform will call this method once per block of data available on the
.. _beat-system-algorithms-examples-simple-evaluator:
Simple autonomous evaluator algorithm (no parametrization)
................................................
..........................................................
At the very minimum, a processor algorithm class must look like this:
......
===============
BEAT Components
===============
This guide details each of BEAT building blocks, their relationships and how
to use the command-line interface to interact with the BEAT platform
efficiently.
.. toctree::
dataformats
algorithms
libraries
databases
toolchains
experiments
plotters
plotterparameters
.. include:: links.rst
.. vim: set fileencoding=utf-8 :
.. _beat_general:
======
BEAT
======
......@@ -21,10 +23,17 @@ both aspects transparently. Data privacy is guaranteed inside the platform.
Start here
==========
* :ref:`beat_general`
Documentation of all BEAT packages
==================================
.. toctree::
:maxdepth: 2
install
introduction
components
user
BEAT software packages
======================
* :ref:`beat_core`
......@@ -33,14 +42,13 @@ Documentation of all BEAT packages
* :ref:`beat_editor`
* :ref:`beat_web`
Index of all Packages
=====================
Index of Packages
=================
.. toctree::
:maxdepth: 1
:titlesonly:
beat <intro/index.rst>
beat.core <beat/beat.core/doc/index.rst>
beat.cmdline <beat/beat.cmdline/doc/index.rst>
beat.backend.python <beat/beat.backend.python/doc/index.rst>
......
......@@ -21,7 +21,6 @@
.. with the BEAT platform. If not, see http://www.gnu.org/licenses/. ..
.. _beat_general:
======
BEAT
......@@ -32,11 +31,6 @@ components of the BEAT framework and a brief tutorial that examplifies how to
build and execute a complete experiment locally.
.. toctree::
install
introduction
user
Indices and tables
==================
......
.. Place your links here
.. _beat: https://www.idiap.ch/software/beat
.. _docker: https://www.docker.com/
.. _reproducible research: https://reproducibleresearch.net/
.. _numpy safe-casting rules: http://docs.scipy.org/doc/numpy/reference/generated/numpy.can_cast.html
.. _zen of python: https://www.python.org/dev/peps/pep-0020/
.. _json: http://en.wikipedia.org/wiki/JSON
.. _beat.env.python27: http://gitlab.idiap.ch/biometric/beat.env.python27
.. _beat.backend.python: http://gitlab.idiap.ch/biometric/beat.backend.python
.. _python 2.7: http://www.python.org
.. _zero message queue: http://zeromq.org
.. _zmq: http://zeromq.org
.. _language bindings: http://zeromq.org/bindings:_start
.. _python bindings: http://zeromq.org/bindings:python
.. _markdown: http://daringfireball.net/projects/markdown/
.. _restructuredtext: http://docutils.sourceforge.net/rst.html
.. _conda: https://conda.io/
.. _beat editor: https://www.idiap.ch/software/beat/docs/beat/docs/new/beat.editor/doc/index.html
.. _bob: https://www.idiap.ch/software/bob/docs/bob/docs/stable/bob/doc/index.html
.. _idiap: http://www.idiap.ch
.. _eigenface: https://en.wikipedia.org/wiki/Eigenface
.. _database interfaces: https://www.idiap.ch/software/bob/docs/bob/docs/stable/bob/bob.db.base/doc/index.html
......@@ -23,9 +23,9 @@
.. _beat-system:
===========================
Getting Started with BEAT
===========================
==============
Introduction
==============
The BEAT framework describes experiments through fundamental building blocks
(object types):
......@@ -181,26 +181,4 @@ data formats, algorithms, toolchains and define experiments rather intuitively.
It also provides a command-line interface which is used in parallel with the GUI
for running experiments, creating, modifying, or deleting objects and interacting with the BEAT platform.
BEAT Building Blocks
====================
The rest of this guide details each of BEAT building blocks, their relationships and how to use the command-line
interface to interact with the BEAT platform efficiently.
.. toctree::
dataformats
algorithms
libraries
databases
toolchains
experiments
plotters
plotterparameters
.. include:: links.rst
......@@ -16,7 +16,8 @@
.. _markdown: http://daringfireball.net/projects/markdown/
.. _restructuredtext: http://docutils.sourceforge.net/rst.html
.. _conda: https://conda.io/
.. _beat_editor: https://www.idiap.ch/software/beat/docs/beat/docs/new/beat.editor/doc/index.html
.. _beat editor: https://www.idiap.ch/software/beat/docs/beat/docs/new/beat.editor/doc/index.html
.. _bob: https://www.idiap.ch/software/bob/docs/bob/docs/stable/bob/doc/index.html
.. _idiap: http://www.idiap.ch
.. _eigenface: https://en.wikipedia.org/wiki/Eigenface
.. _database interfaces: https://www.idiap.ch/software/bob/docs/bob/docs/stable/bob/bob.db.base/doc/index.html
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