From 9bc73f5825c06f9addf24b4cfb7726e256a28664 Mon Sep 17 00:00:00 2001
From: Manuel Guenther <manuel.guenther@idiap.ch>
Date: Tue, 19 Feb 2013 18:01:34 +0100
Subject: [PATCH] Corrected instructions to download and generate documenation.
---
README.rst | 49 +++++++++++++++++++++++++++++++++++++-------
doc/examples.rst | 12 +++++------
doc/installation.rst | 34 ++++++++++++------------------
setup.py | 4 ++--
4 files changed, 63 insertions(+), 36 deletions(-)
diff --git a/README.rst b/README.rst
index 02b0f6a..27c2169 100644
--- a/README.rst
+++ b/README.rst
@@ -6,6 +6,9 @@ Face verification using Bob
Go to http://pypi.python.org/pypi/bob.example.faceverify to download the latest stable version of this package.
+Overview
+--------
+
This example demonstrates how to use Bob to build different face verification systems.
It includes examples with three different complexities:
@@ -13,23 +16,55 @@ It includes examples with three different complexities:
* An example using Gabor jets and a Gabor-phase based similarity function
* An example building an UBM/GMM model on top of DCT blocks.
+Requirements
+------------
+
To use this example, you will require Bob and the AT&T database.
-If you do not have a Bob version yet, you can get it from http://www.idiap.ch/software/bob.
+The AT&T database
+.................
The AT&T image database is quite small, but sufficient to show how the face verification methods work.
Still, the results may not be meaningful.
One good thing about the AT&T database is that it is freely available.
You can download it from http://www.cl.cam.ac.uk/research/dtg/attarchive/facedatabase.html.
+Bob
+...
+If you do not have a Bob version yet, you can get it from http://www.idiap.ch/software/bob.
+
+If your Bob version is not installed globally or not in the default path, you have to edit the *buildout.cfg* file in the root directory of this package.
+In the ``[buildout]`` section, please add a line ``prefixes = <BOB_INSTALL_DIRECTORY>``, where ``<BOB_INSTALL_DIRECTORY>`` points to the root directory of your local Bob installation.
+
+.. note::
+ If you are at Idiap, Bob is installed globally, so there is no need to specify the ``prefixes``, unless you want to use another version of it.
+
-Finally, to download this package, please open a shell, go to a directory of your choice and call::
- $ pip install bob.example.faceverify
+Download
+--------
-To generate the Documentation, please further go into the "doc" directory and call::
+Finally, to download this package, you can extract the .zip file from the link below, or you open a shell in a directory of your choice and call::
- $ make html
- $ firefox html/index.html
+ $ wget https://pypi.python.org/packages/source/b/bob.example.faceverify/bob.example.faceverify-<version>.zip
+ $ unzip bob.example.faceverify-<version>.zip
+ $ cd bob.example.faceverify-<version>
+
+where <version> should be replaced with a (the current) version of this package, or you can clone our git repository::
+
+ $ git clone https://github.com/bioidiap/bob.example.faceverify.git
+ $ cd bob.example.faceverify
+
+Afterwards, please call::
+
+ $ python bootstrap.py
+ $ ./bin/buildout
+
+to generate the scripts that, amongst others, will run the face verification algorithms. For more details, please refer to the documentation, which you might create and open yourself by::
+
+ $ ./bin/sphinx-build doc sphinx
+ $ firefox sphinx/index.html
(or use any other browser of your choice).
-After you did this, please read the documentation and try to execute the examples.
+
+If you have questions to or problems with this package, please send a request to bob-devel@googlegroups.com, or file a bug under https://github.com/bioidiap/bob.example.faceverify/issues.
+
diff --git a/doc/examples.rst b/doc/examples.rst
index 385a736..d12bfb0 100644
--- a/doc/examples.rst
+++ b/doc/examples.rst
@@ -6,21 +6,21 @@ To run the examples, just call the scripts from within the ``bin`` directory, e.
.. code-block:: sh
- $ bin/eigenface.py
+ $ ./bin/eigenface.py
-If you installed the image database in another folder than ``Database``, please give this directrory as parameter to the script, e.g.:
+If you installed the image database in another folder than ``Database``, please give this directory as parameter to the script, e.g.:
.. code-block:: sh
- $ bin/eigenface.py <AT&T_DATABASE_DIR>
+ $ ./bin/eigenface.py <AT&T_DATABASE_DIR>
There are three example scripts:
.. code-block:: sh
- $ bin/eigenface.py
- $ bin/gabor_phase.py
- $ bin/dct_ubm.py
+ $ ./bin/eigenface.py
+ $ ./bin/gabor_phase.py
+ $ ./bin/dct_ubm.py
that perform more or less complicated face verification experiments.
Each experiment creates an ROC curve that contains the final verification result of the test.
diff --git a/doc/installation.rst b/doc/installation.rst
index 8f9e6ad..6953610 100644
--- a/doc/installation.rst
+++ b/doc/installation.rst
@@ -5,15 +5,24 @@
.. note::
To follow these instructions locally you will need a local copy of this package.
- Start by cloning this project with something like:
+ You can obtain a copy by:
.. code-block:: sh
- $ pip install bob.example.faceverify
+ $ wget https://pypi.python.org/packages/source/b/bob.example.faceverify/bob.example.faceverify-<version>.zip
+ $ unzip bob.example.faceverify-<version>.zip
+ $ cd bob.example.faceverify-<version>
-Installation of the toolkit uses the `buildout <http://www.buildout.org/>`_ build environment.
+ where ``<version>`` is the latest version of the package that you can find under https://pypi.python.org/pypi/bob.example.faceverify, or by cloning our git repository
+
+ .. code-block:: sh
+
+ $ git clone https://github.com/bioidiap/bob.example.faceverify.git
+ $ cd bob.example.faceverify
+
+Installation of this example uses the `buildout <http://www.buildout.org/>`_ build environment.
You don't need to understand its inner workings to use this package.
-Here is a recipe to get you started (shell commands are marked with a ``$`` signal):
+Here is a recipe to get you started:
.. code-block:: sh
@@ -31,23 +40,6 @@ These 2 commands should download and install all non-installed dependencies and
In this case, the above 2 command lines should work as expected.
-Use this example with Bob not installed globally
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If your Bob version is not installed globally, you have to edit the *buildout.cfg* file.
-Please search for the ``egg-directories`` region and set the value according to your local Bob install directory.
-If you are at Idiap, you can simply choose the pre-set directories.
-
-
-Use Bob at Idiap
-~~~~~~~~~~~~~~~~
-To get the example running nicely at Idiap, as noted above, ``bootstrap.py`` has to be executed with the correct python version.
-For Idiap, this is (currently):
-
-.. code-block:: sh
-
- $ /idiap/group/torch5spro/nightlies/externals/v3/ubuntu-10.04-x86_64/bin/python bootstrap.py
- $ ./bin/buildout
-
Downloading the test database
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/setup.py b/setup.py
index 2372c3a..47472fc 100644
--- a/setup.py
+++ b/setup.py
@@ -28,7 +28,7 @@ setup(
# This is the basic information about your project. Modify all this
# information before releasing code publicly.
name='bob.example.faceverify',
- version='0.2.3',
+ version='0.2.4',
description='Example for using Bob to create face verification systems',
url='http://pypi.python.org/pypi/bob.example.faceverify',
license='GPLv3',
@@ -49,7 +49,7 @@ setup(
# privileges when using buildout.
install_requires=[
- "setuptools",
+ "setuptools",
"bob >= 1.1.0", # base signal proc./machine learning library
"xbob.db.atnt", # the AT&T (ORL) database of images
],
--
GitLab