From 49551950815c50346f47456a4979bd900dd689d6 Mon Sep 17 00:00:00 2001 From: Martin Gaievski Date: Wed, 25 Oct 2023 09:15:24 -0700 Subject: [PATCH] Addressing review comments Signed-off-by: Martin Gaievski --- DEVELOPER_GUIDE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index d3e3d1903..0ce29d811 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -131,7 +131,7 @@ curl localhost:9200 ``` ### Run Multi-node Cluster Locally -It can be useful to test and debug on a multi-node cluster. In order to launch a 3 node cluster with the KNN plugin installed, run the following command: +It can be useful to test and debug on a multi-node cluster. In order to launch a 3 node cluster with the neural-search plugin installed, run the following command: ``` ./gradlew run -PnumNodes=3 @@ -186,7 +186,7 @@ Additionally, it is possible to attach one debugger to the cluster JVM and anoth ### Supported configurations -Be default neural-search plugin supports `lucene` k-NN engine for local runs. Below is the sample request for creating of new index using this engine: +By default, neural-search plugin supports `lucene` k-NN engine for local runs. Below is the sample request for creating of new index using this engine: ``` { @@ -213,7 +213,7 @@ Be default neural-search plugin supports `lucene` k-NN engine for local runs. Be } ``` -The reason for this is that neural-search uses k-NN zip artifact from maven, and that artifact doesn't have native libraries. It's possible to install k-NN locally and build those native libraries (like Nmslib). For intruction on how to do this please check instruction from [k-NN plugin repository.](https://github.com/opensearch-project/k-NN) +The reason for this is that neural-search uses k-NN zip artifact from maven, and that artifact doesn't have native libraries. It's possible to install k-NN locally and build those native libraries (like Nmslib). For instructions on how to do this please check dev guide in [k-NN plugin repository.](https://github.com/opensearch-project/k-NN) ## Submitting Changes