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

3
.. image:: https://img.shields.io/badge/docs-available-orage.svg
4
   :target: https://www.idiap.ch/software/bob/docs/bob/bob/master/index.html
5
.. image:: https://gitlab.idiap.ch/bob/bob/badges/master/pipeline.svg
6
7
8
   :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
9
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
10
   :target: https://gitlab.idiap.ch/bob/bob
11

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
12
====================
13
 Bob
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
14
15
16
====================

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

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
23
24
processing, machine learning & pattern recognition, and a lot more task
specific packages.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
25

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

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

29
For the maintainers
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
30
===================
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
31

Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
32
Below are some instructions for the maintainers of the package.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
33
34


35
Adding/Removing a dependency package
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
36
------------------------------------
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
37

38
39
40
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.
41
42


43
Releasing a new version of Bob
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
44
------------------------------
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
45

46
See bob.devtools documentation.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
47
48
49
50
51
52

.. External References

.. _c++: http://www2.research.att.com/~bs/C++.html
.. _python: http://www.python.org
.. _idiap: http://www.idiap.ch
53
54
55
56
.. _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
57
.. _website: https://www.idiap.ch/software/bob