Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
beat
beat.core
Commits
53f521d5
Commit
53f521d5
authored
Jun 07, 2018
by
Flavio TARSETTI
Browse files
[doc] fix doc extra markers
parent
0569936c
Pipeline
#20885
passed with stages
in 52 minutes and 10 seconds
Changes
11
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
doc/algorithms.rst
View file @
53f521d5
...
@@ -23,8 +23,9 @@
...
@@ -23,8 +23,9 @@
.. _beat-core-algorithms:
.. _beat-core-algorithms:
===========
Algorithms
Algorithms
==========
==========
=
Algorithms are user-defined piece of software that run within the blocks of a
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
toolchain. An algorithm can read data on the input(s) of the block and write
...
...
doc/api.rst
View file @
53f521d5
...
@@ -21,8 +21,9 @@
...
@@ -21,8 +21,9 @@
.. with the BEAT platform. If not, see http:..www.gnu.org.licenses.. ..
.. with the BEAT platform. If not, see http:..www.gnu.org.licenses.. ..
====
API
API
===
===
=
This section includes information for using the Python API of ``beat.core``.
This section includes information for using the Python API of ``beat.core``.
...
...
doc/backend_api.rst
View file @
53f521d5
...
@@ -22,8 +22,9 @@
...
@@ -22,8 +22,9 @@
..
_beat
-
core
-
backend
-
api
:
..
_beat
-
core
-
backend
-
api
:
============
Backend
API
Backend
API
===========
===========
=
As
it
is
currently
setup
,
user
code
at
toolchain
blocks
running
on
the
platform
As
it
is
currently
setup
,
user
code
at
toolchain
blocks
running
on
the
platform
consumes
data
stored
on
disk
and
produces
data
which
is
stored
on
disk
so
that
consumes
data
stored
on
disk
and
produces
data
which
is
stored
on
disk
so
that
...
...
doc/databases.rst
View file @
53f521d5
...
@@ -21,8 +21,9 @@
...
@@ -21,8 +21,9 @@
.. with the BEAT platform. If not, see http://www.gnu.org/licenses/. ..
.. with the BEAT platform. If not, see http://www.gnu.org/licenses/. ..
==========
Databases
Databases
=========
=========
=
A database is a collection of data files, one for each output of the database.
A database is a collection of data files, one for each output of the database.
This data are inputs to the BEAT toolchains. Therefore, it is important to
This data are inputs to the BEAT toolchains. Therefore, it is important to
...
...
doc/dataformats.rst
View file @
53f521d5
...
@@ -23,8 +23,9 @@
...
@@ -23,8 +23,9 @@
.. _beat-core-dataformats:
.. _beat-core-dataformats:
=============
Data formats
Data formats
============
============
=
Data formats formalize the interaction between algorithms and data sets, so
Data formats formalize the interaction between algorithms and data sets, so
they can communicate data in an orderly manner. All data formats produced or
they can communicate data in an orderly manner. All data formats produced or
...
...
doc/develop.rst
View file @
53f521d5
...
@@ -137,8 +137,9 @@ sphinx::
...
@@ -137,8 +137,9 @@ sphinx::
Other bits
Other bits
----------
----------
==========
Profiling
Profiling
=========
=========
=
In order to profile the test code, try the following::
In order to profile the test code, try the following::
...
...
doc/experiments.rst
View file @
53f521d5
...
@@ -23,8 +23,9 @@
...
@@ -23,8 +23,9 @@
.. _beat-core-experiments:
.. _beat-core-experiments:
============
Experiments
Experiments
===========
===========
=
An experiment is the reunion of algorithms, datasets, a toolchain and
An experiment is the reunion of algorithms, datasets, a toolchain and
parameters that allow the platform to schedule and run the prescribed recipe
parameters that allow the platform to schedule and run the prescribed recipe
...
...
doc/introduction.rst
View file @
53f521d5
...
@@ -23,8 +23,9 @@
...
@@ -23,8 +23,9 @@
.. _beat-core-introduction:
.. _beat-core-introduction:
=============
Introduction
Introduction
============
============
=
The BEAT platform is a web-based system for certifying results for
The BEAT platform is a web-based system for certifying results for
software-based data-driven workflows that can be sub-divided functionally (into
software-based data-driven workflows that can be sub-divided functionally (into
...
...
doc/io.rst
View file @
53f521d5
...
@@ -23,8 +23,9 @@
...
@@ -23,8 +23,9 @@
.. _developerguide-io:
.. _developerguide-io:
===============
Inputs/Outputs
Inputs/Outputs
==============
==============
=
.. _developerguide-io-introduction:
.. _developerguide-io-introduction:
...
...
doc/libraries.rst
View file @
53f521d5
...
@@ -23,8 +23,9 @@
...
@@ -23,8 +23,9 @@
.. _beat-core-libraries:
.. _beat-core-libraries:
==========
Libraries
Libraries
=========
=========
=
Algorithms are fundamental elements in the platform that formally describe how
Algorithms are fundamental elements in the platform that formally describe how
to process data. In particular, they are always attached to a specific
to process data. In particular, they are always attached to a specific
...
...
doc/toolchains.rst
View file @
53f521d5
...
@@ -23,8 +23,9 @@
...
@@ -23,8 +23,9 @@
.. _beat-core-toolchains:
.. _beat-core-toolchains:
===========
Toolchains
Toolchains
==========
==========
=
A toolchain describes the workflow of a particular experiment. Its declaration
A toolchain describes the workflow of a particular experiment. Its declaration
defines:
defines:
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment