Commit 2cc95795 authored by Amir MOHAMMADI's avatar Amir MOHAMMADI
Browse files

explain that annotator keys should be universal

parent 27820995
Pipeline #17503 failed with stage
in 25 minutes and 17 seconds
from bob.bio.base.annotator import Annotator
from bob.bio.face.preprocessor import FaceCrop # import for documentation
class Base(Annotator):
......@@ -8,9 +9,11 @@ class Base(Annotator):
super(Base, self).__init__(**kwargs)
def annotate(self, sample, **kwargs):
"""Annotates an image and returns annotations in a dictionary.
All annotator should return at least the topleft and bottomright
coordinates.
"""Annotates an image and returns annotations in a dictionary. All
annotator should return at least the ``topleft`` and ``bottomright``
coordinates. Some currently known annotation points such as ``reye``
and ``leye`` are formalized in
:any:`FaceCrop`.
Parameters
----------
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment