opensearch-docs-cn/_ml-commons-plugin/cluster-settings.md

133 lines
2.9 KiB
Markdown
Raw Normal View History

---
layout: default
title: ML Commons cluster settings
has_children: false
nav_order: 10
---
# ML Commons cluster settings
This page provides an overview of `opensearch.yml` settings that can be configured for the ML commons plugin.
## Run tasks and models on ML nodes only
### Setting
```
Add GPU acceleration documentation (#2384) * Add GPU acceleration documentation Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust model size sentence Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add optional to neuron step Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Jeff's feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add copy and customize for Inferntia examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update _ml-commons-plugin/gpu-acceleration.md Co-authored-by: Nate Bower <nbower@amazon.com> * Update _ml-commons-plugin/gpu-acceleration.md Co-authored-by: Nate Bower <nbower@amazon.com> * Apply suggestions from code review Co-authored-by: Nate Bower <nbower@amazon.com> * Fix link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Caroline <113052567+carolxob@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Caroline <113052567+carolxob@users.noreply.github.com> * Update _ml-commons-plugin/gpu-acceleration.md Co-authored-by: Caroline <113052567+carolxob@users.noreply.github.com> * Update _ml-commons-plugin/gpu-acceleration.md Co-authored-by: Caroline <113052567+carolxob@users.noreply.github.com> * Update _ml-commons-plugin/gpu-acceleration.md Co-authored-by: Caroline <113052567+carolxob@users.noreply.github.com> * Fix numbering in final section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final tech feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * A couple more suggestion Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Yaliang Wu <ylwu@amazon.com> * Fix Neural Search link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update _ml-commons-plugin/gpu-acceleration.md Co-authored-by: Yaliang Wu <ylwu@amazon.com> * Final tech feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Move OpenSearch to step 2. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Co-authored-by: Nate Bower <nbower@amazon.com> Co-authored-by: Caroline <113052567+carolxob@users.noreply.github.com> Co-authored-by: Yaliang Wu <ylwu@amazon.com>
2023-01-18 14:31:52 -05:00
plugins.ml_commons.only_run_on_ml_node: true
```
### Description
If `true`, ML Commons tasks and models run machine learning (ML) tasks on ML nodes only. If `false`, tasks and models run on ML nodes first. If no ML nodes exist, tasks and models run on data nodes. Don't set as "false" on production cluster.
### Values
- Default value: `false`
- Value range: `true` or `false`
## Dispatch tasks to ML node
### Setting
```
plugins.ml_commons.task_dispatch_policy: round_robin
```
### Description
`round_robin` dispatches ML tasks to ML nodes using round robin routing. `least_load` gathers all an ML nodes' runtime information, like JVM heap memory usage and running tasks, then dispatches tasks to the ML node with the least load.
### Values
- Dafault value: `round_robin`
- Value range: `round_robin` or `least_load`
## Set sync up job intervals
### Setting
```
plugins.ml_commons.sync_up_job_interval_in_seconds: 10
```
### Description
When returning runtime information with the [profile API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api#profile), ML Commons will run a regular sync up job to sync up newly loaded or unloaded models on each node. When set to `0`, ML Commons immediately stops sync up jobs.
### Values
- Default value: `10`
- Value range: [0, 86,400]
## Predict monitoring requests
### Setting
```
plugins.ml_commons.monitoring_request_count: 100
```
### Description
Controls how many upload model tasks can run in parallel on one node. If set to `0`, you cannot upload models to any node.
### Value range
- Default value: `100`
- Value range: [0, 100,000,000]
## Upload model tasks per node
### Setting
```
plugins.ml_commons.max_upload_model_tasks_per_node: 10
```
### Description
Controls how many upload model tasks can run in parallel on one node. If set to `0`, you cannot upload models to any node.
### Values
- Default value: `10`
- Value range: [0, 10]
## Load model tasks per node
### Setting
```
plugins.ml_commons.max_load_model_tasks_per_node: 10
```
### Description
Controls how many load model tasks can run in parallel on one node. If set as 0, you cannot load models to any node.
### Values
- Default value: `10`
- Value range: [0, 10]
## Add trusted URL
### Setting
```
plugins.ml_commons.trusted_url_regex: ^(https?\|ftp\|file)://[-a-zA-Z0-9+&@#/%?=~_\|!:,.;]*[-a-zA-Z0-9+&@#/%=~_\|]
```
### Description
The default value allows uploading a model file from any http/https/ftp/local file. You can change this value to restrict trusted model URL
### Values
- Default value: `^(https?\|ftp\|file)://[-a-zA-Z0-9+&@#/%?=~_\|!:,.;]*[-a-zA-Z0-9+&@#/%=~_\|]`
- Value range: Java regular expression (regex) string