opensearch-docs-cn/_ml-commons-plugin/index.md

35 lines
2.2 KiB
Markdown
Raw Normal View History

---
layout: default
title: About ML Commons
nav_order: 1
has_children: false
has_toc: false
---
# ML Commons plugin
ML Commons for OpenSearch eases the development of machine learning features by providing a set of common machine learning (ML) algorithms through transport and REST API calls. Those calls choose the right nodes and resources for each ML request and monitors ML tasks to ensure uptime. This allows you to leverage existing open-source ML algorithms and reduce the effort required to develop new ML features.
Interaction with the ML Commons plugin occurs through either the [REST API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api) or [`ad`]({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/functions#ad) and [`kmeans`]({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/functions#kmeans) Piped Processing Language (PPL) commands.
Add style workflow (#3909) * Tweak rules Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rule changes Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove the following and simple Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Revised rules and added tests Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Soft rollout with only spelling and terms Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add Vale to readme Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Only lint modified and added files Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove run on workflow dispatch Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Removed only added and modified files Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added please Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Changed min alert level to warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Don't fail on error and minor changes Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove fail on error Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Attempt to have vale not fail Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fixed links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update README.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update README.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-05-03 12:34:05 -04:00
Models [trained]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api#training-a-model) through the ML Commons plugin support model-based algorithms such as kmeans. After you've trained a model enough so that it meets your precision requirements, you can apply the model to [predict]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api#predict) new data safely.
Should you not want to use a model, you can use the [Train and Predict]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api#train-and-predict) API to test your model without having to evaluate the model's performance.
## Permissions
There are two reserved user roles that can use of the ML commons plugin.
- `ml_full_access`: Full access to all ML features, including starting new ML tasks and reading or deleting models.
- `ml_readonly_access`: Can only read ML tasks, trained models and statistics relevant to the model's cluster. Cannot start nor delete ML tasks or models.
## ML node
To prevent your cluster from failing when running ML tasks, you configure a node with the `ml` node role. When configuring without the `data` node role, ML nodes will not store any shards and will calculate resource requirements at runtime. To use an ML node, create a node in your `opensearch.yml` file. Give your node a custom name and define the node role as `ml`:
```yml
node.name: ml-node
node.roles: [ ml ]
```