From ac4ab6d3d7746a9ea674eb3c51559d690557e2f6 Mon Sep 17 00:00:00 2001
From: Tiago Freitas Pereira <tiagofrepereira@gmail.com>
Date: Fri, 25 Jun 2021 08:28:06 +0200
Subject: [PATCH] [sphinx] Fixing nightlies
---
bob/bio/vein/config/database/fv3d.py | 15 ++++++---------
bob/bio/vein/config/database/putvein.py | 17 +++++++----------
bob/bio/vein/config/database/utfvp.py | 17 +++++++----------
bob/bio/vein/config/database/verafinger.py | 20 +++++++++++---------
doc/installation.rst | 12 +++++++++---
5 files changed, 40 insertions(+), 41 deletions(-)
diff --git a/bob/bio/vein/config/database/fv3d.py b/bob/bio/vein/config/database/fv3d.py
index cfe1502..2347881 100644
--- a/bob/bio/vein/config/database/fv3d.py
+++ b/bob/bio/vein/config/database/fv3d.py
@@ -16,30 +16,27 @@ from bob.bio.vein.database.fv3d import Database
from bob.bio.base.pipelines.vanilla_biometrics import DatabaseConnector
import logging
+
logger = logging.getLogger("bob.bio.vein")
# Retrieve directory from config
-_fv3d_directory = rc["bob.db.fv3d.directory"]
+_fv3d_directory = rc.get("bob.db.fv3d.directory", "")
"""Value in ``~/.bobrc`` for this dataset directory"""
# Set default protocol if not given via a config file
-if 'protocol' not in locals():
+if "protocol" not in locals():
logger.info("protocol not specified, using default: 'central'")
- protocol = 'central'
+ protocol = "central"
legacy_database = Database(
- original_directory = _fv3d_directory,
- original_extension = '.png',
- protocol = protocol,
+ original_directory=_fv3d_directory, original_extension=".png", protocol=protocol,
)
"""The :py:class:`bob.bio.base.database.BioDatabase` derivative with fv3d
database settings
"""
database = DatabaseConnector(
- legacy_database,
- annotation_type=None,
- fixed_positions=None
+ legacy_database, annotation_type=None, fixed_positions=None
)
"""
The database interface wrapped for vanilla-biometrics
diff --git a/bob/bio/vein/config/database/putvein.py b/bob/bio/vein/config/database/putvein.py
index 9f76d8a..39d7d72 100644
--- a/bob/bio/vein/config/database/putvein.py
+++ b/bob/bio/vein/config/database/putvein.py
@@ -21,29 +21,26 @@ from bob.bio.vein.database.putvein import PutveinBioDatabase
from bob.bio.base.pipelines.vanilla_biometrics import DatabaseConnector
import logging
+
logger = logging.getLogger("bob.bio.vein")
-_putvein_directory = rc["bob.db.putvein.directory"]
+_putvein_directory = rc.get("bob.db.putvein.directory", "")
"""Value in ``~/.bobrc`` for this dataset directory"""
# Set default protocol if not given via a config file
-if 'protocol' not in locals():
+if "protocol" not in locals():
logger.info("protocol not specified, using default: 'wrist-LR_1'")
- protocol = 'wrist-LR_1'
+ protocol = "wrist-LR_1"
legacy_database = PutveinBioDatabase(
- original_directory = _putvein_directory,
- original_extension = '.bmp',
- protocol = protocol,
- )
+ original_directory=_putvein_directory, original_extension=".bmp", protocol=protocol,
+)
"""The :py:class:`bob.bio.base.database.BioDatabase` derivative with PUT Vein
database settings
"""
database = DatabaseConnector(
- legacy_database,
- annotation_type=None,
- fixed_positions=None
+ legacy_database, annotation_type=None, fixed_positions=None
)
"""
diff --git a/bob/bio/vein/config/database/utfvp.py b/bob/bio/vein/config/database/utfvp.py
index 31d91ec..fe3a7c8 100644
--- a/bob/bio/vein/config/database/utfvp.py
+++ b/bob/bio/vein/config/database/utfvp.py
@@ -22,28 +22,25 @@ from bob.bio.vein.database.utfvp import Database
from bob.bio.base.pipelines.vanilla_biometrics import DatabaseConnector
import logging
+
logger = logging.getLogger("bob.bio.vein")
-_utfvp_directory = rc["bob.db.utfvp.directory"]
+_utfvp_directory = rc.get("bob.db.utfvp.directory", "")
"""Value in ``~/.bobrc`` for this dataset directory"""
# Set default protocol if not given via a config file
-if 'protocol' not in locals():
+if "protocol" not in locals():
logger.info("protocol not specified, using default: 'nom'")
- protocol = 'nom'
+ protocol = "nom"
legacy_database = Database(
- original_directory = _utfvp_directory,
- original_extension = '.png',
- protocol = protocol,
- )
+ original_directory=_utfvp_directory, original_extension=".png", protocol=protocol,
+)
"""The :py:class:`bob.bio.base.database.BioDatabase` derivative with UTFVP settings
"""
database = DatabaseConnector(
- legacy_database,
- annotation_type=None,
- fixed_positions=None
+ legacy_database, annotation_type=None, fixed_positions=None
)
"""
The database interface wrapped for vanilla-biometrics
diff --git a/bob/bio/vein/config/database/verafinger.py b/bob/bio/vein/config/database/verafinger.py
index ef4dca1..b4919c7 100644
--- a/bob/bio/vein/config/database/verafinger.py
+++ b/bob/bio/vein/config/database/verafinger.py
@@ -17,25 +17,27 @@ from bob.bio.vein.database.verafinger import Database
from bob.bio.base.pipelines.vanilla_biometrics import DatabaseConnector
import logging
+
logger = logging.getLogger("bob.bio.vein")
-_verafinger_directory = rc["bob.db.verafinger.directory"]
+_verafinger_directory = rc.get("bob.db.verafinger.directory", "")
"""Value in ``~/.bobrc`` for this dataset directory"""
# Set default protocol if not given via a config file
-if 'protocol' not in locals():
+if "protocol" not in locals():
logger.info("protocol not specified, using default: 'Nom'")
- protocol = 'Nom'
+ protocol = "Nom"
"""Updated with the wrapper for the pipelines package"""
-database = DatabaseConnector(Database(
- original_directory=_verafinger_directory,
- original_extension='.png',
- protocol=protocol),
-
+database = DatabaseConnector(
+ Database(
+ original_directory=_verafinger_directory,
+ original_extension=".png",
+ protocol=protocol,
+ ),
annotation_type=None,
- fixed_positions=None
+ fixed_positions=None,
)
"""The :py:class:`bob.bio.base.database.BioDatabase` derivative with Verafinger
database settings, wrapped with the vanilla-biometrics database connector.
diff --git a/doc/installation.rst b/doc/installation.rst
index 5502272..8980cda 100644
--- a/doc/installation.rst
+++ b/doc/installation.rst
@@ -61,9 +61,15 @@ The current system readily supports the following freely available datasets:
After downloading the databases, annotate the base directories in which they
-are installed. Then, follow the instructions in
-:ref:`bob.bio.base.installation` to let this framework know where root
-installation of such databases are located on your system.
+are installed. Then, run the commands below let this framework know where root
+installation of such databases are located on your system:
+
+.. code-block:: sh
+
+ $ bob config set bob.db.fv3d.directory [PATH]
+ $ bob config set bob.db.putvein.directory [PATH]
+ $ bob config set bob.db.utfvp.directory [PATH]
+ $ bob config set bob.db.verafinger.directory [PATH]
Development
--
GitLab