add metric type

Author: Matt Sokoloff

labelbox/data/serialization/ndjson/metric.py

@@ -0,0 +1,34 @@
+from labelbox.data.annotation_types.data import TextData, RasterData
+from labelbox.data.annotation_types.metrics import ScalarMetric
+from labelbox.data.serialization.ndjson.base import NDJsonBase
+from typing import Union
+
+
+class NDDataRowScalarMetric(NDJsonBase):
+    metric_value: float
+
+    def to_common(self) -> ScalarMetric:
+        return ScalarMetric(value=self.metric_value, extra={'uuid': self.uuid})
+
+    @classmethod
+    def from_common(
+            cls, metric: ScalarMetric,
+            data: Union[TextData, RasterData]) -> "NDDataRowScalarMetric":
+        return NDDataRowScalarMetric(uuid=metric.extra.get('uuid'),
+                                     metric_value=metric.value,
+                                     data_row={'id': data.uid})
+
+
+class NDMetricAnnotation:
+
+    @classmethod
+    def to_common(cls, annotation: NDDataRowScalarMetric) -> ScalarMetric:
+        return annotation.to_common()
+
+    @classmethod
+    def from_common(cls, annotation: ScalarMetric,
+                    data: Union[TextData, RasterData]) -> NDDataRowScalarMetric:
+        return NDDataRowScalarMetric.from_common(annotation, data)
+
+
+NDMetricType = NDDataRowScalarMetric

tests/data/annotation_types/test_metrics.py

@@ -0,0 +1,29 @@
+from labelbox.data.annotation_types.collection import LabelList
+from labelbox.data.annotation_types import ScalarMetric, Label, RasterData
+
+
+def test_scalar_metric():
+    value = 10
+    metric = ScalarMetric(value=value)
+    assert metric.value == value
+
+    label = Label(data=RasterData(uid="ckrmd9q8g000009mg6vej7hzg"),
+                  annotations=[metric])
+    expected = {
+        'data': {
+            'external_id': None,
+            'uid': 'ckrmd9q8g000009mg6vej7hzg',
+            'im_bytes': None,
+            'file_path': None,
+            'url': None,
+            'arr': None
+        },
+        'annotations': [{
+            'value': 10.0,
+            'extra': {}
+        }],
+        'extra': {},
+        'uid': None
+    }
+    assert label.dict() == expected
+    next(LabelList([label])).dict() == expected

tests/data/assets/ndjson/metric_import.json

@@ -0,0 +1 @@
+[{"uuid" : "a22bbf6e-b2da-4abe-9a11-df84759f7672","dataRow" : {"id": "ckrmdnqj4000007msh9p2a27r"}, "metricValue" : 0.1}]

tests/data/serialization/ndjson/test_metric.py

@@ -0,0 +1,16 @@
+import json
+from labelbox.data.serialization.labelbox_v1.converter import LBV1Converter
+
+from labelbox.data.serialization.ndjson.converter import NDJsonConverter
+
+
+def test_metric():
+    with open('tests/data/assets/ndjson/metric_import.json', 'r') as file:
+        data = json.load(file)
+
+    label_list = NDJsonConverter.deserialize(data).as_list()
+    reserialized = list(NDJsonConverter.serialize(label_list))
+    assert reserialized == data
+
+    # Just make sure that this doesn't break
+    list(LBV1Converter.serialize(label_list))