Fix API docs (#540)

deepset-ai · Mar 6, 2024 · 67decea · 67decea
1 parent d7ad329
commit 67decea
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 7 deletions.
diff --git a/...d/src/haystack_integrations/components/embedders/fastembed/fastembed_document_embedder.py b/...d/src/haystack_integrations/components/embedders/fastembed/fastembed_document_embedder.py
@@ -68,11 +68,11 @@ def __init__(
         Create an FastembedDocumentEmbedder component.
 
         :param model: Local path or name of the model in Hugging Face's model hub,
-            such as ``'BAAI/bge-small-en-v1.5'``.
-        :param cache_dir (str, optional): The path to the cache directory.
+            such as `BAAI/bge-small-en-v1.5`.
+        :param cache_dir: The path to the cache directory.
                 Can be set using the `FASTEMBED_CACHE_PATH` env variable.
                 Defaults to `fastembed_cache` in the system's temp directory.
-        :param threads (int, optional): The number of threads single onnxruntime session can use. Defaults to None.
+        :param threads: The number of threads single onnxruntime session can use. Defaults to None.
         :param prefix: A string to add to the beginning of each text.
         :param suffix: A string to add to the end of each text.
         :param batch_size: Number of strings to encode at once.

diff --git a/...embed/src/haystack_integrations/components/embedders/fastembed/fastembed_text_embedder.py b/...embed/src/haystack_integrations/components/embedders/fastembed/fastembed_text_embedder.py
@@ -42,12 +42,11 @@ def __init__(
         """
         Create a FastembedTextEmbedder component.
 
-        :param model: Local path or name of the model in Fastembed's model hub,
-            such as ``'BAAI/bge-small-en-v1.5'``.
-        :param cache_dir (str, optional): The path to the cache directory.
+        :param model: Local path or name of the model in Fastembed's model hub, such as `BAAI/bge-small-en-v1.5`
+        :param cache_dir: The path to the cache directory.
                 Can be set using the `FASTEMBED_CACHE_PATH` env variable.
                 Defaults to `fastembed_cache` in the system's temp directory.
-        :param threads (int, optional): The number of threads single onnxruntime session can use. Defaults to None.
+        :param threads: The number of threads single onnxruntime session can use. Defaults to None.
         :param batch_size: Number of strings to encode at once.
         :param prefix: A string to add to the beginning of each text.
         :param suffix: A string to add to the end of each text.