Updated documentation

parent d5f4c92c
Pipeline #25807 passed with stages
in 13 minutes and 3 seconds
.. vim: set fileencoding=utf-8 :
.. Tiago de Freitas Pereira <tiago.pereira@idiap.ch>
====
FAQ
====
......@@ -6,4 +6,130 @@
================================================================
This section contains instructions on how to reproduce the experiments from Chapter 4 **Heterogeneous Face Recognition as a Session Variability Problem**.
Exceptionally, these instructions will cover only the **Thermal** database.
This would avoid this section to be extremely large.
However, the same set of instructions applies to ALL heterogeneous face databases.
To see all the available databases, check::
$ resources.py --types database
List of registered databases:
- bob.bio.htface 1.0.0 @ <experiment>/bob.bio.htface:
+ casia-nir-vis-2 --> bob.bio.htface.configs.databases.casia_nir_vis: database
+ cuhk-cufs --> bob.bio.htface.configs.databases.cuhk_cufs: database
+ cuhk-cufsf --> bob.bio.htface.configs.databases.cuhk_cufsf: database
+ eprip --> bob.bio.htface.configs.databases.eprip: database
+ fargo --> bob.bio.htface.configs.databases.fargo: database
+ fargo_depth --> bob.bio.htface.configs.databases.fargo_depth: database
+ ldhf --> bob.bio.htface.configs.databases.ldhf: database
+ nivl --> bob.bio.htface.configs.databases.nivl: database
+ pola_thermal --> bob.bio.htface.configs.databases.pola_thermal: database
+ thermal --> bob.bio.htface.configs.databases.thermal: database
Thermal Experiments
===================
The sequence of experiments in this subsection generates the necessary data that creates Figures 4.11.
This covers the training using DCT coefficients and LBP histograms.
DCT Coefficients
----------------
The sequence of experiments in this subsection generates the necessary data to generate Figure 4.11 and Table 4.7.
First, the experiments should be generated::
$ bob bio htface htface_baseline isv_g64_u50 thermal -vv
$ bob bio htface htface_baseline isv_g128_u50 thermal -vv
$ bob bio htface htface_baseline isv_g256_u50 thermal -vv
$ bob bio htface htface_baseline isv_g512_u50 thermal -vv
$ bob bio htface htface_baseline isv_g1024_u50 thermal -vv
Once the experiments are executed, the plots and metrics can be generated with the following command::
$ bob htface evaluate_and_squash \
\
<experiment_path>/thermal/isv_g64_u50/ \
<experiment_path>/thermal/isv_g128_u50/ \
<experiment_path>/thermal/isv_g256_u50/ \
<experiment_path>/thermal/isv_g512_u50/ \
<experiment_path>/thermal/isv_g1024_u50/ \
\
--legends "64" --legends "128" --legends "256" --legends "512" --legends "1024" \
--report-name "thermal.pdf" \
--x-min 1 \
--title ""
If everything goes alright the following plot should be dumped
.. image:: ./img/chap4/thermal_dct.png
:scale: 100 %
LBP Histograms
--------------
The sequence of experiments in this subsection generates the necessary data to generate Figure 4.11 and Table 4.7.
First, the experiments should be generated::
$ bob bio htface htface_baseline isv_g64_u50_LBP thermal -vv
$ bob bio htface htface_baseline isv_g128_u50_LBP thermal -vv
$ bob bio htface htface_baseline isv_g256_u50_LBP thermal -vv
$ bob bio htface htface_baseline isv_g512_u50_LBP thermal -vv
$ bob bio htface htface_baseline isv_g1024_u50_LBP thermal -vv
Once the experiments are executed, the plots and metrics can be generated with the following command::
$ bob htface evaluate_and_squash \
\
<experiment_path>/thermal/isv_g64_u50_LBP/ \
<experiment_path>/thermal/isv_g128_u50_LBP/ \
<experiment_path>/thermal/isv_g256_u50_LBP/ \
<experiment_path>/thermal/isv_g512_u50_LBP/ \
<experiment_path>/thermal/isv_g1024_u50_LBP/ \
\
--legends "64" --legends "128" --legends "256" --legends "512" --legends "1024" \
--report-name "thermal_LBP.pdf" \
--x-min 1 \
--title ""
If everything goes alright the following plot should be dumped
.. image:: ./img/chap4/thermal_lbp.png
:scale: 100 %
ISV Intuition
=============
The ISV intuition showed in Figures 4.1 and 4.2 can also be plotted.
This can be generated with the following command::
$ bob bio htface isv_intuition <OUTPUT_FILE.pdf>
If everything goes alright the following plots should be dumped
.. image:: ./img/chap4/ISV_intuition-0.png
:scale: 70 %
.. image:: ./img/chap4/ISV_intuition-1.png
:scale: 70 %
.. image:: ./img/chap4/ISV_intuition-2.png
:scale: 70 %
.. image:: ./img/chap4/ISV_intuition-3.png
:scale: 70 %
This diff is collapsed.
......@@ -12,31 +12,46 @@ The goal of this package is to provide the instructions to reproduce ALL the exp
This package is an extension of the
`bob.bio.base <https://www.idiap.ch/software/bob/docs/bob/bob.bio.base/stable/index.html>`_ framework.
=============
Installation
=============
The installation instructions are based on conda (**LINUX ONLY**).
Installation
============
The installation instructions are based on conda (**LINUX and MACOSX ONLY**).
Please `install conda <https://conda.io/docs/install/quick.html#linux-miniconda-install>`_ before continuing.
After everything installed do::
With miniconda set, do the following steps::
$ conda install bob.thesis.tiago
$ bob bio htface --help
$ conda install bob.thesis.tiago #Installation
$ bob bio htface --help #Checking if everything is alright
Usage: bob bio htface [OPTIONS] COMMAND [ARGS]...
Face Ongoing Commands.
Options:
-h, -?, --help Show this message and exit.
Commands:
create_block_image This click command generates as block based...
evaluate_and_squash This script runs CMC, DET plots and...
fft_analysis This click command does FFT ANALISYS of some...
filter_ldhf This click command take as input the scores...
htface_baseline Run a biometric recognition baseline.
htface_train_dsu Trains a CNN using the domain specific units...
isv_intuition This click command plots the ISV intuition...
If you are interested in the Domain Specific Units chapter, you must download all the priors used.
Typing the command below will download and set everything::
$ bob bio face_ongoing download_models
If you want to **DEVELOP** this package, follow below one possible set of instructions::
$ git clone https://gitlab.idiap.ch/bob/bob.thesis.tiago
$ cd bob.thesis.tiago
$ conda env create -f environment.yml
$ source activate bob.bio.htface # activate the environment
$ buildout
.. warning::
Before the magic begins, it's necessary to set a set of paths for the databases.
Sorry, but there is no other way.
Please, edit this file according to your own working environment::
Please, edit this file according to your own work environment::
$ vim ~/.bobrc
......@@ -64,7 +79,14 @@ Follow below how this file looks like::
"bob.bio.htface.cufsf_path": "[CUHK-CUFSF-PATH]",
"bob.bio.htface.feret_path": "[FERET-PATH]",
"bob.bio.htface.cufsf_extension": [".jpg",".tif"],
"bob.bio.htface.fargo_path":"[FARGO-DB-PATH]",
"bob.bio.htface.fargo_annotations":"[FARGO-ANNOTATIONS-PATH]",
"bob.bio.htface.ldhf_path": "[LDHF-PATH]",
"bob.bio.htface.ldhf_extension": ".JPG",
"bob.bio.face_ongoing.idiap_casia_inception_v1_centerloss_gray": "[INCEPTIONV1-GRAY-MODEL-PATH]",
"bob.bio.face_ongoing.idiap_casia_inception_v1_centerloss_rgb": "[INCEPTIONV1-RGB-MODEL-PATH],
"bob.bio.face_ongoing.idiap_casia_inception_v2_centerloss_gray": "[INCEPTIONV2-GRAY-MODEL-PATH],
......@@ -79,6 +101,21 @@ Follow below how this file looks like::
.. warning::
Sorry, but there is no other way, you have to set all these things
Instructions for developers
---------------------------
If you want to **DEVELOP** this package, follow below one possible set of instructions::
$ git clone https://gitlab.idiap.ch/bob/bob.thesis.tiago
$ cd bob.thesis.tiago
$ conda env create -f environment.yml
$ source activate bob.bio.htface # activate the environment
$ buildout
========
The task
......@@ -118,6 +155,16 @@ Hypotheses
chapter_5
========
See also
========
.. toctree::
:maxdepth: 2
FAQ
==========
References
==========
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment