From b2c2ad4bf7209fc9375deec4429e6e89038b1d43 Mon Sep 17 00:00:00 2001 From: Manuel Guenther <manuel.guenther@idiap.ch> Date: Thu, 25 Jun 2015 14:33:57 +0200 Subject: [PATCH] Increased version and polished the documentation --- README.rst | 9 +++++---- doc/experiments.rst | 2 +- doc/installation.rst | 2 +- version.txt | 2 +- 4 files changed, 8 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 54815941..ae2aa5c3 100644 --- a/README.rst +++ b/README.rst @@ -33,10 +33,11 @@ All these steps of the biometric recognition system are given as configuration f In this base class implementation, only a few algorithms (such as PCA, LDA, PLDA, BIC) are implemented, while most algorithms that are more specialized are provided by other packages, which are usually in the ``bob.bio`` namespace, such as: -* `bob.bio.face <http://pypi.python.org/pypi/bob.bio.face>`_ for face recognition databases, features and algorithms -* `bob.bio.speaker <http://pypi.python.org/pypi/bob.bio.speaker>`_ for speaker recognition recognition databases, features and algorithms -* `bob.bio.gmm <http://pypi.python.org/pypi/bob.bio.gmm>`_ for Gaussian-Mixture-model-based algorithms -* `bob.bio.video <http://pypi.python.org/pypi/bob.bio.video>`_ for video-based databases and algorithms +* `bob.bio.spear <http://pypi.python.org/pypi/bob.bio.spear>`__ for speaker recognition recognition databases, features and algorithms +* `bob.bio.face <http://pypi.python.org/pypi/bob.bio.face>`__ for face recognition databases, features and algorithms +* `bob.bio.video <http://pypi.python.org/pypi/bob.bio.video>`__ for video-based databases and algorithms +* `bob.bio.gmm <http://pypi.python.org/pypi/bob.bio.gmm>`__ for Gaussian-mixture-model-based algorithms +* `bob.bio.csu <http://pypi.python.org/pypi/bob.bio.csu>`__ for wrapper classes of the `CSU Face Recognition Resources <http://www.cs.colostate.edu/facerec>`__ Additionally, a generic script ``./bin/evaluate.py`` is provided that can generate several types of plots (such as ROC, DET and CMC curves) and compute several measures (such as HTER, Cllr) to evaluate your experiments. diff --git a/doc/experiments.rst b/doc/experiments.rst index ba73ca30..bdafcf09 100644 --- a/doc/experiments.rst +++ b/doc/experiments.rst @@ -144,7 +144,7 @@ Running in Parallel ------------------- One important property of the ``./bin/verify.py`` script is that it can run in parallel, using either several threads on the local machine, or an SGE grid. -To achieve that, ``bob.bio`` is well-integrated with our SGE grid toolkit GridTK_, which we have selected as a python package in the :ref:`Installation <installation>` section. +To achieve that, ``bob.bio`` is well-integrated with our SGE grid toolkit GridTK_, which we have selected as a python package in the :ref:`Installation <bob.bio.base.installation>` section. The ``./bin/verify.py`` script can submit jobs either to the SGE grid, or to a local scheduler, keeping track of dependencies between the jobs. The GridTK_ keeps a list of jobs in a local database, which by default is called ``submitted.sql3``, but which can be overwritten with the ``--gridtk-database-file`` option. diff --git a/doc/installation.rst b/doc/installation.rst index 6db1d9c7..66100e8e 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -2,7 +2,7 @@ .. author: Manuel Günther <manuel.guenther@idiap.ch> .. date: Thu Sep 20 11:58:57 CEST 2012 -.. _installation: +.. _bob.bio.base.installation: ========================= Installation Instructions diff --git a/version.txt b/version.txt index 8ea4f48f..37f0d702 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -0.0.1a0 +2.0.0b0 -- GitLab