-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New README and documentation strategy
- Loading branch information
Manuel Guenther
committed
Nov 5, 2014
1 parent
dc2797a
commit 946248e
Showing
11 changed files
with
91 additions
and
154 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,19 @@ | ||
*~ | ||
*.swp | ||
*.pyc | ||
*.so | ||
*.dylib | ||
bin | ||
eggs | ||
parts | ||
.installed.cfg | ||
.mr.developer.cfg | ||
*.egg-info | ||
src | ||
develop-eggs | ||
sphinx | ||
dist | ||
.nfs* | ||
.gdb_history | ||
build | ||
*.egg | ||
src/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,96 +1,50 @@ | ||
.. vim: set fileencoding=utf-8 : | ||
.. Manuel Guenther <manuel.guenther@idiap.ch> | ||
.. Fri Oct 31 14:18:57 CET 2014 | ||
.. image:: http://img.shields.io/badge/docs-stable-yellow.png | ||
:target: http://pythonhosted.org/bob.db.casia_fasd/index.html | ||
.. image:: http://img.shields.io/badge/docs-latest-orange.png | ||
:target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.db.casia_fasd/master/index.html | ||
.. image:: https://travis-ci.org/bioidiap/bob.db.casia_fasd.svg?branch=master | ||
:target: https://travis-ci.org/bioidiap/bob.db.casia_fasd | ||
.. image:: https://coveralls.io/repos/bioidiap/bob.db.casia_fasd/badge.png | ||
:target: https://coveralls.io/r/bioidiap/bob.db.casia_fasd | ||
.. image:: http://img.shields.io/github/tag/bioidiap/bob.db.casia_fasd.png | ||
:target: https://github.com/bioidiap/bob.db.casia_fasd | ||
.. image:: https://img.shields.io/badge/github-master-0000c0.png | ||
:target: https://github.com/bioidiap/bob.db.casia_fasd/tree/master | ||
.. image:: http://img.shields.io/pypi/v/bob.db.casia_fasd.png | ||
:target: https://pypi.python.org/pypi/bob.db.casia_fasd | ||
.. image:: http://img.shields.io/pypi/dm/bob.db.casia_fasd.png | ||
:target: https://pypi.python.org/pypi/bob.db.casia_fasd | ||
.. image:: https://img.shields.io/badge/original-data--files-a000a0.png | ||
:target: http://www.cbsr.ia.ac.cn/english/FaceAntiSpoofDatabases.asp | ||
|
||
=================================== | ||
CASIA Face Anti-Spoofing Database | ||
=================================== | ||
===================================================== | ||
CASIA Face Anti-Spoofing Database Interface for Bob | ||
===================================================== | ||
|
||
The CASIA-FASD database is a spoofing attack database which consists of three | ||
types of attacks: warped printed photographs, printed photographs with cut eyes | ||
and video attacks. The samples are taken with three types of cameras: low | ||
quality, normal quality and high quality. | ||
The CASIA-FASD database is a spoofing attack database which consists of three types of attacks: warped printed photographs, printed photographs with cut eyes and video attacks. | ||
The samples are taken with three types of cameras: low quality, normal quality and high quality. | ||
|
||
The actual raw data for the database should be downloaded from the original | ||
URL. This package only contains the `Bob <http://www.idiap.ch/software/bob/>`_ | ||
accessor methods to use the DB directly from python, with our certified | ||
protocols. | ||
This package contains the Bob_ accessor methods to use the DB directly from python, with our certified protocols. | ||
The actual raw data for `CASIA FASD`_ database should be downloaded from the original URL | ||
|
||
References:: | ||
Reference:: | ||
|
||
1. Z. Zhang, J. Yan, S. Lei, D. Yi, S. Z. Li: "A Face Antispoofing Database | ||
with Diverse Attacks", In proceedings of the 5th IAPR International | ||
Conference on Biometrics (ICB'12), New Delhi, India, 2012. | ||
Z. Zhang, J. Yan, S. Lei, D. Yi, S. Z. Li: "A Face Antispoofing Database with Diverse Attacks", In proceedings of the 5th IAPR International Conference on Biometrics (ICB'12), New Delhi, India, 2012. | ||
|
||
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: | ||
|
||
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 | ||
Installation | ||
------------ | ||
To install this package -- alone or together with other `Packages of Bob <https://github.com/idiap/bob/wiki/Packages>`_ -- please read the `Installation Instructions <https://github.com/idiap/bob/wiki/Installation>`_. | ||
For Bob_ to be able to work properly, some dependent packages are required to be installed. | ||
Please make sure that you have read the `Dependencies <https://github.com/idiap/bob/wiki/Dependencies>`_ for your operating system. | ||
|
||
2. You can manually download and install this package using commands like | ||
``easy_install`` or ``pip``. | ||
Documentation | ||
------------- | ||
For further documentation on this package, please read the `Stable Version <http://pythonhosted.org/bob.db.casia_fasd/index.html>`_ or the `Latest Version <https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.db.casia_fasd/master/index.html>`_ of the documentation. | ||
For a list of tutorials on this or the other packages ob Bob_, or information on submitting issues, asking questions and starting discussions, please visit its website. | ||
|
||
The package is available in two different distribution formats: | ||
.. _bob: https://www.idiap.ch/software/bob | ||
.. _casia fasd: http://www.cbsr.ia.ac.cn/english/FaceAntiSpoofDatabases.asp | ||
|
||
1. You can download it from `PyPI <http://pypi.python.org/pypi>`_, or | ||
|
||
2. You can download it in its source form from `its git repository | ||
<https://github.com/bioidiap/xbob.db.casia_fasd>`_. When you download the | ||
version at the git repository, you will need to run a command to recreate | ||
the backend SQLite file required for its operation. This means that the | ||
database raw files must be installed somewhere in this case. With option | ||
``a`` you can run in `dummy` mode and only download the raw data files for | ||
the database once you are happy with your setup. | ||
|
||
You can mix and match points 1/2 and a/b above based on your requirements. Here | ||
are some examples: | ||
|
||
Modify your setup.py and download from PyPI | ||
=========================================== | ||
|
||
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):: | ||
|
||
install_requires=[ | ||
... | ||
"xbob.db.casia_fasd", | ||
], | ||
|
||
Proceed normally with your ``boostrap/buildout`` steps and you should be all | ||
set. That means you can now import the namespace ``xbob.db.casia_fasd`` into your | ||
scripts. | ||
|
||
Modify your buildout.cfg and download from git | ||
============================================== | ||
|
||
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:: | ||
|
||
[buildout] | ||
... | ||
extensions = mr.developer | ||
auto-checkout = * | ||
eggs = bob | ||
... | ||
xbob.db.casia_fasd | ||
|
||
[sources] | ||
xbob.db.casia_fasd = git https://github.com/bioidiap/xbob.db.casia_fasd.git | ||
... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.