Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix integrations.fastembed API docs #540

Merged
merged 1 commit into from
Mar 6, 2024
Merged

docs: Fix integrations.fastembed API docs #540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ...d/src/haystack_integrations/components/embedders/fastembed/fastembed_document_embedder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 3 additions & 4 deletions ...embed/src/haystack_integrations/components/embedders/fastembed/fastembed_text_embedder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down