diff --git a/README.rst b/README.rst index 191f0fc45cf8b7ab361edf53dd63f54176d2f4a2..8555b43bb4d824ecaa3f2429f334cf5cd9939efe 100644 --- a/README.rst +++ b/README.rst @@ -76,6 +76,43 @@ After, the installation steps to run the experiments are given in the documentat Check the "sphinx/index.html" for details on how to run the experiments. + +Running the experiments +----------------------- + +The database class provides a standard interface for training, development and evaluation. +Now, using bob package, all the steps can be automated: training, and evaluation. + +To run the experiment, use the following command: + +.. code-block:: sh + + ./bin/bob bio pipelines vanilla-biometrics -vvv \ + bob.paper.tifs2022_hfr_prepended_domain_transformer.config.mcxfaceprotocols.VIS-THERMAL-split1 \ + bob.paper.tifs2022_hfr_prepended_domain_transformer.config.lightning.x_iresnet_PDT -m + +.. note:: + Note that the first config file specifies the database to be used and the protocol, one can change the config file to + run the experiment for different datasets and protocols. Please inspect the configuration files and pipelines to familiarize the experiments. Please run this job on a GPU machine for faster target. + + +Running the command should launch the training, and once the training is finished, the evaluation process would +start automatically. At the end of the experiment, the score files will be written to the folder corresponding to the +specific protocol and dataset. + +Evaluating results +------------------ + +To evaluate the score files run the following command. + +.. code-block:: python + + ./bin/python bob/paper/tifs2022_hfr_prepended_domain_transformer/scripts/hface_metrics.py -sf path_to_scores-dev.csv + + +It should return AUC, EER, Rank-1 accuracy and Verification rates at different FAR points. + + Contact -------