Interface docstring fixes

Author: I8dNLo

fastembed/common/model_management.py

@@ -27,7 +27,7 @@ def list_supported_models(cls) -> list[ModelDescription]:
         """Lists the supported models.
 
         Returns:
-            list[dict[str, Any]]: A list of dictionaries containing the model information.
+            list[ModelDescription]: A list of dictionaries containing the model information.
         """
         raise NotImplementedError()
 
@@ -43,7 +43,7 @@ def _get_model_description(cls, model_name: str) -> ModelDescription:
             ValueError: If the model_name is not supported.
 
         Returns:
-            dict[str, Any]: The model description.
+            ModelDescription: The model description.
         """
         for model in cls.list_supported_models():
             if model_name.lower() == model.model.lower():
@@ -340,13 +340,13 @@ def retrieve_model_gcs(
 
     @classmethod
     def download_model(
-        cls, model: dict[str, Any], cache_dir: str, retries: int = 3, **kwargs: Any
+        cls, model: ModelDescription, cache_dir: str, retries: int = 3, **kwargs: Any
     ) -> Path:
         """
         Downloads a model from HuggingFace Hub or Google Cloud Storage.
 
         Args:
-            model (dict[str, Any]): The model description.
+            model (ModelDescription): The model description.
                 Example:
                 ```
                 {

fastembed/image/image_embedding.py

@@ -16,7 +16,7 @@ def list_supported_models(cls) -> list[ModelDescription]:
         Lists the supported models.
 
         Returns:
-            list[dict[str, Any]]: A list of dictionaries containing the model information.
+            list[ModelDescription]: A list of dictionaries containing the model information.
 
             Example:
                 ```
@@ -35,7 +35,7 @@ def list_supported_models(cls) -> list[ModelDescription]:
                 ]
                 ```
         """
-        result: list[dict[str, Any]] = []
+        result: list[ModelDescription] = []
         for embedding in cls.EMBEDDINGS_REGISTRY:
             result.extend(embedding.list_supported_models())
         return result

fastembed/late_interaction/late_interaction_text_embedding.py

@@ -19,7 +19,7 @@ def list_supported_models(cls) -> list[ModelDescription]:
         Lists the supported models.
 
         Returns:
-            list[dict[str, Any]]: A list of dictionaries containing the model information.
+            list[ModelDescription]: A list of dictionaries containing the model information.
 
             Example:
                 ```

fastembed/late_interaction_multimodal/colpali.py

@@ -112,7 +112,7 @@ def list_supported_models(cls) -> list[ModelDescription]:
         """Lists the supported models.
 
         Returns:
-            list[dict[str, Any]]: A list of dictionaries containing the model information.
+            list[ModelDescription]: A list of dictionaries containing the model information.
         """
         return supported_colpali_models
 

fastembed/late_interaction_multimodal/late_interaction_multimodal_embedding.py

@@ -19,7 +19,7 @@ def list_supported_models(cls) -> list[ModelDescription]:
         Lists the supported models.
 
         Returns:
-            list[dict[str, Any]]: A list of dictionaries containing the model information.
+            list[ModelDescription]: A list of dictionaries containing the model information.
 
             Example:
                 ```

fastembed/rerank/cross_encoder/onnx_text_cross_encoder.py

@@ -76,7 +76,7 @@ def list_supported_models(cls) -> list[ModelDescription]:
         """Lists the supported models.
 
         Returns:
-            list[dict[str, Any]]: A list of dictionaries containing the model information.
+            list[ModelDescription]: A list of dictionaries containing the model information.
         """
         return supported_onnx_models
 

fastembed/rerank/cross_encoder/text_cross_encoder.py

@@ -16,7 +16,7 @@ def list_supported_models(cls) -> list[ModelDescription]:
         """Lists the supported models.
 
         Returns:
-            list[dict[str, Any]]: A list of dictionaries containing the model information.
+            list[ModelDescription]: A list of dictionaries containing the model information.
 
             Example:
                 ```
@@ -34,7 +34,7 @@ def list_supported_models(cls) -> list[ModelDescription]:
                 ]
                 ```
         """
-        result: list[dict[str, Any]] = []
+        result: list[ModelDescription] = []
         for encoder in cls.CROSS_ENCODER_REGISTRY:
             result.extend(encoder.list_supported_models())
         return result

fastembed/sparse/bm25.py

@@ -151,7 +151,7 @@ def list_supported_models(cls) -> list[SparseModelDescription]:
         """Lists the supported models.
 
         Returns:
-            list[dict[str, Any]]: A list of dictionaries containing the model information.
+            list[SparseModelDescription]: A list of dictionaries containing the model information.
         """
         return supported_bm25_models
 

fastembed/sparse/bm42.py

@@ -255,7 +255,7 @@ def list_supported_models(cls) -> list[SparseModelDescription]:
         """Lists the supported models.
 
         Returns:
-            list[dict[str, Any]]: A list of dictionaries containing the model information.
+            list[SparseModelDescription]: A list of dictionaries containing the model information.
         """
         return supported_bm42_models
 

fastembed/sparse/sparse_text_embedding.py

@@ -21,7 +21,7 @@ def list_supported_models(cls) -> list[SparseModelDescription]:
         Lists the supported models.
 
         Returns:
-            list[dict[str, Any]]: A list of dictionaries containing the model information.
+            list[SparseModelDescription]: A list of dictionaries containing the model information.
 
             Example:
                 ```
@@ -39,7 +39,7 @@ def list_supported_models(cls) -> list[SparseModelDescription]:
                 ]
                 ```
         """
-        result: list[dict[str, Any]] = []
+        result: list[SparseModelDescription] = []
         for embedding in cls.EMBEDDINGS_REGISTRY:
             result.extend(embedding.list_supported_models())
         return result