docstring update

This commit is contained in:
Matthias Bisping 2022-04-11 13:37:46 +02:00
parent d80af336eb
commit 3530ef72c5

View File

@ -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