[DEV] filter_labels

Author: louislac-neovision

src/globox/annotationset.py

@@ -168,14 +168,23 @@ def _labels(self) -> "set[str]":
         return {b.label for b in self.all_boxes}
 
     def filter(self, predicate: Callable[[Annotation], bool]) -> "AnnotationSet":
+        """
+        Filter the dataset by a predicate function that takes an `Annotation` and returns True if the annotation should be kept.
+        """
         return AnnotationSet(annotations=[a for a in self if predicate(a)])
 
     def map(self, func: Callable[[Annotation], Annotation]) -> "AnnotationSet":
+        """
+        Transform the annotations of the annotation set by applying a function to each annotation.
+        """
         return AnnotationSet(annotations=[func(a) for a in self])
 
     def filter_labels(
         self, labels: Iterable[str], keep_empty: bool = False
     ) -> "AnnotationSet":
+        """
+        Filter the annotations by keeping only the bounding boxes with labels in the provided iterable.
+        """
         labels_to_keep = set(labels)
 
         def filter_labels(annotation: "Annotation") -> "Annotation":