Skip to content
This repository has been archived by the owner on May 10, 2024. It is now read-only.

[DOCS]: FastEmbed embedding function #233

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/embeddings.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Chroma provides lightweight wrappers around popular embedding providers, making
| [Hugging Face Embedding Server](/embeddings/hugging-face-embedding-server) | ✅ | ✅ |
| [Jina AI](/embeddings/jinaai) | ✅ | ✅ |
| [Roboflow](/embeddings/roboflow-api) | ✅ | ➖ |
| [FastEmbed](/embeddings/fastembed) | ✅ | ➖ |

We welcome pull requests to add new Embedding Functions to the community.

Expand Down
28 changes: 28 additions & 0 deletions docs/embeddings/fastembed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
---

# FastEmbed

[FastEmbed](https://qdrant.github.io/fastembed/) is a lightweight, CPU-first Python library built for embedding generation.

This embedding function requires the `fastembed` package. To install it, run

```pip install fastembed```.

You can find a list of all the supported models [here](https://qdrant.github.io/fastembed/examples/Supported_Models/).

## Example usage:

Using the default BAAI/bge-small-en-v1.5 model.

```python
from chromadb.utils.embedding_functions import FastEmbedEmbeddingFunction
ef = FastEmbedEmbeddingFunction()
```

Additionally, you can also configure the cache directory, number of threads and other FastEmbed options.

```python
from chromadb.utils.embedding_functions import FastEmbedEmbeddingFunction
ef = FastEmbedEmbeddingFunction(model_name="nomic-ai/nomic-embed-text-v1.5", cache_dir="models_cache", threads=5)
```
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ const sidebars = {
'embeddings/roboflow-api',
'embeddings/hugging-face-embedding-server',
'embeddings/jinaai',
'embeddings/fastembed',
],
},
],
Expand Down