Skip to content

Commit

Permalink
Update _search-plugins/knn/settings.md and knn-index.md
Browse files Browse the repository at this point in the history
Signed-off-by: Noah Staveley <[email protected]>
  • Loading branch information
noahstaveley committed Sep 27, 2024
1 parent e651475 commit 5e3efe6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions _search-plugins/knn/knn-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,13 @@ SIMD optimization is applicable only if the vector dimension is a multiple of 8.
### x64 architecture
<!-- vale on -->

For the x64 architecture, the following versions of the Faiss library are built and shipped with the artifact:
For x64 architecture, the following versions of the Faiss library are built and shipped with the artifact:

- `libopensearchknn_faiss.so`: The non-optimized Faiss library without SIMD instructions.
- `libopensearchknn_faiss_avx512.so`: The Faiss library that contains AVX512 SIMD instructions.
- `libopensearchknn_faiss_avx2.so`: The Faiss library that contains AVX2 SIMD instructions.
- `libopensearchknn_faiss_avx512.so`: The Faiss library containing AVX512 SIMD instructions.
- `libopensearchknn_faiss_avx2.so`: The Faiss library containing AVX2 SIMD instructions.

When using the Faiss library, the performance ranking is: AVX512 > AVX2 > no optimization.
When using the Faiss library, the performance ranking is as follows: AVX512 > AVX2 > no optimization.
{: .note }

If your hardware supports AVX512, the k-NN plugin loads the `libopensearchknn_faiss_avx512.so` library at runtime.
Expand Down
2 changes: 1 addition & 1 deletion _search-plugins/knn/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Setting | Static/Dynamic | Default | Description
`knn.model.index.number_of_replicas`| Dynamic | `1` | The number of replica shards to use for the model system index. Generally, in a multi-node cluster, this value should be at least 1 in order to increase stability.
`knn.model.cache.size.limit` | Dynamic | `10%` | The model cache limit cannot exceed 25% of the JVM heap.
`knn.faiss.avx2.disabled` | Static | `false` | A static setting that specifies whether to disable the SIMD-based `libopensearchknn_faiss_avx2.so` library and load the non-optimized `libopensearchknn_faiss.so` library for the Faiss engine on machines with x64 architecture. For more information, see [SIMD optimization for the Faiss engine]({{site.url}}{{site.baseurl}}/search-plugins/knn/knn-index/#simd-optimization-for-the-faiss-engine).
`knn.faiss.avx512.disabled` | Static | `false` | A static setting that specifies whether to disable the SIMD-based `libopensearchknn_faiss_avx512.so` library and load the `libopensearchknn_faiss_avx2.so` or the non-optimized `libopensearchknn_faiss.so` library for the Faiss engine on machines with x64 architecture. For more information, see [SIMD optimization for the Faiss engine]({{site.url}}{{site.baseurl}}/search-plugins/knn/knn-index/#simd-optimization-for-the-faiss-engine).
`knn.faiss.avx512.disabled` | Static | `false` | A static setting that specifies whether to disable the SIMD-based `libopensearchknn_faiss_avx512.so` library and load the `libopensearchknn_faiss_avx2.so` library or the non-optimized `libopensearchknn_faiss.so` library for the Faiss engine on machines with x64 architecture. For more information, see [SIMD optimization for the Faiss engine]({{site.url}}{{site.baseurl}}/search-plugins/knn/knn-index/#simd-optimization-for-the-faiss-engine).

## Index settings

Expand Down

0 comments on commit 5e3efe6

Please sign in to comment.