rename Base to Annotator

bob/bio/base/annotator/Base.py → bob/bio/base/annotator/Annotator.py

 from bob.bio.base import read_original_data as base_read
-import numpy  # for documentation
 
 
-class Base(object):
-    """Base class for all annotators. This class is meant to be used in
+class Annotator(object):
+    """Annotator class for all annotators. This class is meant to be used in
     conjunction with the bob bio annotate script.
 
     Attributes
@@ -14,7 +13,7 @@ class Base(object):
     """
 
     def __init__(self, read_original_data=None, **kwargs):
-        super(Base, self).__init__(**kwargs)
+        super(Annotator, self).__init__(**kwargs)
         self.read_original_data = read_original_data or base_read
 
     def annotate(self, sample, **kwargs):
@@ -36,6 +35,6 @@ class Base(object):
         """
         raise NotImplementedError
 
-    # Alisa call to annotate
+    # Alias call to annotate
     def __call__(self, sample, **kwargs):
         return self.annotate(sample, **kwargs)

bob/bio/base/annotator/Callable.py

-from .Base import Base
+from . import Annotator
 
 
-class Callable(Base):
+class Callable(Annotator):
     """A class that wraps a callable object that annotates a sample into a
-    bob.bio.annotator object."""
+    bob.bio.annotator object.
+
+    Attributes
+    ----------
+    callable : callable
+        A callable with the following signature:
+        ``annotations = callable(sample, **kwargs)`` that takes numpy array and
+        returns annotations in dictionary format for that biometric sample.
+        Please see :any:`Annotator` for more information.
+    """
 
     def __init__(self, callable, **kwargs):
         super(Callable, self).__init__(**kwargs)

bob/bio/base/annotator/FailSafe.py

 import logging
-from . import Base
+from . import Annotator
 
 logger = logging.getLogger(__name__)
 
 
-class FailSafe(Base):
+class FailSafe(Annotator):
     """A fail-safe annotator.
     This annotator takes a list of annotator and tries them until you get your
     annotations.

bob/bio/base/annotator/__init__.py

-from .Base import Base
+from .Annotator import Annotator
 from .FailSafe import FailSafe
 from .Callable import Callable
 
@@ -23,7 +23,7 @@ def __appropriate__(*args):
 
 
 __appropriate__(
-    Base,
+    Annotator,
     FailSafe,
     Callable,
 )