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.

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

Add qa model and new settings in ml-commons #6749

Merged
merged 7 commits into from
Mar 25, 2024

Conversation

rbhavna
Copy link
Contributor

@rbhavna rbhavna commented Mar 20, 2024

Description

add qa model and new settings documentation in ml-commons

Issues Resolved

Closes #6744
Closes #6752

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@rbhavna rbhavna changed the title add qa model documentation in ml-commons add qa model and new settings in ml-commons Mar 20, 2024
@hdhalter hdhalter added release-notes PR: Include this PR in the automated release notes v2.13.0 labels Mar 20, 2024
@hdhalter hdhalter changed the title add qa model and new settings in ml-commons Add qa model and new settings in ml-commons Mar 21, 2024
@hdhalter hdhalter added the 4 - Doc review PR: Doc review in progress label Mar 21, 2024
@kolchfa-aws kolchfa-aws self-assigned this Mar 21, 2024
rbhavna and others added 3 commits March 21, 2024 13:27
Signed-off-by: Bhavana Ramaram <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@rbhavna @kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!

_ml-commons-plugin/cluster-settings.md Outdated Show resolved Hide resolved
_ml-commons-plugin/cluster-settings.md Outdated Show resolved Hide resolved
- Default value: `true`
- Valid values: `false`, `true`

## Remote model eligible node roles
Copy link
Collaborator

Choose a reason for hiding this comment

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

"Eligible node roles for remote models"?

_ml-commons-plugin/cluster-settings.md Outdated Show resolved Hide resolved
- Default value: `["data", "ml"]`, which allows externally hosted models to run on data nodes and ML nodes.


## Local model eligible node roles setting
Copy link
Collaborator

Choose a reason for hiding this comment

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

"Eligible node roles setting for local models"?

Running local models on the CentOS 7 operating system is not supported. Moreover, not all local models can run on all hardware and operating systems.
{: .important}

## Preparing a model

For both text embedding and sparse encoding models, you must provide a tokenizer JSON file within the model zip file.
For all the models, you must provide a tokenizer JSON file within the model zip file.
Copy link
Collaborator

Choose a reason for hiding this comment

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

ZIP file?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think zip file should be capitalized.

_ml-commons-plugin/custom-local-models.md Outdated Show resolved Hide resolved
_ml-commons-plugin/custom-local-models.md Outdated Show resolved Hide resolved
_ml-commons-plugin/custom-local-models.md Outdated Show resolved Hide resolved
_ml-commons-plugin/custom-local-models.md Outdated Show resolved Hide resolved
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you, @rbhavna!

@kolchfa-aws kolchfa-aws merged commit 7e8026c into opensearch-project:main Mar 25, 2024
3 checks passed
@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 4 - Doc review PR: Doc review in progress labels Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete release-notes PR: Include this PR in the automated release notes v2.13.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Add ml-commons settings doc [DOC] Add Question Answering model in model serving framework
4 participants