Skip to content
This repository was archived by the owner on Sep 9, 2026. It is now read-only.

Commit 7c10295

Browse files
jupyterjazzjupyterjazz
authored
docs: make document indices self-contained (#1678)
Signed-off-by: jupyterjazz <[email protected]>
1 parent 31c2bb9 commit 7c10295

14 files changed

Lines changed: 3184 additions & 1410 deletions

File tree

‎README.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,6 @@ query = dl[0]
393393
results, scores = index.find(query, limit=10, search_field='embedding')
394394
```
395395

396-
397396
---
398397

399398
## Learn DocArray

‎docs/API_reference/doc_index/backends/milvus.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# MilvusDocumentIndex
2+
3+
::: docarray.index.backends.milvus.MilvusDocumentIndex

‎docs/API_reference/doc_index/backends/redis.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# RedisDocumentIndex
2+
3+
::: docarray.index.backends.redis.RedisDocumentIndex

‎docs/user_guide/storing/docindex.md‎

Lines changed: 56 additions & 682 deletions
Large diffs are not rendered by default.

‎docs/user_guide/storing/first_step.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This section covers the following three topics:
2525

2626
## Document Index
2727

28-
A Document Index lets you store your Documents and search through them using vector similarity.
28+
A Document Index lets you store your documents and search through them using vector similarity.
2929

3030
This is useful if you want to store a bunch of data, and at a later point retrieve documents that are similar to
3131
a query that you provide.
@@ -41,5 +41,7 @@ use a vector search library locally (HNSWLib, Exact NN search):
4141
- [Weaviate](https://weaviate.io/) | [Docs](index_weaviate.md)
4242
- [Qdrant](https://qdrant.tech/) | [Docs](index_qdrant.md)
4343
- [Elasticsearch](https://www.elastic.co/elasticsearch/) v7 and v8 | [Docs](index_elastic.md)
44+
- [Redis](https://redis.com/) | [Docs](index_redis.md)
45+
- [Milvus](https://milvus.io/) | [Docs](index_milvus.md)
4446
- [Hnswlib](https://github.com/nmslib/hnswlib) | [Docs](index_hnswlib.md)
4547
- InMemoryExactNNSearch | [Docs](index_in_memory.md)

0 commit comments

Comments
 (0)