README.rst 3.09 KB
Newer Older
Manuel Günther's avatar
Manuel Günther committed
1
.. vim: set fileencoding=utf-8 :
2
.. Tiago de Freitas Pereira <tiago.pereira@idiap.ch>
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
3
.. Thu Apr 16 16:39:01 CEST 2015
Elie KHOURY's avatar
Elie KHOURY committed
4

Manuel Günther's avatar
Manuel Günther committed
5
6

=======================================================
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
7
 CUHK Face Sketch Database (CUFS)
Manuel Günther's avatar
Manuel Günther committed
8
9
=======================================================

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
10
This package contains the access API and descriptions for the `CUHK Face Sketch Database (CUFS) <http://mmlab.ie.cuhk.edu.hk/archive/facesketch.html>`. 
11
12
The actual raw data for the database should be downloaded from the original URL. 
This package only contains the Bob accessor methods to use the DB directly from python, with the original protocol of the database.
Elie KHOURY's avatar
Elie KHOURY committed
13

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
14
15
16
17
18
CUHK Face Sketch database (CUFS) is for research on face sketch synthesis and face sketch recognition.
It includes 188 faces from the Chinese University of Hong Kong (CUHK) student database, 123 faces from the AR database, and 295 faces from the XM2VTS database.
There are 606 faces in total.
For each face, there is a sketch drawn by an artist based on a photo taken in a frontal pose, under normal lighting condition, and with a neutral expression.

Elie KHOURY's avatar
Elie KHOURY committed
19

20
21
22
You would normally not install this package unless you are maintaining it. 
What you would do instead is to tie it in at the package you need to **use** it.
There are a few ways to achieve this:
Elie KHOURY's avatar
Elie KHOURY committed
23

24
25
26
27
28
29
1. You can add this package as a requirement at the ``setup.py`` for your own
   `satellite package
   <https://github.com/idiap/bob/wiki/Virtual-Work-Environments-with-Buildout>`_
   or to your Buildout ``.cfg`` file, if you prefer it that way. With this
   method, this package gets automatically downloaded and installed on your
   working environment, or
Elie KHOURY's avatar
Elie KHOURY committed
30

31
32
2. You can manually download and install this package using commands like
   ``easy_install`` or ``pip``.
Elie KHOURY's avatar
Elie KHOURY committed
33

34
The package is available in two different distribution formats:
Elie KHOURY's avatar
Elie KHOURY committed
35

36
1. You can download it from `PyPI <http://pypi.python.org/pypi>`_, or
Elie KHOURY's avatar
Elie KHOURY committed
37

38
2. You can download it in its source form from `its git repository
39
   <https://github.com/bioidiap/bob.db.cuhk_cufs>`_.
Elie KHOURY's avatar
Elie KHOURY committed
40

41
42
You can mix and match points 1/2 and a/b above based on your requirements. Here
are some examples:
Elie KHOURY's avatar
Elie KHOURY committed
43

44
45
Modify your setup.py and download from PyPI
===========================================
Elie KHOURY's avatar
Elie KHOURY committed
46

47
48
49
50
That is the easiest. Edit your ``setup.py`` in your satellite package and add
the following entry in the ``install_requires`` section (note: ``...`` means
`whatever extra stuff you may have in-between`, don't put that on your
script)::
51

52
53
    install_requires=[
      ...
54
      "bob.db.cuhk_cufs",
55
    ],
56

57
Proceed normally with your ``boostrap/buildout`` steps and you should be all
58
set. That means you can now import the ``bob.db.cuhk_cufs`` namespace into your scripts.
59

60
61
Modify your buildout.cfg and download from git
==============================================
Elie KHOURY's avatar
Elie KHOURY committed
62

63
64
65
66
You will need to add a dependence to `mr.developer
<http://pypi.python.org/pypi/mr.developer/>`_ to be able to install from our
git repositories. Your ``buildout.cfg`` file should contain the following
lines::
Elie KHOURY's avatar
Elie KHOURY committed
67

68
69
70
71
  [buildout]
  ...
  extensions = mr.developer
  auto-checkout = *
72
  eggs = bob.db.cuhk_cufs
Elie KHOURY's avatar
Elie KHOURY committed
73

74
  [sources]
75
  bob.db.cuhk_cufs = git https://github.com/bioidiap/bob.db.cuhk_cufs.git
76
  ...