From 782ae14bff38ae2f9ebd81d367d1e430e9489590 Mon Sep 17 00:00:00 2001
From: "akomaty@idiap.ch" <akomaty@idiap.ch>
Date: Mon, 8 May 2017 18:22:59 +0200
Subject: [PATCH] removed unnecessary commands starting with ./bin/
---
bob/bio/face/script/baselines.py | 6 +++---
bob/bio/face/script/display_face_annotations.py | 2 +-
doc/baselines.rst | 16 ++++++++--------
doc/implementation.rst | 8 ++++----
4 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/bob/bio/face/script/baselines.py b/bob/bio/face/script/baselines.py
index fe71ad33..f3a9a369 100755
--- a/bob/bio/face/script/baselines.py
+++ b/bob/bio/face/script/baselines.py
@@ -59,8 +59,8 @@ def command_line_arguments(command_line_parameters):
# - the database to choose
parser.add_argument('-b', '--baseline-directory', default = 'baselines', help = 'The sub-directory, where the baseline results are stored.')
# - the directories to write to
- parser.add_argument('-T', '--temp-directory', help = 'The directory to write temporary the data of the experiment into. If not specified, the default directory of the verify.py script is used (see ./bin/verify.py --help).')
- parser.add_argument('-R', '--result-directory', help = 'The directory to write the resulting score files of the experiment into. If not specified, the default directories of the verify.py script are used (see ./bin/verify.py --help).')
+ parser.add_argument('-T', '--temp-directory', help = 'The directory to write temporary the data of the experiment into. If not specified, the default directory of the verify.py script is used (see verify.py --help).')
+ parser.add_argument('-R', '--result-directory', help = 'The directory to write the resulting score files of the experiment into. If not specified, the default directories of the verify.py script are used (see verify.py --help).')
# - use the Idiap grid -- option is only useful if you are at Idiap
parser.add_argument('-g', '--grid', action = 'store_true', help = 'Execute the algorithm in the SGE grid.')
@@ -76,7 +76,7 @@ def command_line_arguments(command_line_parameters):
parser.add_argument('-e', '--evaluate', nargs='+', choices = ('EER', 'HTER', 'ROC', 'DET', 'CMC', 'RR'), help = 'Evaluate the results of the algorithms (instead of running them) using the given evaluation techniques.')
# - other parameters that are passed to the underlying script
- parser.add_argument('parameters', nargs = argparse.REMAINDER, help = 'Parameters directly passed to the ./bin/verify.py script.')
+ parser.add_argument('parameters', nargs = argparse.REMAINDER, help = 'Parameters directly passed to the verify.py script.')
bob.core.log.add_command_line_option(parser)
args = parser.parse_args(command_line_parameters)
diff --git a/bob/bio/face/script/display_face_annotations.py b/bob/bio/face/script/display_face_annotations.py
index 6421c020..92b22c44 100644
--- a/bob/bio/face/script/display_face_annotations.py
+++ b/bob/bio/face/script/display_face_annotations.py
@@ -1,7 +1,7 @@
#!../bin/python
"""This script displays the iamges with annotations provided by any face database.
-Basically, anything that can be used as a --database for .bin/verify.py can be specified here as well, including configuration files and ``database`` resources: ``./bin/resources.py -d database``.
+Basically, anything that can be used as a --database for verify.py can be specified here as well, including configuration files and ``database`` resources: ``resources.py -d database``.
By default, all images and their corresponding annotations are displayed, and you have to press ``Enter`` after each image.
If the database does not include annotations, or you want to display a different set of annotations, you can specify the ``--annotation-directory`` (and if required modify the ``--annotation-file-extension`` and ``--annotation-file-type``.
diff --git a/doc/baselines.rst b/doc/baselines.rst
index b3ede11c..74117f56 100644
--- a/doc/baselines.rst
+++ b/doc/baselines.rst
@@ -24,14 +24,14 @@ How this is done is explained in more detail in the :ref:`bob.bio.base.installat
Running Baseline Experiments
----------------------------
-To run the baseline experiments, you can use the ``./bin/baselines.py`` script by just going to the console and typing:
+To run the baseline experiments, you can use the ``baselines.py`` script by just going to the console and typing:
.. code-block:: sh
- $ ./bin/baselines.py
+ $ baselines.py
-This script is a simple wrapper for the ``./bin/verify.py`` script that is explained in more detail in :ref:`bob.bio.base.experiments`.
-The ``./bin/baselines.py --help`` option shows you, which other options you have.
+This script is a simple wrapper for the ``verify.py`` script that is explained in more detail in :ref:`bob.bio.base.experiments`.
+The ``baselines.py --help`` option shows you, which other options you have.
Here is an almost complete extract:
* ``--database``: The database and protocol you want to use.
@@ -47,13 +47,13 @@ Here is an almost complete extract:
By default, only the commands that are executed are printed, and the rest of the calculation runs quietly.
You can increase the verbosity by adding the ``--verbose`` parameter repeatedly (up to three times).
-Usually it is a good idea to have at least verbose level 2 (i.e., calling ``./bin/baselines.py --verbose --verbose``, or the short version ``./bin/baselines.py -vv``).
+Usually it is a good idea to have at least verbose level 2 (i.e., calling ``baselines.py --verbose --verbose``, or the short version ``baselines.py -vv``).
Running in Parallel
~~~~~~~~~~~~~~~~~~~
To run the experiments in parallel, as usual you can define an SGE grid configuration, or run with parallel threads on the local machine.
-For the ``./bin/baselines.py`` script, the grid configuration is adapted to each of the algorithms.
+For the ``baselines.py`` script, the grid configuration is adapted to each of the algorithms.
Hence, to run in the SGE grid, you can simply add the ``--grid`` command line option, without parameters.
Similarly, to run the experiments in parallel on the local machine, simply add a ``--parallel <N>`` option, where ``<N>`` specifies the number of parallel jobs you want to execute.
@@ -149,14 +149,14 @@ Additionally, the following algorithms can be executed, when the :ref:`bob.bio.c
Baseline Results
----------------
-To evaluate the results, a wrapper call to ``./bin/evaluate.py`` is produced by the ``./bin/baselines.py --evaluate`` command.
+To evaluate the results, a wrapper call to ``evaluate.py`` is produced by the ``baselines.py --evaluate`` command.
Several types of evaluation can be achieved, see :ref:`bob.bio.base.evaluate` for details.
Particularly, here we can enable ROC curves, DET plots, CMC curves and the computation of EER/HTER.
Hence, the complete set of results of the baseline experiments are generated using:
.. code-block:: sh
- $ ./bin/baselines.py --all -vv --evaluate ROC DET CMC HTER
+ $ baselines.py --all -vv --evaluate ROC DET CMC HTER
If you specified other parameters for the execution of the algorithms, e.g., the ``--directory`` flag, you have to add these options here as well.
If you ran only a sub-set of the available, the missing algorithms will just be skipped.
diff --git a/doc/implementation.rst b/doc/implementation.rst
index ab86ee84..e765d178 100644
--- a/doc/implementation.rst
+++ b/doc/implementation.rst
@@ -98,7 +98,7 @@ All databases rely on the :py:class:`bob.bio.base.database.BioDatabase` interfac
Please check the link above for information on how to obtain the original data of those data sets.
After downloading and extracting the original data of the data sets, it is necessary that the scripts know, where the data was installed.
-For this purpose, the ``./bin/verify.py`` script can read a special file, where those directories are stored, see :ref:`bob.bio.base.installation`.
+For this purpose, the ``verify.py`` script can read a special file, where those directories are stored, see :ref:`bob.bio.base.installation`.
By default, this file is located in your home directory, but you can specify another file on command line.
The other option is to change the directories directly inside the configuration files.
@@ -171,10 +171,10 @@ Here is the list of files and replacement strings for all databases that are reg
- Images: ``[YOUR_XM2VTS_DIRECTORY]``
-You can use the ``./bin/databases.py`` script to list, which data directories are correctly set up.
+You can use the ``databases.py`` script to list, which data directories are correctly set up.
-In order to view the annotations inside your database on top of the images, you can use the ``./bin/display_face_annotations.py`` script that is provided.
-Please see ``./bin/display_face_annotations.py --help`` for more details and a list of options.
+In order to view the annotations inside your database on top of the images, you can use the ``display_face_annotations.py`` script that is provided.
+Please see ``display_face_annotations.py --help`` for more details and a list of options.
.. _bob.bio.face.preprocessors:
--
GitLab