From 6e8dcbb7495ca756cca1b0746e77bc3346e69591 Mon Sep 17 00:00:00 2001 From: "opensearch-trigger-bot[bot]" <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Date: Mon, 20 Mar 2023 13:36:45 -0700 Subject: [PATCH] Update DEVELOPER_GUIDE.md (#113) (#115) * Dev guide update Signed-off-by: Merey * Edited the developer guide Signed-off-by: Merey --------- Signed-off-by: Merey (cherry picked from commit f6cf39f1d5b306e73a78ca4acc6fdaa36ab4d027) Co-authored-by: Merey --- DEVELOPER_GUIDE.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 32981fb8..be1d931d 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -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