README.rst 3.46 KB
Newer Older
1 2
.. vim: set fileencoding=utf-8 :

3
.. Copyright (c) 2019 Idiap Research Institute, http://www.idiap.ch/          ..
4 5
.. Contact: beat.support@idiap.ch                                             ..
..                                                                            ..
6
.. This file is part of the beat.backend.python module of the BEAT platform.  ..
7
..                                                                            ..
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
.. Redistribution and use in source and binary forms, with or without
.. modification, are permitted provided that the following conditions are met:

.. 1. Redistributions of source code must retain the above copyright notice, this
.. list of conditions and the following disclaimer.

.. 2. Redistributions in binary form must reproduce the above copyright notice,
.. this list of conditions and the following disclaimer in the documentation
.. and/or other materials provided with the distribution.

.. 3. Neither the name of the copyright holder nor the names of its contributors
.. may be used to endorse or promote products derived from this software without
.. specific prior written permission.

.. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
.. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.. WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
.. DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
.. FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.. DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
.. SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
.. CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
.. OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
.. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

André Anjos's avatar
André Anjos committed
33

34
.. image:: https://img.shields.io/badge/docs-v1.4.1-yellow.svg
André Anjos's avatar
André Anjos committed
35 36 37
   :target: https://www.idiap.ch/software/beat/docs/beat/beat.cmdline/stable/index.html
.. image:: https://img.shields.io/badge/docs-latest-orange.svg
   :target: https://www.idiap.ch/software/beat/docs/beat/beat.cmdline/master/index.html
38 39 40 41
.. image:: https://gitlab.idiap.ch/beat/beat.cmdline/badges/v1.4.1/build.svg
   :target: https://gitlab.idiap.ch/beat/beat.cmdline/commits/v1.4.1
.. image:: https://gitlab.idiap.ch/beat/beat.cmdline/badges/v1.4.1/coverage.svg
   :target: https://gitlab.idiap.ch/beat/beat.cmdline/commits/v1.4.1
André Anjos's avatar
André Anjos committed
42 43 44 45
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
   :target: https://gitlab.idiap.ch/beat/beat.cmdline
.. image:: https://img.shields.io/pypi/v/beat.cmdline.svg
   :target: https://pypi.python.org/pypi/beat.cmdline
André Anjos's avatar
André Anjos committed
46 47


André Anjos's avatar
André Anjos committed
48 49 50
==========================
 Core Components for BEAT
==========================
André Anjos's avatar
André Anjos committed
51

André Anjos's avatar
André Anjos committed
52 53 54 55
This package part of BEAT_, an open-source evaluation platform for data science
algorithms and workflows. It contains the command-line based program that can
download/upload components with the platform. It can also run experiments
locally.
André Anjos's avatar
André Anjos committed
56 57 58 59 60


Installation
------------

André Anjos's avatar
André Anjos committed
61 62
Complete BEAT's `installation`_ instructions. Then, to install this package,
run::
André Anjos's avatar
André Anjos committed
63

André Anjos's avatar
André Anjos committed
64
  $ conda install beat.cmdline
André Anjos's avatar
André Anjos committed
65 66


André Anjos's avatar
André Anjos committed
67
Contact
André Anjos's avatar
André Anjos committed
68 69
-------

André Anjos's avatar
André Anjos committed
70 71
For questions or reporting issues to this software package, contact our
development `mailing list`_.
André Anjos's avatar
André Anjos committed
72 73


André Anjos's avatar
André Anjos committed
74 75 76 77
.. Place your references here:
.. _beat: https://www.idiap.ch/software/beat
.. _installation: https://www.idiap.ch/software/beat/install
.. _mailing list: https://www.idiap.ch/software/beat/discuss