From 4a8302efaf25dc8f2389b60e1f4b96909a713c27 Mon Sep 17 00:00:00 2001
From: Tiago Freitas Pereira <tiagofrepereira@gmail.com>
Date: Fri, 30 Sep 2016 13:24:40 +0200
Subject: [PATCH] Updating the documentation
---
doc/implementation.rst | 2 +-
doc/implemented.rst | 7 ++-----
doc/installation.rst | 25 +++++++++++++++++++++----
3 files changed, 24 insertions(+), 10 deletions(-)
diff --git a/doc/implementation.rst b/doc/implementation.rst
index 07772262..ed0d4bc1 100644
--- a/doc/implementation.rst
+++ b/doc/implementation.rst
@@ -219,7 +219,7 @@ Verification Database Interface
For most of the data sets, we rely on the database interfaces from Bob_.
Particularly, all databases that are derived from the :py:class:`bob.bio.base.database.BioDatabase` (click :ref:`here <verification_databases>` for a list of implemented databases) are supported by a special derivation of the databases from above.
-For these databases, the special :py:class:`bob.bio.base.database.DatabaseBob` interface is provided, which takes the Bob_ database as parameter.
+For these databases, the special :py:class:`bob.bio.base.database.BioDatabase` interface is provided, which takes the Bob_ database as parameter.
Several such databases are defined in the according packages, i.e., :ref:`bob.bio.spear <bob.bio.spear>`, :ref:`bob.bio.face <bob.bio.face>` and :ref:`bob.bio.video <bob.bio.video>`.
For Bob_'s ZT-norm databases, we provide the :py:class:`bob.bio.base.database.DatabaseBobZT` interface.
diff --git a/doc/implemented.rst b/doc/implemented.rst
index e753ab0b..1fb13eaf 100644
--- a/doc/implemented.rst
+++ b/doc/implemented.rst
@@ -14,8 +14,6 @@ Base Classes
bob.bio.base.preprocessor.Preprocessor
bob.bio.base.extractor.Extractor
bob.bio.base.algorithm.Algorithm
- bob.bio.base.database.Database
- bob.bio.base.database.DatabaseZT
bob.bio.base.grid.Grid
@@ -30,9 +28,8 @@ Implementations
bob.bio.base.algorithm.LDA
bob.bio.base.algorithm.PLDA
bob.bio.base.algorithm.BIC
- bob.bio.base.database.DatabaseBob
- bob.bio.base.database.DatabaseBobZT
- bob.bio.base.database.DatabaseFileList
+ bob.bio.base.database.BioDatabase
+ bob.bio.base.database.ZTBioDatabase
Preprocessors
diff --git a/doc/installation.rst b/doc/installation.rst
index f3811adc..a63e64c4 100644
--- a/doc/installation.rst
+++ b/doc/installation.rst
@@ -17,7 +17,24 @@ Please make sure that you have read the `Dependencies <https://github.com/idiap/
Currently, running Bob_ under MS Windows in not yet supported.
However, we found that running Bob_ in a virtual Unix environment such as the one provided by VirtualBox_ is a good alternative.
-The most simple and most convenient way to use the ``bob.bio`` tools is to use a ``zc.buildout`` package, as explained in more detail `here <https://github.com/idiap/bob/wiki/Installation#using-zcbuildout-for-production>`__.
+Installation via conda
+~~~~~~~~~~~~~~~~~~~~~~
+
+The most simple and most convenient way to use the ``bob.bio`` tools is to install it using `conda <http://conda.pydata.org/docs/intro.html>`_.
+We offer pre-compiled binary installations of Bob_ and ``bob.bio`` with conda.
+After setting up your conda environment (you can find the instructions `here <https://gitlab.idiap.ch/bob/bob/wikis/Installation>`_), use the sequence of commands to
+first search the ``bob.bio`` in the conda-forge channel and then install it.
+
+.. code-block:: sh
+
+ $ conda search bob.bio # searching
+ $ conda install bob.bio.base # Install the base package
+
+
+Installation via zc.buildout
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Another convenient way to use the ``bob.bio`` tools is to use a ``zc.buildout`` package, as explained in more detail `here <https://github.com/idiap/bob/wiki/Installation#using-zcbuildout-for-production>`__.
There, in the ``eggs`` section of the ``buildout.cfg`` file, simply list the ``bob.bio`` packages that you want, like:
.. code-block:: python
@@ -42,7 +59,7 @@ will the download and install all dependent packages locally (relative to your c
Databases
-~~~~~~~~~
+---------
With ``bob.bio`` you will run biometric recognition experiments using some default biometric recognition databases.
Though the verification protocols are implemented in ``bob.bio``, the original data are **not included**.
@@ -69,7 +86,7 @@ Please use ``./bin/databases.py`` for a list of known databases, where you can s
Test your Installation
-~~~~~~~~~~~~~~~~~~~~~~
+----------------------
One of the scripts that were generated during the bootstrap/buildout step is a test script.
To verify your installation, you should run the script running the nose tests for each of the ``bob.bio`` packages:
@@ -105,7 +122,7 @@ In case any of the tests fail for unexplainable reasons, please file a bug repor
Generate this documentation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------
Generally, the documentation of this package is `available online <http://pythonhosted.org/bob.bio.base>`__, and this should be your preferred resource.
However, to generate this documentation locally, you call:
--
GitLab