.. vim: set fileencoding=utf-8 :
.. Elie Khoury <Elie.Khoury@idiap.ch>
.. Fri 12 Jun 11:30:03 CEST 2015

.. image:: http://img.shields.io/badge/docs-stable-yellow.png
   :target: http://pythonhosted.org/bob.bio.spear/index.html
.. image:: http://img.shields.io/badge/docs-latest-orange.png
   :target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.bio.spear/master/index.html
.. image:: http://travis-ci.org/bioidiap/bob.bio.spear.svg?branch=v2.0.2
   :target: https://travis-ci.org/bioidiap/bob.bio.spear?branch=v2.0.2
.. image:: https://coveralls.io/repos/bioidiap/bob.bio.spear/badge.png?branch=v2.0.2
   :target: https://coveralls.io/r/bioidiap/bob.bio.spear?branch=v2.0.2
.. image:: https://img.shields.io/badge/github-master-0000c0.png
   :target: https://github.com/bioidiap/bob.bio.spear/tree/master
.. image:: http://img.shields.io/pypi/v/bob.bio.spear.png
   :target: https://pypi.python.org/pypi/bob.bio.spear
.. image:: http://img.shields.io/pypi/dm/bob.bio.spear.png
   :target: https://pypi.python.org/pypi/bob.bio.spear

=====================================
 Run speaker recognition algorithms
=====================================

This package is part of the ``bob.bio`` packages, which allow to run comparable and reproducible biometric recognition experiments on publicly available databases.

This package contains functionality to run speaker recognition experiments.
It is an extension to the `bob.bio.base <http://pypi.python.org/pypi/bob.bio.base>`_ package, which provides the basic scripts.
In this package, utilities that are specific for speaker recognition are contained, such as:

* Audio databases
* Voice activity detection preprocessing
* Acoustic feature extractors
* Recognition algorithms based on acoustic features

For further information about ``bob.bio``, please read `its Documentation <http://pythonhosted.org/bob.bio.base/index.html>`_.

Installation
------------
To install this package -- alone or together with other `Packages of Bob <https://github.com/idiap/bob/wiki/Packages>`_ -- please read the `Installation Instructions <https://github.com/idiap/bob/wiki/Installation>`_.
For Bob_ to be able to work properly, some dependent packages are required to be installed.
Please make sure that you have read the `Dependencies <https://github.com/idiap/bob/wiki/Dependencies>`_ for your operating system.

Documentation
-------------
For further documentation on this package, please read the `Stable Version <http://pythonhosted.org/bob.bio.spear/index.html>`_ or the `Latest Version <https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.bio.spear/master/index.html>`_ of the documentation.
For a list of tutorials on this or the other packages of Bob_, or information on submitting issues, asking questions and starting discussions, please visit its website.

.. _bob: https://www.idiap.ch/software/bob
