Commit b014e4a5 authored by Amir MOHAMMADI's avatar Amir MOHAMMADI

fix sphinx warnings

parent 997d95c2
Pipeline #36745 passed with stage
in 11 minutes and 50 seconds
...@@ -9,7 +9,7 @@ class Base(bob.bio.base.annotator.Annotator): ...@@ -9,7 +9,7 @@ class Base(bob.bio.base.annotator.Annotator):
---------- ----------
frame_selector : :any:`bob.bio.video.FrameSelector` frame_selector : :any:`bob.bio.video.FrameSelector`
A frame selector class to define, which frames of the video to use. A frame selector class to define, which frames of the video to use.
read_original_data : callable read_original_data : ``callable``
A function with the signature of A function with the signature of
``data = read_original_data(biofile, directory, extension)`` ``data = read_original_data(biofile, directory, extension)``
that will be used to load the data from biofiles. By default the that will be used to load the data from biofiles. By default the
......
...@@ -28,7 +28,7 @@ class FailSafeVideo(Base): ...@@ -28,7 +28,7 @@ class FailSafeVideo(Base):
The maximum number of frames that an annotation is valid for next frames. The maximum number of frames that an annotation is valid for next frames.
This value should be positive. If you want to set max_age to infinite, This value should be positive. If you want to set max_age to infinite,
then you can use the :any:`bob.bio.video.annotator.Wrapper` instead. then you can use the :any:`bob.bio.video.annotator.Wrapper` instead.
validator : callable validator : ``callable``
A function that takes the annotations of a frame and validates it. A function that takes the annotations of a frame and validates it.
......
...@@ -10,7 +10,7 @@ def normalize_annotations(annotations, validator, max_age=-1): ...@@ -10,7 +10,7 @@ def normalize_annotations(annotations, validator, max_age=-1):
strings (starting from 0). The inside dicts contain annotations for that strings (starting from 0). The inside dicts contain annotations for that
frame. The dictionary needs to be an ordered dict in order for this to frame. The dictionary needs to be an ordered dict in order for this to
work. work.
validator : callable validator : ``callable``
Takes a dict (annotations) and returns True if the annotations are valid. Takes a dict (annotations) and returns True if the annotations are valid.
This can be a check based on minimal face size for example: see This can be a check based on minimal face size for example: see
:any:`bob.bio.face.annotator.min_face_size_validator`. :any:`bob.bio.face.annotator.min_face_size_validator`.
......
Markdown is supported
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