Skip to content

Commit

Permalink
Addressing review comments
Browse files Browse the repository at this point in the history
Signed-off-by: Martin Gaievski <[email protected]>
  • Loading branch information
martin-gaievski committed Oct 25, 2023
1 parent 83dc5ad commit 4955195
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:

```
{
Expand All @@ -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

Expand Down

0 comments on commit 4955195

Please sign in to comment.