opensearch-docs-cn/_ml-commons-plugin/using-ml-models.md

26 lines
1.2 KiB
Markdown
Raw Normal View History

---
layout: default
title: Using ML models within OpenSearch
Add an overview of search methods and pages for each search method (#5636) * Restructuring TOC Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More foundational rewrites of ML Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * TOC restructure Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rename and rewrite search pages and add keyword search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Small wording change Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Small wording change Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated response Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Small rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Move neural search to top of vector search list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change terminology Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Reorganize search methods list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rename links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More link renames Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-11-29 15:28:20 -05:00
parent: Integrating ML models
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
has_children: true
nav_order: 50
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
redirect_from:
- /ml-commons-plugin/model-serving-framework/
- /ml-commons-plugin/ml-framework/
---
# Using ML models within OpenSearch
**Generally available 2.9**
{: .label .label-purple }
Editorial review for Model Framework and Neural Search (#1956) * Fix header in ML commons Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Remove redundant file Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update _ml-commons-plugin/model-serving-framework.md Co-authored-by: Yaliang Wu <ylwu@amazon.com> * Add lines for easier editing Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update _ml-commons-plugin/api.md Co-authored-by: Nate Bower <nbower@amazon.com> * Update _ml-commons-plugin/model-serving-framework.md Co-authored-by: Nate Bower <nbower@amazon.com> * Update _ml-commons-plugin/model-serving-framework.md Co-authored-by: Nate Bower <nbower@amazon.com> * Update _ml-commons-plugin/model-serving-framework.md Co-authored-by: Nate Bower <nbower@amazon.com> * Update _ml-commons-plugin/model-serving-framework.md Co-authored-by: Nate Bower <nbower@amazon.com> * Update _ml-commons-plugin/model-serving-framework.md Co-authored-by: Nate Bower <nbower@amazon.com> * Add ML editorial feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update _ml-commons-plugin/model-serving-framework.md Co-authored-by: Nate Bower <nbower@amazon.com> * Add Neural Search section (#1882) * Add Neural Search section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add getting started instructions Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add example responses to Neural Search Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add neural request fields Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add review tweaks Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add forum link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update _neural-search-plugin/index.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update index.md * Fix second sentence Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Small typos in Neural Search (#1959) * Small typos in Neural Search * Update index.md * Update index.md * Update plugin documentation to reference the CAT API (#1962) * Update plugin documentation to reference the CAT API Signed-off-by: ariamarble <armarble@amazon.com> * made editorial changes Signed-off-by: ariamarble <armarble@amazon.com> Signed-off-by: ariamarble <armarble@amazon.com> * Add ML commons plugin Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change model serving format Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix plugin cap Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Neural Search editorial Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update index.md Incorporate Chris' feedback * Update model-serving-framework.md Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: ariamarble <armarble@amazon.com> Co-authored-by: Yaliang Wu <ylwu@amazon.com> Co-authored-by: Nate Bower <nbower@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Aria Marble <111301581+ariamarble@users.noreply.github.com>
2022-11-17 14:42:24 -05:00
To integrate machine learning (ML) models into your OpenSearch cluster, you can upload and serve them locally. Choose one of the following options:
- **Pretrained models provided by OpenSearch**: To learn more, see [OpenSearch-provided pretrained models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/pretrained-models/). For a list of supported models, see [Supported pretrained models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/pretrained-models/#supported-pretrained-models).
Editorial review for Model Framework and Neural Search (#1956) * Fix header in ML commons Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Remove redundant file Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update _ml-commons-plugin/model-serving-framework.md Co-authored-by: Yaliang Wu <ylwu@amazon.com> * Add lines for easier editing Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update _ml-commons-plugin/api.md Co-authored-by: Nate Bower <nbower@amazon.com> * Update _ml-commons-plugin/model-serving-framework.md Co-authored-by: Nate Bower <nbower@amazon.com> * Update _ml-commons-plugin/model-serving-framework.md Co-authored-by: Nate Bower <nbower@amazon.com> * Update _ml-commons-plugin/model-serving-framework.md Co-authored-by: Nate Bower <nbower@amazon.com> * Update _ml-commons-plugin/model-serving-framework.md Co-authored-by: Nate Bower <nbower@amazon.com> * Update _ml-commons-plugin/model-serving-framework.md Co-authored-by: Nate Bower <nbower@amazon.com> * Add ML editorial feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update _ml-commons-plugin/model-serving-framework.md Co-authored-by: Nate Bower <nbower@amazon.com> * Add Neural Search section (#1882) * Add Neural Search section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add getting started instructions Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add example responses to Neural Search Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add neural request fields Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add review tweaks Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add forum link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update _neural-search-plugin/index.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update index.md * Fix second sentence Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Small typos in Neural Search (#1959) * Small typos in Neural Search * Update index.md * Update index.md * Update plugin documentation to reference the CAT API (#1962) * Update plugin documentation to reference the CAT API Signed-off-by: ariamarble <armarble@amazon.com> * made editorial changes Signed-off-by: ariamarble <armarble@amazon.com> Signed-off-by: ariamarble <armarble@amazon.com> * Add ML commons plugin Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change model serving format Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix plugin cap Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Neural Search editorial Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update index.md Incorporate Chris' feedback * Update model-serving-framework.md Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: ariamarble <armarble@amazon.com> Co-authored-by: Yaliang Wu <ylwu@amazon.com> Co-authored-by: Nate Bower <nbower@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Aria Marble <111301581+ariamarble@users.noreply.github.com>
2022-11-17 14:42:24 -05:00
- **Custom models** such as PyTorch deep learning models: To learn more, see [Custom models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/custom-local-models/).
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
## GPU acceleration
For better performance, you can take advantage of GPU acceleration on your ML node. For more information, see [GPU acceleration]({{site.url}}{{site.baseurl}}/ml-commons-plugin/gpu-acceleration/).