Skip to content

Commit 854800c

Browse files
authored
Merge pull request #57 from Eigen-DB/chore/rendering-jupyter-notebooks-in-docs
docs: moved supported embedding models up
2 parents 028361e + d58e636 commit 854800c

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

apps/docs/sdks/python.mdx

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,36 @@ description: Seamlessly integrate EigenDB into your Python applications
44
icon: python
55
---
66

7-
## Installation
7+
## Installation
88

99
<CodeGroup>
1010
```bash pip
1111
pip install eigen-client
1212
```
1313
</CodeGroup>
1414

15+
## Supported embedding models
16+
17+
If you desire to use a model that is not listed here, you can simply create the index with `client.create_index(...)` and provide the desired dimensions and similarity metric.
18+
19+
| Model Name | Provider | Dimensions | Similarity Metric |
20+
|--------------------------------|-----------|------------|-------------------|
21+
| text-embedding-3-small | OpenAI | 1536 | cosine |
22+
| text-embedding-3-large | OpenAI | 3072 | cosine |
23+
| text-embedding-ada-002 | OpenAI | 1536 | cosine |
24+
| all-minilm:22m | Ollama | 384 | cosine |
25+
| nomic-embed-text:v1.5 | Ollama | 768 | cosine |
26+
| mxbai-embed-large:335m | Ollama | 1024 | cosine |
27+
| snowflake-arctic-embed2:568m | Ollama | 1024 | cosine |
28+
| snowflake-arctic-embed:335m | Ollama | 1024 | cosine |
29+
| bge-m3:567m | Ollama | 1024 | cosine |
30+
| bge-large:335m | Ollama | 1024 | cosine |
31+
1532
## Usage
1633

1734
### Creating an index
1835

19-
```py
36+
```py python
2037
import os
2138
from eigen_client.client import Client
2239
from eigen_client.data_types import Document
@@ -53,7 +70,7 @@ print(results)
5370

5471
### Using an existing index
5572

56-
```py
73+
```py python
5774
import os
5875
from eigen_client.index import Index
5976
from eigen_client.data_types import Document
@@ -83,19 +100,4 @@ results = index.search_docs(
83100
)
84101

85102
print(results)
86-
```
87-
88-
## Supported embedding models
89-
90-
| Model Name | Provider | Dimensions | Similarity Metric |
91-
|--------------------------------|-----------|------------|-------------------|
92-
| text-embedding-3-small | OpenAI | 1536 | cosine |
93-
| text-embedding-3-large | OpenAI | 3072 | cosine |
94-
| text-embedding-ada-002 | OpenAI | 1536 | cosine |
95-
| all-minilm:22m | Ollama | 384 | cosine |
96-
| nomic-embed-text:v1.5 | Ollama | 768 | cosine |
97-
| mxbai-embed-large:335m | Ollama | 1024 | cosine |
98-
| snowflake-arctic-embed2:568m | Ollama | 1024 | cosine |
99-
| snowflake-arctic-embed:335m | Ollama | 1024 | cosine |
100-
| bge-m3:567m | Ollama | 1024 | cosine |
101-
| bge-large:335m | Ollama | 1024 | cosine |
103+
```

0 commit comments

Comments
 (0)