156 lines
3.9 KiB
Markdown
156 lines
3.9 KiB
Markdown
---
|
|
layout: default
|
|
title: ML Commons cluster settings
|
|
has_children: false
|
|
nav_order: 10
|
|
---
|
|
|
|
# ML Commons cluster settings
|
|
|
|
To enhance and customize your OpenSearch cluster for machine learning (ML), you can add and modify several configuration settings for the ML commons plugin in your 'opensearch.yml' file.
|
|
|
|
|
|
## Run tasks and models on ML nodes only
|
|
|
|
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. We recommend that you do not set this value to "false" on production clusters.
|
|
|
|
### Setting
|
|
|
|
```
|
|
plugins.ml_commons.only_run_on_ml_node: true
|
|
```
|
|
|
|
### Values
|
|
|
|
- Default value: `true`
|
|
- Value range: `true` or `false`
|
|
|
|
## Dispatch tasks to ML node
|
|
|
|
`round_robin` dispatches ML tasks to ML nodes using round robin routing. `least_load` gathers runtime information from all ML nodes, like JVM heap memory usage and running tasks, and then dispatches the tasks to the ML node with the lowest load.
|
|
|
|
|
|
### Setting
|
|
|
|
```
|
|
plugins.ml_commons.task_dispatch_policy: round_robin
|
|
```
|
|
|
|
|
|
### Values
|
|
|
|
- Dafault value: `round_robin`
|
|
- Value range: `round_robin` or `least_load`
|
|
|
|
|
|
## Set sync job intervals
|
|
|
|
When returning runtime information with the [profile API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api#profile), ML Commons will run a regular job to sync newly loaded or unloaded models on each node. When set to `0`, ML Commons immediately stops sync up jobs.
|
|
|
|
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.
|
|
|
|
### Setting
|
|
|
|
```
|
|
plugins.ml_commons.sync_up_job_interval_in_seconds: 10
|
|
```
|
|
|
|
### Values
|
|
|
|
- Default value: `10`
|
|
- Value range: [0, 86,400]
|
|
|
|
## Predict monitoring requests
|
|
|
|
Controls how many upload model tasks can run in parallel on one node. If set to `0`, you cannot upload models to any node.
|
|
|
|
### Setting
|
|
|
|
```
|
|
plugins.ml_commons.monitoring_request_count: 100
|
|
```
|
|
|
|
### Value range
|
|
|
|
- Default value: `100`
|
|
- Value range: [0, 100,000,000]
|
|
|
|
## Upload model tasks per node
|
|
|
|
Controls how many upload model tasks can run in parallel on one node. If set to `0`, you cannot upload models to any node.
|
|
|
|
### Setting
|
|
|
|
```
|
|
plugins.ml_commons.max_upload_model_tasks_per_node: 10
|
|
```
|
|
|
|
|
|
### Values
|
|
|
|
- Default value: `10`
|
|
- Value range: [0, 10]
|
|
|
|
|
|
## Load model tasks per node
|
|
|
|
Controls how many load model tasks can run in parallel on one node. If set to 0, you cannot load models to any node.
|
|
|
|
### Setting
|
|
|
|
```
|
|
plugins.ml_commons.max_load_model_tasks_per_node: 10
|
|
```
|
|
|
|
### Values
|
|
|
|
- Default value: `10`
|
|
- Value range: [0, 10]
|
|
|
|
## Add trusted URL
|
|
|
|
The default value allows you to upload a model file from any http/https/ftp/local file. You can change this value to restrict trusted model URLs.
|
|
|
|
|
|
### Setting
|
|
|
|
```
|
|
plugins.ml_commons.trusted_url_regex: ^(https?\|ftp\|file)://[-a-zA-Z0-9+&@#/%?=~_\|!:,.;]*[-a-zA-Z0-9+&@#/%=~_\|]
|
|
```
|
|
|
|
### Values
|
|
|
|
- Default value: `^(https?\|ftp\|file)://[-a-zA-Z0-9+&@#/%?=~_\|!:,.;]*[-a-zA-Z0-9+&@#/%=~_\|]`
|
|
- Value range: Java regular expression (regex) string
|
|
|
|
## Assign task timeout
|
|
|
|
Assigns how long in seconds an ML task will live. After the timeout, the task will fail.
|
|
|
|
### Setting
|
|
|
|
```
|
|
plugins.ml_commons.ml_task_timeout_in_seconds: 600
|
|
```
|
|
|
|
### Values
|
|
|
|
- Default value: 600
|
|
- Value range: [1, 86400]
|
|
|
|
## Set native memory threshold
|
|
|
|
Sets a circuit breaker that checks all system memory usage before running an ML task. If the native memory exceeds the threshold, OpenSearch throws an exception and stops running any ML task.
|
|
|
|
Values are based on the percentage of memory available. When set to `0`, no ML tasks will run. When set to `100`, the circuit breaker closes and no threshold exists.
|
|
|
|
### Setting
|
|
|
|
```
|
|
plugins.ml_commons.native_memory_threshold: 90
|
|
```
|
|
|
|
### Values
|
|
|
|
- Default value: 90
|
|
- Value range: [0, 100] |