support keyframes in videos

Author: Matt Sokoloff

labelbox/data/annotation_types/classification/classification.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Union
 
 try:
     from typing import Literal
@@ -28,15 +28,24 @@ class ClassificationAnswer(FeatureSchema):
     extra: Dict[str, Any] = {}
 
 
+class VideoClassificationAnswer(ClassificationAnswer):
+    """
+    Each answer can have a key frame indepdent of the others.
+    So unlike object annotations, classification annotations
+      track key frames at a classification answer level.
+    """
+    keyframe: bool
+
+
 class Radio(BaseModel):
     """ A classification with only one selected option allowed """
-    answer: ClassificationAnswer
+    answer: Union[VideoClassificationAnswer, ClassificationAnswer]
 
 
 class Checklist(_TempName):
     """ A classification with many selected options allowed """
     name: Literal["checklist"] = "checklist"
-    answer: List[ClassificationAnswer]
+    answer: Union[VideoClassificationAnswer, ClassificationAnswer]
 
 
 class Text(BaseModel):
@@ -50,4 +59,4 @@ class Dropdown(_TempName):
     - This is not currently compatible with MAL.
     """
     name: Literal["dropdown"] = "dropdown"
-    answer: List[ClassificationAnswer]
+    answer: List[Union[VideoClassificationAnswer, ClassificationAnswer]]

labelbox/data/serialization/labelbox_v1/classification.py

@@ -1,3 +1,4 @@
+from labelbox.data.annotation_types.classification.classification import VideoClassificationAnswer
 from typing import List, Union
 
 from pydantic.main import BaseModel
@@ -12,27 +13,44 @@ class LBV1ClassificationAnswer(LBV1Feature):
     ...
 
 
+def get_classification_answer(
+    answer: LBV1ClassificationAnswer
+) -> Union[ClassificationAnswer, VideoClassificationAnswer]:
+    kwargs = dict(feature_schema_id=answer.schema_id,
+                  name=answer.title,
+                  extra={
+                      'feature_id': answer.feature_id,
+                      'value': answer.value
+                  })
+    if answer.keyframe is not None:
+        return VideoClassificationAnswer(keyframe=answer.keyframe, **kwargs)
+    else:
+        return ClassificationAnswer(**kwargs)
+
+
+def get_lbv1_classification_answer(answer: Union[ClassificationAnswer,
+                                                 VideoClassificationAnswer]):
+    return LBV1ClassificationAnswer(
+        schema_id=answer.feature_schema_id,
+        title=answer.name,
+        value=answer.extra.get('value'),
+        feature_id=answer.extra.get('feature_id'),
+        keyframe=getattr(answer, 'keyframe',
+                         None)  # Only applies to video clasifications
+    )
+
+
 class LBV1Radio(LBV1Feature):
     answer: LBV1ClassificationAnswer
 
     def to_common(self) -> Radio:
-        return Radio(answer=ClassificationAnswer(
-            feature_schema_id=self.answer.schema_id,
-            name=self.answer.title,
-            extra={
-                'feature_id': self.answer.feature_id,
-                'value': self.answer.value
-            }))
+        return Radio(answer=get_classification_answer(self.answer))
 
     @classmethod
     def from_common(cls, radio: Radio, feature_schema_id: Cuid,
                     **extra) -> "LBV1Radio":
         return cls(schema_id=feature_schema_id,
-                   answer=LBV1ClassificationAnswer(
-                       schema_id=radio.answer.feature_schema_id,
-                       title=radio.answer.name,
-                       value=radio.answer.extra.get('value'),
-                       feature_id=radio.answer.extra.get('feature_id')),
+                   answer=get_lbv1_classification_answer(radio.answer),
                    **extra)
 
 
@@ -41,24 +59,15 @@ class LBV1Checklist(LBV1Feature):
 
     def to_common(self) -> Checklist:
         return Checklist(answer=[
-            ClassificationAnswer(feature_schema_id=answer.schema_id,
-                                 name=answer.title,
-                                 extra={
-                                     'feature_id': answer.feature_id,
-                                     'value': answer.value
-                                 }) for answer in self.answers
+            get_classification_answer(answer) for answer in self.answers
         ])
 
     @classmethod
     def from_common(cls, checklist: Checklist, feature_schema_id: Cuid,
                     **extra) -> "LBV1Checklist":
         return cls(schema_id=feature_schema_id,
                    answers=[
-                       LBV1ClassificationAnswer(
-                           schema_id=answer.feature_schema_id,
-                           title=answer.name,
-                           value=answer.extra.get('value'),
-                           feature_id=answer.extra.get('feature_id'))
+                       get_lbv1_classification_answer(answer)
                        for answer in checklist.answer
                    ],
                    **extra)
@@ -69,24 +78,15 @@ class LBV1Dropdown(LBV1Feature):
 
     def to_common(self) -> Dropdown:
         return Dropdown(answer=[
-            ClassificationAnswer(feature_schema_id=answer.schema_id,
-                                 name=answer.title,
-                                 extra={
-                                     'feature_id': answer.feature_id,
-                                     'value': answer.value
-                                 }) for answer in self.answer
+            get_classification_answer(answer) for answer in self.answer
         ])
 
     @classmethod
     def from_common(cls, dropdown: Dropdown, feature_schema_id: Cuid,
                     **extra) -> "LBV1Dropdown":
         return cls(schema_id=feature_schema_id,
                    answer=[
-                       LBV1ClassificationAnswer(
-                           schema_id=answer.feature_schema_id,
-                           title=answer.name,
-                           value=answer.extra.get('value'),
-                           feature_id=answer.extra.get('feature_id'))
+                       get_lbv1_classification_answer(answer)
                        for answer in dropdown.answer
                    ],
                    **extra)