Skip to content

Commit

Permalink
Update DEVELOPER_GUIDE.md (#113)
Browse files Browse the repository at this point in the history
* Dev guide update

Signed-off-by: Merey <orazaly1508@gmail.com>

* Edited the developer guide

Signed-off-by: Merey <orazaly1508@gmail.com>

---------

Signed-off-by: Merey <orazaly1508@gmail.com>
  • Loading branch information
Merey1508 committed Mar 20, 2023
1 parent b56b587 commit f6cf39f
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,27 @@ You can install opensearch multiple ways:

Now that you have a development environment to play with, there are a number of different paths you may take next.

#### Update the settings for the cluster
After navigating to OpenSearch Dashboards you should update the persistent settings for the cluster. The settings will update the behavior of the machine learning plugin, specifically the ml_commons plugin. ML Commons cluster settings: https://opensearch.org/docs/latest/ml-commons-plugin/cluster-settings/

You should paste this settings in the `Dev Tools` window and run it:

```yml
PUT /_cluster/settings
{
"persistent" : {
"plugins.ml_commons.only_run_on_ml_node" : false,
"plugins.ml_commons.native_memory_threshold" : 100,
"plugins.ml_commons.max_model_on_node": 20
}
}
```

#### Review user tutorials to understand the key features and workflows

- These [Notebook Examples](https://opensearch-project.github.io/opensearch-py-ml/examples/index.html) will show you how to use opensearch-py-ml for data exploration and machine learning.
- [API references](https://opensearch-project.github.io/opensearch-py-ml/reference/index.html) provides helpful guidance using different functionalities of opensearch-py-ml


#### To test code formatting and linting issue we can run

```bash
Expand Down

0 comments on commit f6cf39f

Please sign in to comment.