Renamed repository to xbob.example.faceverify; moved content to correct...

Renamed repository to xbob.example.faceverify; moved content to correct directory structure; updated documentation accordingly.

.gitignore

@@ -6,7 +6,7 @@
 .mr.developer.cfg
 eggs/
 develop-eggs/
-bob.example.faceverify.egg-info/
+xbob.example.faceverify.egg-info/
 src/
 bin/
 dist/

MANIFEST.in

@@ -2,5 +2,5 @@ include README.rst
 include bootstrap.py
 include buildout.cfg
 recursive-include doc *.rst *.png conf.py
-recursive-include faceverify/tests *.hdf5
+recursive-include xbob/example/faceverify/tests *.hdf5
 

README.rst

@@ -4,7 +4,7 @@ Face verification using Bob
 .. note::
   If you are reading this page through our GitHub portal and not through PyPI, note the development tip of the package may not be stable or become unstable in a matter of moments.
 
-  Go to http://pypi.python.org/pypi/bob.example.faceverify to download the latest stable version of this package.
+  Go to http://pypi.python.org/pypi/xbob.example.faceverify to download the latest stable version of this package.
 
 Overview
 --------
@@ -13,13 +13,13 @@ This example demonstrates how to use Bob to build different face verification sy
 It includes examples with three different complexities:
 
 * A simple eigenface based example
-* An example using Gabor jets and a Gabor-phase based similarity function
+* An example using Gabor jets in a grid graph
 * 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.
+To use this example, you will require Bob in version of at least 1.2.0. and the AT&T database.
 
 The AT&T database
 .................
@@ -30,7 +30,7 @@ You can download it from http://www.cl.cam.ac.uk/research/dtg/attarchive/facedat
 
 Bob
 ...
-If you do not have a Bob version yet, you can get it from http://www.idiap.ch/software/bob.
+If you do not have a Bob version yet, or your Bob version is too old, you can get a new one 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.
@@ -45,14 +45,14 @@ Download
 
 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::
 
-  $ 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>
+  $ wget https://pypi.python.org/packages/source/b/xbob.example.faceverify/xbob.example.faceverify-<version>.zip
+  $ unzip xbob.example.faceverify-<version>.zip
+  $ cd xbob.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
+  $ git clone https://github.com/bioidiap/xbob.example.faceverify.git
+  $ cd xbob.example.faceverify
 
 Afterwards, please call::
 
@@ -66,5 +66,5 @@ to generate the scripts that, amongst others, will run the face verification alg
 
 (or use any other browser of your choice).
 
-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.
+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/xbob.example.faceverify/issues.
 

buildout.cfg

@@ -7,11 +7,11 @@
 [buildout]
 parts = scripts
 develop = .
-eggs = bob.example.faceverify
+eggs = xbob.example.faceverify
 newest = false
 
 # TODO: remove this prefix
-prefixes = /idiap/group/torch5spro/nightlies/last/install/linux-x86_64-release
+prefixes = /idiap/group/torch5spro/releases/bob-1.2.0/install/linux-x86_64-release
 
 [scripts]
 recipe = xbob.buildout:scripts

doc/examples.rst

@@ -22,7 +22,7 @@ There are three example scripts:
   $ ./bin/gabor_graph.py
   $ ./bin/dct_ubm.py
 
-that perform more or less complicated face verification experiments.
+that perform more or less complicated face verification experiments using an *unbiased* evaluation protocol.
 Each experiment creates an ROC curve that contains the final verification result of the test.
 The generated files will be ``eigenface.png``, ``gabor_graph.png``, and ``dct_ubm.png``.
 
@@ -42,7 +42,7 @@ First, it creates an object to query the database:
 
 .. code-block:: python
 
-  >>> atnt_db = bob.db.atnt.Database()
+  >>> atnt_db = xbob.db.atnt.Database()
 
 For training the projection matrix, the training images need to be read:
 

doc/installation.rst

@@ -9,15 +9,15 @@
 
   .. code-block:: sh
 
-    $ 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>
+    $ wget https://pypi.python.org/packages/source/b/xbob.example.faceverify/xbob.example.faceverify-<version>.zip
+    $ unzip xbob.example.faceverify-<version>.zip
+    $ cd xbob.example.faceverify-<version>
 
-  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
+  where ``<version>`` is the latest version of the package that you can find under https://pypi.python.org/pypi/xbob.example.faceverify, or by cloning our git repository
 
   .. code-block:: sh
 
-    $ git clone https://github.com/bioidiap/bob.example.faceverify.git
+    $ git clone https://github.com/bioidiap/xbob.example.faceverify.git
     $ cd bob.example.faceverify
 
 Installation of this example uses the `buildout <http://www.buildout.org/>`_ build environment.

setup.py

@@ -27,10 +27,10 @@ setup(
 
     # This is the basic information about your project. Modify all this
     # information before releasing code publicly.
-    name='bob.example.faceverify',
-    version='0.4.2',
+    name='xbob.example.faceverify',
+    version='0.5.0',
     description='Example for using Bob to create face verification systems',
-    url='http://pypi.python.org/pypi/bob.example.faceverify',
+    url='http://pypi.python.org/pypi/xbob.example.faceverify',
     license='GPLv3',
     author='Manuel Guenther',
     author_email='manuel.guenther@idiap.ch',
@@ -50,24 +50,32 @@ setup(
 
     install_requires=[
         "setuptools",
-        "bob >= 1.2.0a0",               # base signal proc./machine learning library
+        "bob >= 1.2.0",               # base signal proc./machine learning library
         "xbob.db.atnt",               # the AT&T (ORL) database of images
     ],
 
+    # This package is good examples of namespace implementations
+    # using several layers. You can check them out here:
+    # https://github.com/idiap/bob/wiki/Satellite-Packages
+    namespace_packages = [
+      'xbob',
+      'xbob.example',
+    ],
+
     # This entry defines which scripts you will have inside the 'bin' directory
     # once you install the package (or run 'bin/buildout'). The order of each
     # entry under 'console_scripts' is like this:
     #   script-name-at-bin-directory = module.at.your.library:function
     entry_points={
       'console_scripts': [
-        'eigenface.py = faceverify.eigenface:main',
-        'gabor_graph.py = faceverify.gabor_graph:main',
-        'dct_ubm.py = faceverify.dct_ubm:main'
+        'eigenface.py = xbob.example.faceverify.eigenface:main',
+        'gabor_graph.py = xbob.example.faceverify.gabor_graph:main',
+        'dct_ubm.py = xbob.example.faceverify.dct_ubm:main'
         ],
 
        # bob unittest declaration
       'bob.test': [
-        'faceverify = faceverify.tests:FaceVerifyExampleTest',
+        'faceverify = xbob.example.faceverify.tests:FaceVerifyExampleTest',
         ],
      },
 

xbob/__init__.py

+#see http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages
+__import__('pkg_resources').declare_namespace(__name__)

xbob/example/__init__.py

+#see http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages
+__import__('pkg_resources').declare_namespace(__name__)

faceverify/tests/__init__.py → xbob/example/faceverify/tests/__init__.py

@@ -30,7 +30,7 @@ import numpy, numpy.linalg
 import xbob.db.atnt
 
 import pkg_resources
-import faceverify
+import xbob.example.faceverify
 
 
 regenerate_references = False
@@ -49,13 +49,13 @@ class FaceVerifyExampleTest(unittest.TestCase):
         self.skip_tests = True
 
   def resource(self, f):
-    return pkg_resources.resource_filename('faceverify.tests', f)
+    return pkg_resources.resource_filename('xbob.example.faceverify.tests', f)
 
 
   def test01_eigenface(self):
     # test the eigenface algorithm
     try:
-      from faceverify.eigenface import load_images, train, extract_feature, DISTANCE_FUNCTION
+      from xbob.example.faceverify.eigenface import load_images, train, extract_feature, DISTANCE_FUNCTION
     except ImportError as e:
       raise SkipTest("Skipping the tests since importing from faceverify.eigenface raised exception '%s'"%e)
 
@@ -99,7 +99,7 @@ class FaceVerifyExampleTest(unittest.TestCase):
   def test02_gabor_graph(self):
     # test the gabor phase algorithm
     try:
-      from faceverify.gabor_graph import load_images, extract_feature, ATNT_IMAGE_DIRECTORY, SIMILARITY_FUNCTION
+      from xbob.example.faceverify.gabor_graph import load_images, extract_feature, ATNT_IMAGE_DIRECTORY, SIMILARITY_FUNCTION
     except ImportError as e:
       raise SkipTest("Skipping the tests since importing from faceverify.gabor_phase raised exception '%s'"%e)
 
@@ -137,7 +137,7 @@ class FaceVerifyExampleTest(unittest.TestCase):
   def test03_dct_ubm(self):
     # test the UBM/GMM algorithm
     try:
-      from faceverify.dct_ubm import load_images, extract_feature, train, enroll, stats, NUMBER_OF_GAUSSIANS, ATNT_IMAGE_DIRECTORY
+      from xbob.example.faceverify.dct_ubm import load_images, extract_feature, train, enroll, stats, NUMBER_OF_GAUSSIANS, ATNT_IMAGE_DIRECTORY
     except ImportError as e:
       raise SkipTest("Skipping the tests since importing from faceverify.dct_ubm raised exception '%s'"%e)