From 3530ef72c52805c64b924bd579b7de58d466a057 Mon Sep 17 00:00:00 2001 From: Matthias Bisping Date: Mon, 11 Apr 2022 13:37:46 +0200 Subject: [PATCH] docstring update --- .../extractor_classifier/extractor_classifier.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/image_prediction/extractor_classifier/extractor_classifier.py b/image_prediction/extractor_classifier/extractor_classifier.py index 31b9c46..83f2b2c 100644 --- a/image_prediction/extractor_classifier/extractor_classifier.py +++ b/image_prediction/extractor_classifier/extractor_classifier.py @@ -7,8 +7,10 @@ from image_prediction.utils.generic import chunk_iterable class ExtractorClassifier: - """Extracts images from an object and classifies them. When called, returns an iterable of dictionaries, where - each dictionary has a filed 'label' for the classification and possibly additional fields for metadata.""" + """This class is responsible for orchestrating the pairing of classifications and image metadata. It extracts images + from an object and classifies them. Then it ties the classification together with the metadata. It returns an + iterable of dictionaries, where each dictionary has a field 'label' for the classification and possibly additional + fields for metadata -- metadata could be void.""" def __init__(self, image_extractor: ImageExtractor, image_classifier: ImageClassifier): self.classifier = image_classifier