From 81f38592d1010fb4ceaee54fa192731aa7c7ae50 Mon Sep 17 00:00:00 2001 From: Tiago Freitas Pereira <tiagofrepereira@gmail.com> Date: Tue, 5 May 2020 12:19:12 +0200 Subject: [PATCH] Changed again the documentation of functions --- bob/bio/base/pipelines/vanilla_biometrics/legacy.py | 2 +- bob/bio/base/transformers/algorithm.py | 2 +- bob/bio/base/transformers/extractor.py | 2 +- bob/bio/base/transformers/preprocessor.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/bob/bio/base/pipelines/vanilla_biometrics/legacy.py b/bob/bio/base/pipelines/vanilla_biometrics/legacy.py index 3dd74ec7..f1279b05 100644 --- a/bob/bio/base/pipelines/vanilla_biometrics/legacy.py +++ b/bob/bio/base/pipelines/vanilla_biometrics/legacy.py @@ -169,7 +169,7 @@ class BioAlgorithmLegacy(BioAlgorithm): Parameters ---------- instance: object - Callable function that instantiates the :any:`bob.bio.base.algorithm.Algorithm` + An instance of :any:`bob.bio.base.algorithm.Algorithm` Example diff --git a/bob/bio/base/transformers/algorithm.py b/bob/bio/base/transformers/algorithm.py index b60adf4a..68e55d38 100644 --- a/bob/bio/base/transformers/algorithm.py +++ b/bob/bio/base/transformers/algorithm.py @@ -27,7 +27,7 @@ class AlgorithmTransformer(TransformerMixin, BaseEstimator): Parameters ---------- instance: object - Callable function that instantiates the bob.bio.base.algorithm.Algorithm + An instance of bob.bio.base.algorithm.Algorithm """ diff --git a/bob/bio/base/transformers/extractor.py b/bob/bio/base/transformers/extractor.py index bad554c2..c25bcfd9 100644 --- a/bob/bio/base/transformers/extractor.py +++ b/bob/bio/base/transformers/extractor.py @@ -14,7 +14,7 @@ class ExtractorTransformer(TransformerMixin, BaseEstimator): ---------- instance: object - Instance of `bob.bio.base.extractor.Extractor` + An instance of `bob.bio.base.extractor.Extractor` model_path: ``str`` Model path in case :any:`bob.bio.base.extractor.Extractor.requires_training` is equals to true diff --git a/bob/bio/base/transformers/preprocessor.py b/bob/bio/base/transformers/preprocessor.py index fcb5dfab..1b1e15c2 100644 --- a/bob/bio/base/transformers/preprocessor.py +++ b/bob/bio/base/transformers/preprocessor.py @@ -12,7 +12,7 @@ class PreprocessorTransformer(TransformerMixin, BaseEstimator): ---------- instance: object - Instance of `bob.bio.base.preprocessor.Preprocessor` + An instance of `bob.bio.base.preprocessor.Preprocessor` """ -- GitLab