README.rst 2.16 KB
Newer Older
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
1
.. vim: set fileencoding=utf-8 :
2

3
4
.. image:: http://img.shields.io/badge/docs-stable-yellow.svg
   :target: https://www.idiap.ch/software/bob/docs/bob/bob/stable/index.html
5
.. image:: http://img.shields.io/badge/docs-latest-orange.svg
6
   :target: https://www.idiap.ch/software/bob/docs/bob/bob/master/index.html
7
8
9
10
.. image:: https://gitlab.idiap.ch/bob/bob/badges/master/build.svg
   :target: https://gitlab.idiap.ch/bob/bob/commits/master
.. image:: https://gitlab.idiap.ch/bob/bob/badges/master/coverage.svg
   :target: https://gitlab.idiap.ch/bob/bob/commits/master
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
11
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
12
   :target: https://gitlab.idiap.ch/bob/bob
13
.. image:: http://img.shields.io/pypi/v/bob.svg
14
15
   :target: https://pypi.python.org/pypi/bob

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
16
====================
17
 Bob
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
18
19
20
====================

Bob is a free signal-processing and machine learning toolbox originally
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
21
22
developed by the Biometrics group at the `Idiap`_ Research Institute,
Switzerland.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
23
24
25
26

The toolbox is written in a mix of `Python`_ and `C++`_ and is designed to be
both efficient and reduce development time. It is composed of a reasonably
large number of `packages`_ that implement tools for image, audio & video
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
27
28
processing, machine learning & pattern recognition, and a lot more task
specific packages.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
29

Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
30
**Please visit our** `website`_ **for more information.**
31

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
32

33
For the maintainers
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
34
===================
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
35

Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
36
Below are some instructions for the maintainers of the package.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
37
38


39
Adding/Removing a dependency package
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
40
------------------------------------
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
41

42
43
44
The list of bob packages here should be in sync with bob.nightlies.
You may use the `bdt gitlab update-bob` command for automatic update of the list of
packages.
45
46


47
Releasing a new version of Bob
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
48
------------------------------
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
49

50
See bob.devtools documentation.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
51
52
53
54
55
56

.. External References

.. _c++: http://www2.research.att.com/~bs/C++.html
.. _python: http://www.python.org
.. _idiap: http://www.idiap.ch
57
58
59
60
.. _packages: https://www.idiap.ch/software/bob/packages
.. _wiki: https://www.idiap.ch/software/bob/wiki
.. _bug tracker: https://www.idiap.ch/software/bob/issues
.. _installation: https://www.idiap.ch/software/bob/install
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
61
.. _website: https://www.idiap.ch/software/bob