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

Update documentation for automatic remote model deployment #6748

Merged
merged 5 commits into from
Mar 25, 2024
Merged

Update documentation for automatic remote model deployment #6748

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
df091fc
update documentation for automatic remote model deployment
Zhangxunmt Mar 20, 2024
1a504f0
add automatic deploy doc in connecting to externall hosted models
Zhangxunmt Mar 20, 2024
1fc0f2e
add remind to undeploy model
Zhangxunmt Mar 21, 2024
876f410
address comments
Zhangxunmt Mar 22, 2024
e178681
Update _ml-commons-plugin/api/model-apis/deploy-model.md
kolchfa-aws Mar 25, 2024
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
14 changes: 13 additions & 1 deletion _ml-commons-plugin/api/model-apis/deploy-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,19 @@

# Deploy a model

The deploy model operation reads the model's chunks from the model index and then creates an instance of the model to cache into memory. This operation requires the `model_id`.
The deploy model operation reads the model's chunks from the model index and then creates an instance of the model to cache into memory. This operation requires the `model_id`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"in" instead of "into"?

kolchfa-aws marked this conversation as resolved.
Show resolved Hide resolved

Starting with OpenSearch version 2.13, [externally hosted models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/index) are deployed automatically by default when you send a Predict API request for the first time. To disable automatic deployment for an externally hosted model, set `plugins.ml_commons.model_auto_deploy.enable` to `false`:

Check failure on line 13 in _ml-commons-plugin/api/model-apis/deploy-model.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/index)'.

Raw Output:
{"message": "[OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/index)'.", "location": {"path": "_ml-commons-plugin/api/model-apis/deploy-model.md", "range": {"start": {"line": 13, "column": 66}}}, "severity": "ERROR"}

```json
PUT _cluster/settings
{
"persistent": {
"plugins.ml_commons.model_auto_deploy.enable": "false"
}
}
```
{% include copy-curl.html %}

For information about user access for this API, see [Model access control considerations]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/index/#model-access-control-considerations).

Expand Down
13 changes: 12 additions & 1 deletion _ml-commons-plugin/remote-models/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,18 @@ Take note of the returned `model_id` because you’ll need it to deploy the mode

## Step 4: Deploy the model

To deploy the registered model, provide its model ID from step 3 in the following request:
Starting with OpenSearch version 2.13, externally hosted models are deployed automatically by default when you send a Predict API request for the first time. To disable automatic deployment for an externally hosted model, set `plugins.ml_commons.model_auto_deploy.enable` to `false`:
```json
PUT _cluster/settings
{
"persistent": {
"plugins.ml_commons.model_auto_deploy.enable" : "false"
}
}
```
{% include copy-curl.html %}

Copy link
Contributor

@ylwu-amzn ylwu-amzn Mar 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Add note that user need to manually undeploy model if they don't need this model

Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
To undeploy the model, use the [Undeploy API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/undeploy-model/).

To undeploy the model, use the [Undeploy API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/undeploy-model/).

```bash
POST /_plugins/_ml/models/cleMb4kBJ1eYAeTMFFg4/_deploy
Expand Down
Loading