Skip to content

Commit d3f5f29

Browse files
authored
docs: Improve README (#109)
1 parent 05885a3 commit d3f5f29

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
FastEmbed is a lightweight, fast, Python library built for embedding generation. We [support popular text models](https://qdrant.github.io/fastembed/examples/Supported_Models/). Please [open a Github issue](https://github.com/qdrant/fastembed/issues/new) if you want us to add a new model.
44

5-
The default embedding supports "query" and "passage" prefixes for the input text. The default model is Flag Embedding, which is top of the [MTEB](https://huggingface.co/spaces/mteb/leaderboard) leaderboard. Here is an example for [Retrieval Embedding Generation](https://qdrant.github.io/fastembed/examples/Retrieval_with_FastEmbed/) and how to use [FastEmbed with Qdrant](https://qdrant.github.io/fastembed/examples/Usage_With_Qdrant/).
5+
The default text embedding (`TextEmbedding`) model is Flag Embedding, the top model in the [MTEB](https://huggingface.co/spaces/mteb/leaderboard) leaderboard. It supports "query" and "passage" prefixes for the input text. Here is an example for [Retrieval Embedding Generation](https://qdrant.github.io/fastembed/examples/Retrieval_with_FastEmbed/) and how to use [FastEmbed with Qdrant](https://qdrant.github.io/fastembed/examples/Usage_With_Qdrant/).
66

77
1. Light & Fast
88
- Quantized model weights
@@ -54,13 +54,16 @@ Might have to use ```pip install 'qdrant-client[fastembed]'``` on zsh.
5454
from qdrant_client import QdrantClient
5555

5656
# Initialize the client
57-
client = QdrantClient(":memory:") # or QdrantClient(path="path/to/db")
57+
client = QdrantClient("localhost", port=6333) # For production
58+
# OR if you just want to try it out quickly:
59+
# client = QdrantClient(":memory:")
60+
# client = QdrantClient(path="path/to/db")
5861

5962
# Prepare your documents, metadata, and IDs
6063
docs = ["Qdrant has Langchain integrations", "Qdrant also has Llama Index integrations"]
6164
metadata = [
6265
{"source": "Langchain-docs"},
63-
{"source": "Linkedin-docs"},
66+
{"source": "Llama-index-docs"},
6467
]
6568
ids = [42, 2]
6669

0 commit comments

Comments
 (0)