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

3
.. image:: http://img.shields.io/badge/docs-stable-yellow.svg
4
   :target: http://pythonhosted.org/bob/index.html
5
.. image:: http://img.shields.io/badge/docs-latest-orange.svg
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
6
   :target: https://www.idiap.ch/software/bob/docs/latest/bob/bob/master/index.html
7
8
.. image:: https://gitlab.idiap.ch/bob/bob/badges/master/build.svg
   :target: https://gitlab.idiap.ch/bob/bob/commits/master
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
9
10
.. 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
12
   :target: https://gitlab.idiap.ch/bob/bob/commits/master
13
.. image:: http://img.shields.io/pypi/v/bob.svg
14
   :target: https://pypi.python.org/pypi/bob
15
.. image:: http://img.shields.io/pypi/dm/bob.svg
16
17
   :target: https://pypi.python.org/pypi/bob

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
18
====================
19
 Bob
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
20
21
22
====================

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

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

32
**Please visit our `website`_ for more information.**
33

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

35
36
For the maintainers
-------------------
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
37

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


41
42
Updating the dependencies
=========================
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
43

44
45
46
If you want to update the version of the dependency packages, run the following
commands::

Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
47
  $ python ./bob/script/get_versions.py > requirements.txt
48
49
  $ git commit requirements.txt -m "Update requeriments" && git push

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

51
52
Removing a dependency package
=============================
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
53

Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
54
55
To remove a package on bob, just remove the package name in the file
(`requirements.txt`).
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
56
57
58
59
60
61
62


.. External References

.. _c++: http://www2.research.att.com/~bs/C++.html
.. _python: http://www.python.org
.. _idiap: http://www.idiap.ch
63
64
65
66
.. _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
67
.. _website: https://www.idiap.ch/software/bob