Skip to content
Snippets Groups Projects
Commit 7239c469 authored by Manuel Günther's avatar Manuel Günther
Browse files

Updated README

parent 699896ee
No related branches found
No related tags found
No related merge requests found
Example buildout environment
============================
.. vim: set fileencoding=utf-8 :
.. Andre Anjos <andre.anjos@idiap.ch>
.. Thu 30 Jan 08:46:53 2014 CET
This simple example demonstrates how to wrap Bob-based scripts on buildout
environments. This may be useful for homework assignments, tests or as a way to
distribute code to reproduce your publication. In summary, if you need to give
out code to others, we recommend you do it following this template so your code
can be tested, documented and run in an orderly fashion.
.. image:: http://img.shields.io/badge/docs-stable-yellow.png
:target: http://pythonhosted.org/bob.bio.gmm/index.html
.. image:: http://img.shields.io/badge/docs-latest-orange.png
:target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.bio.gmm/master/index.html
.. image:: http://travis-ci.org/bioidiap/bob.bio.gmm.svg?branch=master
:target: https://travis-ci.org/bioidiap/bob.bio.gmm?branch=master
.. image:: https://coveralls.io/repos/bioidiap/bob.bio.gmm/badge.png?branch=master
:target: https://coveralls.io/r/bioidiap/bob.bio.gmm?branch=master
.. image:: https://img.shields.io/badge/github-master-0000c0.png
:target: https://github.com/bioidiap/bob.bio.gmm/tree/master
.. image:: http://img.shields.io/pypi/v/bob.bio.gmm.png
:target: https://pypi.python.org/pypi/bob.bio.gmm
.. image:: http://img.shields.io/pypi/dm/bob.bio.gmm.png
:target: https://pypi.python.org/pypi/bob.bio.gmm
Installation
------------
=============================================
Run Gaussian mixture model based algorithms
=============================================
This package is part of the ``bob.bio`` packages, which allow to run comparable and reproducible biometric recognition experiments on publicly available databases.
.. note::
This package contains functionality to run biometric recognition algorithms based on Gaussian mixture models (GMMs).
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 using GMM-based algorithms are defined:
To follow these instructions locally you will need a local copy of this
package. For that, you can use the github tarball API to download the package::
* Recognition algorithms based on Gaussian mixture models
* Scripts to run the training of these algorithms in parallel
$ wget --no-check-certificate https://github.com/idiap/bob.project.example/tarball/master -O- | tar xz
$ mv idiap-bob.project* bob.project.example
Documentation and Further Information
-------------------------------------
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.gmm/index.html>`_ or the `Latest Version <https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.bio.gmm/master/index.html>`_ of the documentation.
For a list of tutorials on this or the other packages ob Bob_, or information on submitting issues, asking questions and starting discussions, please visit its website.
Please refer to the latest Bob user guide, accessing from the `Bob website
<http://idiap.github.com/bob/>`_ for how to create your own packages based on
this example. In particular, the Section entitled `Organize Your Work in
Satellite Packages <http://www.idiap.ch/software/bob/docs/releases/last/sphinx/html/OrganizeYourCode.html>`_
contains details on how to setup, build and roll out your code.
.. _bob: https://www.idiap.ch/software/bob
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment