From 035aae2992efc6259fe29de21360c24bc1cdca14 Mon Sep 17 00:00:00 2001 From: Vladimir Blagojevic Date: Wed, 6 Mar 2024 10:22:49 +0100 Subject: [PATCH] Fix API docs --- .../embedders/fastembed/fastembed_document_embedder.py | 6 +++--- .../embedders/fastembed/fastembed_text_embedder.py | 7 +++---- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/integrations/fastembed/src/haystack_integrations/components/embedders/fastembed/fastembed_document_embedder.py b/integrations/fastembed/src/haystack_integrations/components/embedders/fastembed/fastembed_document_embedder.py index 4af8e1bbe..b5dd71231 100644 --- a/integrations/fastembed/src/haystack_integrations/components/embedders/fastembed/fastembed_document_embedder.py +++ b/integrations/fastembed/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/integrations/fastembed/src/haystack_integrations/components/embedders/fastembed/fastembed_text_embedder.py b/integrations/fastembed/src/haystack_integrations/components/embedders/fastembed/fastembed_text_embedder.py index 13a89d1ce..743884ec1 100644 --- a/integrations/fastembed/src/haystack_integrations/components/embedders/fastembed/fastembed_text_embedder.py +++ b/integrations/fastembed/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.