Fixed all the documentation WARNINGS

parent 3dcf8b86
Pipeline #4138 failed with stage
in 1 minute and 9 seconds
......@@ -7,7 +7,7 @@ import bob.bio.base
from .. import utils
class LDAIR (bob.bio.base.algorithm.Algorithm):
"""This class defines a wrapper for the :py:class:`facerec2010.baseline.lda.LRLDA` class to be used as an image :py:class:`bob.bio.base.algorithm.Algorithm`.
"""This class defines a wrapper for the `facerec2010.baseline.lda.LRLDA` class to be used as an image :py:class:`bob.bio.base.algorithm.Algorithm`.
**Parameters:**
......@@ -66,12 +66,12 @@ class LDAIR (bob.bio.base.algorithm.Algorithm):
**Parameters:**
enroll_features : [:py:class:`facerec2010.baseline.common.FaceRecord`]
enroll_features : [`facerec2010.baseline.common.FaceRecord`]
The features used to enroll the model.
**Returns:**
model : [:py:class:`facerec2010.baseline.common.FaceRecord`]
model : [`facerec2010.baseline.common.FaceRecord`]
The model, which is identical to the ``enroll_features``.
"""
[self._check_feature(f) for f in enroll_features]
......@@ -85,7 +85,7 @@ class LDAIR (bob.bio.base.algorithm.Algorithm):
**Parameters:**
model : [:py:class:`facerec2010.baseline.common.FaceRecord`]
model : [`facerec2010.baseline.common.FaceRecord`]
The model to be written.
model_file : str
......@@ -107,7 +107,7 @@ class LDAIR (bob.bio.base.algorithm.Algorithm):
**Returns:**
model : [:py:class:`facerec2010.baseline.common.FaceRecord`]
model : [`facerec2010.baseline.common.FaceRecord`]
The model read from file.
"""
# just read the model from .pkl file
......@@ -123,10 +123,10 @@ class LDAIR (bob.bio.base.algorithm.Algorithm):
**Parameters:**
model : [:py:class:`facerec2010.baseline.common.FaceRecord`]
model : [`facerec2010.baseline.common.FaceRecord`]
The model to compare, which is actually a list of extracted features.
probe : :py:class:`facerec2010.baseline.common.FaceRecord`
probe : `facerec2010.baseline.common.FaceRecord`
The probe to compare.
**Returns**:
......
......@@ -9,7 +9,7 @@ from .. import utils
class LRPCA (bob.bio.base.algorithm.Algorithm):
"""This class defines a wrapper for the :py:class:`facerec2010.baseline.lda.LRPCA` class to be used as an image :py:class:`bob.bio.base.algorithm.Algorithm`.
"""This class defines a wrapper for the `facerec2010.baseline.lda.LRPCA` class to be used as an image :py:class:`bob.bio.base.algorithm.Algorithm`.
**Parameters:**
......@@ -58,7 +58,7 @@ class LRPCA (bob.bio.base.algorithm.Algorithm):
**Returns:**
model : [:py:class:`facerec2010.baseline.pca.FaceRecord`]
model : [`facerec2010.baseline.pca.FaceRecord`]
The model, which a collection of face records, storing the given ``enroll_features``.
"""
# no rule to enroll features in the LRPCA setup, so we just store all features
......@@ -76,7 +76,7 @@ class LRPCA (bob.bio.base.algorithm.Algorithm):
**Parameters:**
model : [:py:class:`facerec2010.baseline.pca.FaceRecord`]
model : [`facerec2010.baseline.pca.FaceRecord`]
The model to be written.
model_file : str
......@@ -98,7 +98,7 @@ class LRPCA (bob.bio.base.algorithm.Algorithm):
**Returns:**
model : [:py:class:`facerec2010.baseline.pca.FaceRecord`]
model : [`facerec2010.baseline.pca.FaceRecord`]
The model read from file.
"""
# just read the model from .pkl file
......@@ -112,7 +112,7 @@ class LRPCA (bob.bio.base.algorithm.Algorithm):
**Parameters:**
model : [:py:class:`facerec2010.baseline.pca.FaceRecord`]
model : [`facerec2010.baseline.pca.FaceRecord`]
The model to compare, which is actually a list of extracted features.
probe : :py:class:`numpy.ndarray`
......
......@@ -13,7 +13,7 @@ logger = logging.getLogger("bob.bio.csu")
from .. import utils
class LDAIR (bob.bio.base.extractor.Extractor):
"""This class defines a wrapper for the :py:class:`facerec2010.baseline.lda.LRLDA` class to be used as an image :py:class:`bob.bio.base.extractor.Extractor`.
"""This class defines a wrapper for the `facerec2010.baseline.lda.LRLDA` class to be used as an image :py:class:`bob.bio.base.extractor.Extractor`.
**Parameters:**
......@@ -127,7 +127,7 @@ class LDAIR (bob.bio.base.extractor.Extractor):
**Returns:**
extracted : :py:class:`facerec2010.baseline.common.FaceRecord`
extracted : `facerec2010.baseline.common.FaceRecord`
The extracted image feature.
"""
self._check_image(image)
......@@ -144,7 +144,7 @@ class LDAIR (bob.bio.base.extractor.Extractor):
**Parameters:**
feature : :py:class:`facerec2010.baseline.common.FaceRecord`
feature : `facerec2010.baseline.common.FaceRecord`
The extracted feature to be written.
feature_file : str or :py:class:`bob.io.base.HDF5File`
......@@ -167,7 +167,7 @@ class LDAIR (bob.bio.base.extractor.Extractor):
**Returns:**
feature : :py:class:`facerec2010.baseline.common.FaceRecord`
feature : `facerec2010.baseline.common.FaceRecord`
The read feature.
"""
# read the feature from .pkl file
......
......@@ -13,7 +13,7 @@ import logging
logger = logging.getLogger("bob.bio.csu")
class LRPCA (bob.bio.base.extractor.Extractor):
"""This class defines a wrapper for the :py:class:`facerec2010.baseline.lda.LRPCA` class to be used as an image :py:class:`bob.bio.base.extractor.Extractor`.
"""This class defines a wrapper for the `facerec2010.baseline.lda.LRPCA` class to be used as an image :py:class:`bob.bio.base.extractor.Extractor`.
**Parameters:**
......
......@@ -8,7 +8,7 @@ import bob.bio.base
import bob.bio.face
class LDAIR (bob.bio.face.preprocessor.FaceCrop):
"""This class defines a wrapper for the :py:class:`facerec2010.baseline.lda.LRLDA` class to be used as an image :py:class:`bob.bio.base.preprocessor.Preprocessor`.
"""This class defines a wrapper for the `facerec2010.baseline.lda.LRLDA` class to be used as an image :py:class:`bob.bio.base.preprocessor.Preprocessor`.
**Parameters:**
......
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