Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update DEVELOPER_GUIDE.md #113

Merged
merged 2 commits into from
Mar 20, 2023
Merged

Update DEVELOPER_GUIDE.md #113

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec31bc4
Dev guide update
Merey1508 Mar 19, 2023
f2097e8
Edited the developer guide
Merey1508 Mar 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion DEVELOPER_GUIDE.md
View file
Open in desktop
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
}
}
```
Comment on lines +88 to +101
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After looking at it again, I feel like we should move it to theNext Steps section, because this step is applicable after installing opensearch through way 1 (docker compose) or way 2 (tarball). So let's not put it under way 1.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, thanks a lot for your guidance!


#### 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