Remove requirement to set only run on ML node to false for remote models (#5818)
* Remove requirement to set only run on ML node to false for remote models Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add a note about external and local models integrated simultaneously Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
This commit is contained in:
parent
0decb2f58a
commit
8a379826cc
|
@ -13,7 +13,7 @@ The [ML Commons plugin](https://github.com/opensearch-project/ml-commons/) provi
|
||||||
|
|
||||||
## Integrating ML models
|
## Integrating ML models
|
||||||
|
|
||||||
For ML-model-powered search, you can use a pretrained model provided by OpenSearch, upload your own model to the OpenSearch cluster, or connect to a foundation model hosted on an external platform.
|
For ML-model-powered search, you can use a pretrained model provided by OpenSearch, upload your own model to the OpenSearch cluster, or connect to a foundation model hosted on an external platform. In OpenSearch version 2.9 and later, you can integrate local and external models simultaneously within a single cluster.
|
||||||
|
|
||||||
For more information, see [Integrating ML models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/integrating-ml-models/).
|
For more information, see [Integrating ML models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/integrating-ml-models/).
|
||||||
|
|
||||||
|
|
|
@ -26,14 +26,17 @@ To integrate an ML model into your search workflow, choose one of the following
|
||||||
|
|
||||||
For information about uploading your model, see [Using ML models within OpenSearch]({{site.url}}{{site.baseurl}}/ml-commons-plugin/using-ml-models/).
|
For information about uploading your model, see [Using ML models within OpenSearch]({{site.url}}{{site.baseurl}}/ml-commons-plugin/using-ml-models/).
|
||||||
|
|
||||||
1. **Remote model**: This option allows you to connect to a model hosted on a third-party platform. It requires more setup but allows the use of models that are already hosted on a service other than OpenSearch.
|
1. **Externally hosted model**: This option allows you to connect to a model hosted on a third-party platform. It requires more setup but allows the use of models that are already hosted on a service other than OpenSearch.
|
||||||
|
|
||||||
To connect to an externally hosted model, you need to set up a connector:
|
To connect to an externally hosted model, you need to set up a connector:
|
||||||
|
|
||||||
- For a walkthrough with detailed steps, see [Connecting to remote models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/index/).
|
- For a walkthrough with detailed steps, see [Connecting to externally hosted models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/index/).
|
||||||
- For more information about supported connectors, see [Connectors]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/connectors/).
|
- For more information about supported connectors, see [Connectors]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/connectors/).
|
||||||
- For information about creating your own connector, see [Connector blueprints]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/blueprints/).
|
- For information about creating your own connector, see [Connector blueprints]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/blueprints/).
|
||||||
|
|
||||||
|
In OpenSearch version 2.9 and later, you can integrate local and external models simultaneously within a single cluster.
|
||||||
|
{: .note}
|
||||||
|
|
||||||
## Tutorial
|
## Tutorial
|
||||||
|
|
||||||
For a step-by-step tutorial, see [Neural search tutorial]({{site.url}}{{site.baseurl}}/search-plugins/neural-search-tutorial/).
|
For a step-by-step tutorial, see [Neural search tutorial]({{site.url}}{{site.baseurl}}/search-plugins/neural-search-tutorial/).
|
||||||
|
|
|
@ -80,21 +80,6 @@ When access control is enabled, you can install the [Security plugin]({{site.url
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Node settings
|
|
||||||
|
|
||||||
Externally hosted models that are deployed using connectors consume fewer resources. Therefore, you can deploy such models model on data nodes. To make sure that your model connection uses data nodes, set `plugins.ml_commons.only_run_on_ml_node` to `false`:
|
|
||||||
|
|
||||||
```json
|
|
||||||
PUT /_cluster/settings
|
|
||||||
{
|
|
||||||
"persistent": {
|
|
||||||
"plugins.ml_commons.only_run_on_ml_node": false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
{% include copy-curl.html %}
|
|
||||||
|
|
||||||
## Step 1: Register a model group
|
## Step 1: Register a model group
|
||||||
|
|
||||||
To register a model, you have the following options:
|
To register a model, you have the following options:
|
||||||
|
|
Loading…
Reference in New Issue