valor-lite 0.33.14__py3-none-any.whl → 0.33.16__py3-none-any.whl

valor_lite/classification/metric.py

@@ -1,3 +1,4 @@
+from dataclasses import dataclass
 from enum import Enum
 
 from valor_lite.schemas import BaseMetric
@@ -14,6 +15,7 @@ class MetricType(Enum):
     ConfusionMatrix = "ConfusionMatrix"
 
 
+@dataclass
 class Metric(BaseMetric):
     """
     Classification Metric.
@@ -28,6 +30,24 @@ class Metric(BaseMetric):
         A dictionary containing metric parameters.
     """
 
+    def __post_init__(self):
+        if not isinstance(self.type, str):
+            raise TypeError(
+                f"Metric type should be of type 'str': {self.type}"
+            )
+        elif not isinstance(self.value, (int, float, dict)):
+            raise TypeError(
+                f"Metric value must be of type 'int', 'float' or 'dict': {self.value}"
+            )
+        elif not isinstance(self.parameters, dict):
+            raise TypeError(
+                f"Metric parameters must be of type 'dict[str, Any]': {self.parameters}"
+            )
+        elif not all([isinstance(k, str) for k in self.parameters.keys()]):
+            raise TypeError(
+                f"Metric parameter dictionary should only have keys with type 'str': {self.parameters}"
+            )
+
     @classmethod
     def precision(
         cls,

valor_lite/object_detection/computation.py

@@ -408,17 +408,20 @@ def compute_precion_recall(
 
             # calculate component metrics
             recall = np.zeros_like(tp_count)
-            precision = np.zeros_like(tp_count)
             np.divide(tp_count, gt_count, where=gt_count > 1e-9, out=recall)
+
+            precision = np.zeros_like(tp_count)
             np.divide(tp_count, pd_count, where=pd_count > 1e-9, out=precision)
+
             fn_count = gt_count - tp_count
 
             f1_score = np.zeros_like(precision)
             np.divide(
-                np.multiply(precision, recall),
+                2 * np.multiply(precision, recall),
                 (precision + recall),
                 where=(precision + recall) > 1e-9,
                 out=f1_score,
+                dtype=np.float64,
             )
 
             counts[iou_idx][score_idx] = np.concatenate(

valor_lite/object_detection/manager.py

@@ -307,7 +307,7 @@ class Evaluator:
         filter_: Filter | None = None,
     ) -> dict[MetricType, list[Metric]]:
         """
-        Computes all avaiable metrics.
+        Computes all available metrics.
 
         Parameters
         ----------

valor_lite/object_detection/metric.py

@@ -1,3 +1,4 @@
+from dataclasses import dataclass
 from enum import Enum
 
 from valor_lite.schemas import BaseMetric
@@ -21,6 +22,7 @@ class MetricType(str, Enum):
     ConfusionMatrix = "ConfusionMatrix"
 
 
+@dataclass
 class Metric(BaseMetric):
     """
     Object Detection Metric.
@@ -35,6 +37,24 @@ class Metric(BaseMetric):
         A dictionary containing metric parameters.
     """
 
+    def __post_init__(self):
+        if not isinstance(self.type, str):
+            raise TypeError(
+                f"Metric type should be of type 'str': {self.type}"
+            )
+        elif not isinstance(self.value, (int, float, dict)):
+            raise TypeError(
+                f"Metric value must be of type 'int', 'float' or 'dict': {self.value}"
+            )
+        elif not isinstance(self.parameters, dict):
+            raise TypeError(
+                f"Metric parameters must be of type 'dict[str, Any]': {self.parameters}"
+            )
+        elif not all([isinstance(k, str) for k in self.parameters.keys()]):
+            raise TypeError(
+                f"Metric parameter dictionary should only have keys with type 'str': {self.parameters}"
+            )
+
     @classmethod
     def precision(
         cls,

valor_lite/schemas.py

@@ -7,11 +7,5 @@ class BaseMetric:
     value: int | float | dict
     parameters: dict
 
-    def __post_init__(self):
-        if not isinstance(self.value, (int, float, dict)):
-            raise TypeError(
-                "Metric value must be of type `int`, `float` or `dict`."
-            )
-
     def to_dict(self) -> dict:
         return asdict(self)

valor_lite/semantic_segmentation/metric.py

@@ -1,3 +1,4 @@
+from dataclasses import dataclass
 from enum import Enum
 
 from valor_lite.schemas import BaseMetric
@@ -13,6 +14,7 @@ class MetricType(Enum):
     ConfusionMatrix = "ConfusionMatrix"
 
 
+@dataclass
 class Metric(BaseMetric):
     """
     Semantic Segmentation Metric.
@@ -27,6 +29,24 @@ class Metric(BaseMetric):
         A dictionary containing metric parameters.
     """
 
+    def __post_init__(self):
+        if not isinstance(self.type, str):
+            raise TypeError(
+                f"Metric type should be of type 'str': {self.type}"
+            )
+        elif not isinstance(self.value, (int, float, dict)):
+            raise TypeError(
+                f"Metric value must be of type 'int', 'float' or 'dict': {self.value}"
+            )
+        elif not isinstance(self.parameters, dict):
+            raise TypeError(
+                f"Metric parameters must be of type 'dict[str, Any]': {self.parameters}"
+            )
+        elif not all([isinstance(k, str) for k in self.parameters.keys()]):
+            raise TypeError(
+                f"Metric parameter dictionary should only have keys with type 'str': {self.parameters}"
+            )
+
     @classmethod
     def precision(
         cls,

valor_lite/text_generation/__init__.py

@@ -0,0 +1,15 @@
+from .annotation import Context, QueryResponse
+from .llm.integrations import ClientWrapper, MistralWrapper, OpenAIWrapper
+from .manager import Evaluator
+from .metric import Metric, MetricType
+
+__all__ = [
+    "QueryResponse",
+    "Context",
+    "Evaluator",
+    "Metric",
+    "MetricType",
+    "ClientWrapper",
+    "OpenAIWrapper",
+    "MistralWrapper",
+]

valor_lite/text_generation/annotation.py

@@ -0,0 +1,56 @@
+from dataclasses import dataclass, field
+
+
+@dataclass
+class Context:
+    """
+    Contextual ground truth and prediction.
+
+    Attributes
+    ----------
+    groundtruth : list[str]
+        The definitive context.
+    prediction : list[str]
+        Any retrieved context from a retrieval-augmented-generation (RAG) pipeline.
+
+    Examples
+    --------
+    ... context = Context(
+    ...     groundtruth=[...],
+    ...     prediction=[...],
+    ... )
+    """
+
+    groundtruth: list[str] = field(default_factory=list)
+    prediction: list[str] = field(default_factory=list)
+
+
+@dataclass
+class QueryResponse:
+    """
+    Text generation data structure containing ground truths and predictions.
+
+    Attributes
+    ----------
+    query : str
+        The user query.
+    response : str
+        The language model's response.
+    context : Context
+        Any context provided to the model.
+
+    Examples
+    --------
+    >>> query = QueryResponse(
+    ...     query='When was George Washington born?',
+    ...     response="February 22, 1732",
+    ...     context=Context(
+    ...         groundtruth=["02/22/1732"],
+    ...         prediction=["02/22/1732"],
+    ...     ),
+    ... )
+    """
+
+    query: str
+    response: str
+    context: Context | None = field(default=None)