diff --git a/doc/algorithms.rst b/doc/algorithms.rst index 4044c9b5eaebe3a3757748d8b14666e85bf61f6b..e3cd3eaa784f5d71656243574ccb459f9bb40101 100644 --- a/doc/algorithms.rst +++ b/doc/algorithms.rst @@ -1009,7 +1009,7 @@ or by iterating over the list: Additionally, the following method is usable on a **list of inputs**: -.. py:method:: hasMoreData() +.. py:method:: InputList.hasMoreData() Indicates if there is (at least) another block of data to process on some of the inputs @@ -1022,20 +1022,20 @@ Input Each input provides the following informations: -.. py:attribute:: name +.. py:attribute:: Input.name *(string)* Name of the input -.. py:attribute:: data_format +.. py:attribute:: Input.data_format *(string)* Data format accepted by the input -.. py:attribute:: data_index +.. py:attribute:: Input.data_index *(integer)* Index of the last block of data received on the input (See section :ref:`beat-system-algorithms-input-synchronization`) -.. py:attribute:: data +.. py:attribute:: Input.data *(object)* The last block of data received on the input @@ -1140,7 +1140,7 @@ have access to additional methods. The following method is usable on a **list of inputs**: -.. py:method:: next() +.. py:method:: InputList.next() Retrieve the next block of data on all the inputs **in a synchronized manner** @@ -1173,11 +1173,11 @@ its inputs, the algorithm would do: The following methods are usable on an ``input``, in cases where the algorithm doesn't care about the synchronization of some of its inputs: -.. py:method:: hasMoreData() +.. py:method:: Input.hasMoreData() Indicates if there is (at least) another block of data available on the input -.. py:method:: next() +.. py:method:: Input.next() Retrieve the next block of data @@ -1336,18 +1336,18 @@ Output Each output provides the following informations: -.. py:attribute:: name +.. py:attribute:: OutputList.name *(string)* Name of the output -.. py:attribute:: data_format +.. py:attribute:: OutputList.data_format *(string)* Format of the data written on the output And the following method: -.. py:method:: write(data, end_data_index=None) +.. py:method:: OutputList.write(data, end_data_index=None) Write a block of data on the output diff --git a/doc/img/editor_algorithm_breakdown.png b/doc/img/editor_algorithm_breakdown.png deleted file mode 100644 index e8110268fe9d06562dc6756f4664011b6c805270..0000000000000000000000000000000000000000 Binary files a/doc/img/editor_algorithm_breakdown.png and /dev/null differ diff --git a/doc/img/editor_database_breakdown.png b/doc/img/editor_database_breakdown.png deleted file mode 100644 index ab37c2c855824bbce2d74ad30ccd36889fe5490f..0000000000000000000000000000000000000000 Binary files a/doc/img/editor_database_breakdown.png and /dev/null differ diff --git a/doc/img/editor_dataformat_breakdown.png b/doc/img/editor_dataformat_breakdown.png deleted file mode 100644 index 03359cf66c048da7814b28576c8dc971a1f98d79..0000000000000000000000000000000000000000 Binary files a/doc/img/editor_dataformat_breakdown.png and /dev/null differ diff --git a/doc/img/editor_experiment.png b/doc/img/editor_experiment.png deleted file mode 100644 index f13ca48ceff8b27f036ef083c7e238929bb16d9f..0000000000000000000000000000000000000000 Binary files a/doc/img/editor_experiment.png and /dev/null differ diff --git a/doc/img/editor_experiment_breakdown.png b/doc/img/editor_experiment_breakdown.png deleted file mode 100644 index 7bb073bdf1f830d725923545d4d55574098a5787..0000000000000000000000000000000000000000 Binary files a/doc/img/editor_experiment_breakdown.png and /dev/null differ diff --git a/doc/img/editor_generic_breakdown.png b/doc/img/editor_generic_breakdown.png deleted file mode 100644 index c6230858dc60582ad33e186c613b66703c6960a8..0000000000000000000000000000000000000000 Binary files a/doc/img/editor_generic_breakdown.png and /dev/null differ diff --git a/doc/img/editor_toolchain_breakdown.png b/doc/img/editor_toolchain_breakdown.png deleted file mode 100644 index 38af97280071a47436c2b7777c6d8781bac48a8d..0000000000000000000000000000000000000000 Binary files a/doc/img/editor_toolchain_breakdown.png and /dev/null differ diff --git a/doc/intro/img/favicon.ico b/doc/intro/img/favicon.ico deleted file mode 100644 index acbc0d0056cc417e7e8b71c3aac7231df78e46b7..0000000000000000000000000000000000000000 Binary files a/doc/intro/img/favicon.ico and /dev/null differ diff --git a/doc/intro/img/logo.png b/doc/intro/img/logo.png deleted file mode 100644 index 180021b7d25cf7bee47a4c38039562462265c8ab..0000000000000000000000000000000000000000 Binary files a/doc/intro/img/logo.png and /dev/null differ diff --git a/doc/intro/index.rst b/doc/intro/index.rst deleted file mode 100644 index d96abd2a75000380c97cc1d5b9784b125fc7a51d..0000000000000000000000000000000000000000 --- a/doc/intro/index.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. vim: set fileencoding=utf-8 : - -.. Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/ .. -.. Contact: beat.support@idiap.ch .. -.. .. -.. This file is part of the beat.docs module of the BEAT platform. .. -.. .. -.. Commercial License Usage .. -.. Licensees holding valid commercial BEAT licenses may use this file in .. -.. accordance with the terms contained in a written agreement between you .. -.. and Idiap. For further information contact tto@idiap.ch .. -.. .. -.. Alternatively, this file may be used under the terms of the GNU Affero .. -.. Public License version 3 as published by the Free Software and appearing .. -.. in the file LICENSE.AGPL included in the packaging of this file. .. -.. The BEAT platform is distributed in the hope that it will be useful, but .. -.. WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY .. -.. or FITNESS FOR A PARTICULAR PURPOSE. .. -.. .. -.. You should have received a copy of the GNU Affero Public License along .. -.. with the BEAT platform. If not, see http://www.gnu.org/licenses/. .. - - - -====== - BEAT -====== - -This guide contains installation instructions, a general introduction to core -components of the BEAT framework and a brief tutorial that examplifies how to -build and execute a complete experiment locally. - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - - -.. include:: links.rst - diff --git a/doc/intro/nitpick-exceptions.txt b/doc/intro/nitpick-exceptions.txt deleted file mode 100644 index bbf66497aae37c58e3ba358616ebeca6e00afcad..0000000000000000000000000000000000000000 --- a/doc/intro/nitpick-exceptions.txt +++ /dev/null @@ -1,7 +0,0 @@ -# Not available in Python 2.7, but ok in Python 3.x -py:exc TypeError -py:exc RuntimeError -py:exc ValueError -py:exc KeyError -py:class tuple -py:class list diff --git a/doc/links.rst b/doc/links.rst index e1bb428d451adfca075a5f0acf91ff60b6b5c887..a77c4af9bec806ff2a8924b2c2c1b04839065e29 100644 --- a/doc/links.rst +++ b/doc/links.rst @@ -5,7 +5,7 @@ .. _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 +.. _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