Cleanup

run-llama · Jun 6, 2024 · 5bb6331 · 5bb6331
1 parent 92acc6d
commit 5bb6331
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 18 deletions.
diff --git a/llama-index-core/llama_index/core/evaluation/retrieval/metrics.py b/llama-index-core/llama_index/core/evaluation/retrieval/metrics.py
@@ -1,5 +1,5 @@
 import os
-from typing import Any, Callable, Dict, List, Literal, Optional, Type
+from typing import Any, Callable, ClassVar, Dict, List, Literal, Optional, Type
 
 import numpy as np
 from llama_index.core.bridge.pydantic import Field, PrivateAttr
@@ -22,7 +22,7 @@ class HitRate(BaseRetrievalMetric):
         metric_name (str): The name of the metric.
     """
 
-    metric_name: str = "hit_rate"
+    metric_name: ClassVar[str] = "hit_rate"
     use_granular_hit_rate: bool = False
 
     def compute(
@@ -81,7 +81,7 @@ class MRR(BaseRetrievalMetric):
         metric_name (str): The name of the metric.
     """
 
-    metric_name: str = "mrr"
+    metric_name: ClassVar[str] = "mrr"
     use_granular_mrr: bool = False
 
     def compute(
@@ -143,8 +143,8 @@ def compute(
 class CohereRerankRelevancyMetric(BaseRetrievalMetric):
     """Cohere rerank relevancy metric."""
 
+    metric_name: ClassVar[str] = "cohere_rerank_relevancy"
     model: str = Field(description="Cohere model name.")
-    metric_name: str = "cohere_rerank_relevancy"
 
     _client: Any = PrivateAttr()
 

diff --git a/llama-index-core/llama_index/core/evaluation/retrieval/metrics_base.py b/llama-index-core/llama_index/core/evaluation/retrieval/metrics_base.py
@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import Any, Dict, List, Optional
+from typing import Any, ClassVar, Dict, List, Optional
 
 from llama_index.core.bridge.pydantic import BaseModel, Field
 
@@ -30,7 +30,7 @@ def __float__(self) -> float:
 class BaseRetrievalMetric(BaseModel, ABC):
     """Base class for retrieval metrics."""
 
-    metric_name: str
+    metric_name: ClassVar[str]
 
     @abstractmethod
     def compute(

diff --git a/llama-index-core/llama_index/core/indices/omni_modal/retriever.py b/llama-index-core/llama_index/core/indices/omni_modal/retriever.py
@@ -436,9 +436,8 @@ def retrieve_multi_modal(
         query_bundle: QueryBundle,
         *,
         query_type: KQ,
-        doc_types: Optional[
-            Collection[KD]
-        ] = None,  # Defaults to all document modalities
+        # Defaults to all document modalities
+        doc_types: Optional[Collection[KD]] = None,
     ) -> List[NodeWithScore]:
         if doc_types is None:
             doc_types = self._embed_model.document_modalities.keys()
@@ -479,9 +478,8 @@ async def aretrieve_multi_modal(
         query_bundle: QueryBundle,
         *,
         query_type: KQ,
-        doc_types: Optional[
-            Collection[KD]
-        ] = None,  # Defaults to all document modalities
+        # Defaults to all document modalities
+        doc_types: Optional[Collection[KD]] = None,
     ) -> List[NodeWithScore]:
         if doc_types is None:
             doc_types = self._embed_model.document_modalities.keys()
@@ -580,9 +578,8 @@ def retrieve(
         self,
         str_or_query_bundle: QueryType,
         *,
-        doc_types: Optional[
-            Collection[KD]
-        ] = None,  # Defaults to all document modalities
+        # Defaults to all document modalities
+        doc_types: Optional[Collection[KD]] = None,
     ) -> List[NodeWithScore]:
         query_bundle = self._as_query_bundle(
             str_or_query_bundle, query_type=Modalities.TEXT.key
@@ -598,9 +595,8 @@ async def aretrieve(
         self,
         str_or_query_bundle: QueryType,
         *,
-        doc_types: Optional[
-            Collection[KD]
-        ] = None,  # Defaults to all document modalities
+        # Defaults to all document modalities
+        doc_types: Optional[Collection[KD]] = None,
     ) -> List[NodeWithScore]:
         query_bundle = self._as_query_bundle(
             str_or_query_bundle, query_type=Modalities.TEXT.key