lite docs (#793)

Striveworks · Oct 10, 2024 · f4401d7 · f4401d7
1 parent 37aba52
commit f4401d7
Show file tree

Hide file tree

Showing 8 changed files with 1,131 additions and 83 deletions.
diff --git a/lite/tests/semantic_segmentation/test_confusion_matrix.py b/lite/tests/semantic_segmentation/test_confusion_matrix.py
@@ -24,12 +24,12 @@ def test_confusion_matrix_basic_segmentations(
                     "v2": {"v1": {"iou": 0.0}, "v2": {"iou": 0.5}},
                 },
                 "hallucinations": {
-                    "v1": {"percent": 0.0},
-                    "v2": {"percent": 0.5},
+                    "v1": {"ratio": 0.0},
+                    "v2": {"ratio": 0.5},
                 },
                 "missing_predictions": {
-                    "v1": {"percent": 0.5},
-                    "v2": {"percent": 0.0},
+                    "v1": {"ratio": 0.5},
+                    "v2": {"ratio": 0.0},
                 },
             },
             "parameters": {},
@@ -70,15 +70,15 @@ def test_confusion_matrix_segmentations_from_boxes(
                     },
                 },
                 "hallucinations": {
-                    "v1": {"percent": 5000 / 10000},  # 50% overlap
+                    "v1": {"ratio": 5000 / 10000},  # 50% overlap
                     "v2": {
-                        "percent": 4999 / 5000
+                        "ratio": 4999 / 5000
                     },  # overlaps 1 pixel out of 5000 predictions
                 },
                 "missing_predictions": {
-                    "v1": {"percent": 5000 / 10000},
+                    "v1": {"ratio": 5000 / 10000},
                     "v2": {
-                        "percent": 14999 / 15000
+                        "ratio": 14999 / 15000
                     },  # overlaps 1 pixel out of 15,000 groundtruths
                 },
             },

diff --git a/lite/valor_lite/classification/annotation.py b/lite/valor_lite/classification/annotation.py
@@ -3,6 +3,30 @@
 
 @dataclass
 class Classification:
+    """
+    Classification data structure containing a ground truth label and a list of predictions.
+
+    Parameters
+    ----------
+    uid : str
+        Unique identifier for the instance.
+    groundtruth : str
+        The true label for the instance.
+    predictions : list of str
+        List of predicted labels.
+    scores : list of float
+        Confidence scores corresponding to each predicted label.
+
+    Examples
+    --------
+    >>> classification = Classification(
+    ...     uid='123',
+    ...     groundtruth='cat',
+    ...     predictions=['cat', 'dog', 'bird'],
+    ...     scores=[0.9, 0.05, 0.05]
+    ... )
+    """
+
     uid: str
     groundtruth: str
     predictions: list[str]