.. 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.web 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/. .. .. _dataformats: ============== Data Formats ============== 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 the "Dataformats" section of "Getting Started with BEAT" in `BEAT documentation`_. .. note:: Data formats are named using three values joined by a ``/`` (slash) operator. The first value is the **username**. The ``system`` user, provides a number of pre-defined formats such as integers, booleans, floats and arrays (see `here `_). You may also browse `publicly available data formats`_ to see all available data formats from the ``system`` and other users. Data Format Declaration ----------------------- When the user clicks on one of the data formats, she/he has access to the data format description, its declaration, edition history, and algorithms that refer to that data format, like shown on the image below: .. image:: img/system-defined-info.* Deleting a Data Format ---------------------- You may delete a data format that you created by just clicking on the ``Delete`` button and once deleted it cannot be restored. Notice that, if the data format has been already used by any algorithm within the platform, it cannot be deleted any longer. Sharing a Data Format --------------------- As with other components within the platform, all the elements that are created within the platform are private in nature, so this means that only the user that creates them have access to the information concerning that particular object. If you *Share* a data format, it becomes accessible by the users of the platform. You can read the sharing properties of a data format by browsing to the ``Sharing`` tab, on the relevant data format page. .. note:: **Sharing status** The sharing status of a data format is represented to the left of its name, in the format of an icon. A data format can be in one of these three sharing states: * **Private** (icon shows a single person): If a data format is private, only you can use it on your algorithms and only you can view its declaration. * **Shared** (icon shows many persons): If a data format is shared, only people on the sharing list can use the data format and view its declaration. * **Public** (icon shows the globe): If a data format is public, then users and platform visitors can view the declaration of the data format. All platform users can use the data format on their algorithms. Sharing at the |project| platform is an irreversible procedure. For example, public objects cannot be made private again. If you share an object with a user or team and change your mind, you can still delete the object, for as long as it is not being used by you or another colleagues with access (see more information on our :ref:`faq`). .. include:: ../links.rst