Added tons of documentation

bob/bio/base/algorithm/BIC.py

@@ -148,3 +148,10 @@ def score(self, model, probe):
       assert len(diff) == self.bic_machine.input_size
       scores.append(self.bic_machine(diff))
     return self.model_fusion_function(scores)
+
+  # re-define unused functions, just so that they do not get documented
+  def train_projector(): raise NotImplementedError()
+  def load_projector(): raise NotImplementedError()
+  def project(): raise NotImplementedError()
+  def write_feature(): raise NotImplementedError()
+  def read_feature(): raise NotImplementedError()

bob/bio/base/algorithm/LDA.py

@@ -25,7 +25,6 @@ def __init__(
       uses_variances = False,
       **kwargs  # parameters directly sent to the base class
   ):
-    """Initializes the LDA tool with the given configuration"""
 
     # call base class constructor and register that the LDA tool performs projection and need the training features split by client
     Algorithm.__init__(
@@ -185,3 +184,7 @@ def score(self, model, probe):
     else:
       # single model, single probe (multiple probes have already been handled)
       return self.factor * self.distance_function(model, probe)
+
+  # re-define unused functions, just so that they do not get documented
+  def train_enroller(): raise NotImplementedError()
+  def load_enroller(): raise NotImplementedError()

bob/bio/base/algorithm/PCA.py

@@ -125,3 +125,7 @@ def score(self, model, probe):
     else:
       # single model, single probe (multiple probes have already been handled)
       return self.factor * self.distance_function(model, probe)
+
+  # re-define unused functions, just so that they do not get documented
+  def train_enroller(): raise NotImplementedError()
+  def load_enroller(): raise NotImplementedError()

bob/bio/base/algorithm/PLDA.py

@@ -161,3 +161,10 @@ def score_for_multiple_probes(self, model, probes):
       return model.log_likelihood_ratio(numpy.vstack(probes))
     else:
       return self.score_set([model.log_likelihood_ratio(probe) for probe in probes])
+
+  # re-define unused functions, just so that they do not get documented
+  def train_projector(): raise NotImplementedError()
+  def load_projector(): raise NotImplementedError()
+  def project(): raise NotImplementedError()
+  def write_feature(): raise NotImplementedError()
+  def read_feature(): raise NotImplementedError()

bob/bio/base/config/grid/local.py

@@ -2,19 +2,19 @@
 
 # define the queue using all the default parameters
 grid = bob.bio.base.grid.Grid(
-  grid = 'local',
+  grid_type = 'local',
   number_of_parallel_processes = 4
 )
 
 
 # define a queue that is highly parallelized
 grid_p8 = bob.bio.base.grid.Grid(
-  grid = 'local',
+  grid_type = 'local',
   number_of_parallel_processes = 8
 )
 
 # define a queue that is highly parallelized
 grid_p16 = bob.bio.base.grid.Grid(
-  grid = 'local',
+  grid_type = 'local',
   number_of_parallel_processes = 16
 )