README.rst 3.12 KB
Newer Older
1 2 3 4 5
.. vim: set fileencoding=utf-8 :

.. Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/          ..
.. Contact: beat.support@idiap.ch                                             ..
..                                                                            ..
André Anjos's avatar
André Anjos committed
6
.. This file is part of the beat.cmdline module of the BEAT platform.            ..
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
..                                                                            ..
.. 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/.          ..
André Anjos's avatar
André Anjos committed
22

23
.. image:: https://img.shields.io/badge/docs-stable-yellow.svg
André Anjos's avatar
André Anjos committed
24 25 26
   :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
27 28 29 30
.. image:: https://gitlab.idiap.ch/beat/beat.cmdline/badges/master/build.svg
   :target: https://gitlab.idiap.ch/beat/beat.cmdline/commits/master
.. image:: https://gitlab.idiap.ch/beat/beat.cmdline/badges/master/coverage.svg
   :target: https://gitlab.idiap.ch/beat/beat.cmdline/commits/master
André Anjos's avatar
André Anjos committed
31 32 33 34
.. 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
35 36


André Anjos's avatar
André Anjos committed
37 38 39
==========================
 Core Components for BEAT
==========================
André Anjos's avatar
André Anjos committed
40

André Anjos's avatar
André Anjos committed
41 42 43 44
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
45 46 47 48 49


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

André Anjos's avatar
André Anjos committed
50 51
Complete BEAT's `installation`_ instructions. Then, to install this package,
run::
André Anjos's avatar
André Anjos committed
52

André Anjos's avatar
André Anjos committed
53
  $ conda install beat.cmdline
André Anjos's avatar
André Anjos committed
54 55


André Anjos's avatar
André Anjos committed
56
Contact
André Anjos's avatar
André Anjos committed
57 58
-------

André Anjos's avatar
André Anjos committed
59 60
For questions or reporting issues to this software package, contact our
development `mailing list`_.
André Anjos's avatar
André Anjos committed
61 62


André Anjos's avatar
André Anjos committed
63 64 65 66
.. 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