Skip to content

Commit

Permalink
docs: add benchmark reference to feature summary (#510)
Browse files Browse the repository at this point in the history
* docs: add benchmark reference to feature summary

add link to the benchmark so that users can quickly choose the right database storage to use

Co-authored-by: AlaeddineAbdessalem <alaeddine-13@live.fr>
  • Loading branch information
fogx and alaeddine-13 authored Sep 9, 2022
1 parent ba91a2e commit b443583
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions docs/advanced/document-store/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,15 +151,19 @@ Using dataclass gives you better type-checking in IDE but requires an extra impo
DocArray supports multiple storage backends with different search features. The following table showcases relevant functionalities that are supported (✅) or not supported (❌) in DocArray depending on the backend:


| Name | Construction | vector search | vector search + filter | filter|
|--------------------------------------|------------------------------------------|---------------|------------------------|---------------|
| In memory | `DocumentArray()` ||||
| [`Sqlite`](./sqlite.md) | `DocumentArray(storage='sqlite')` ||||
| [`Weaviate`](./weaviate.md) | `DocumentArray(storage='weaviate')` ||||
| [`Qdrant`](./qdrant.md) | `DocumentArray(storage='qdrant')` ||||
| [`Annlite`](./annlite.md) | `DocumentArray(storage='annlite')` ||||
| [`ElasticSearch`](./elasticsearch.md) | `DocumentArray(storage='elasticsearch')` ||||
| [`Redis`](./redis.md) | `DocumentArray(storage='redis')` ||||
| Name | Construction | vector search | vector search + filter | filter |
|---------------------------------------|------------------------------------------|----------------|------------------------|---------------|
| In memory | `DocumentArray()` ||||
| [`Sqlite`](./sqlite.md) | `DocumentArray(storage='sqlite')` ||||
| [`Weaviate`](./weaviate.md) | `DocumentArray(storage='weaviate')` ||||
| [`Qdrant`](./qdrant.md) | `DocumentArray(storage='qdrant')` ||||
| [`AnnLite`](./annlite.md) | `DocumentArray(storage='annlite')` ||||
| [`ElasticSearch`](./elasticsearch.md) | `DocumentArray(storage='elasticsearch')` ||||
| [`Redis`](./redis.md) | `DocumentArray(storage='redis')` ||||

The right backend choice depends on the scale of your data, the required performance and the desired ease of setup. For most use cases we recommend starting with [`AnnLite`](./annlite.md).
[**Check our One Million Scale Benchmark for more details**](./benchmark#conclusion).



Here we understand by
Expand All @@ -170,10 +174,9 @@ Here we understand by

- **filter**: perform a filter step over the data. The input of the search function is a filter.

The capabilities of **vector search**, **vector search + filter** can be used using the {meth}`~docarray.array.mixins.find.FindMixin.find` or {func}`~docarray.array.mixins.match.MatchMixin.match` methods thorugh a `DocumentArray`.
The capabilities of **vector search**, **vector search + filter** can be used using the {meth}`~docarray.array.mixins.find.FindMixin.find` or {func}`~docarray.array.mixins.match.MatchMixin.match` methods through a `DocumentArray`.
The **filter** functionality is available using the `.find` method in a `DocumentArray`.
A detailed explanation of the differences between `.find` and `.match` can be found [`here`](./../../../fundamentals/documentarray/matching)

A detailed explanation of the differences between `.find` and `.match` can be found [here](./../../../fundamentals/documentarray/matching)

### Vector search example

Expand Down

0 comments on commit b443583

Please sign in to comment.