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

adding documentation for model group id #176

Merged
merged 5 commits into from
Jun 20, 2023

Conversation

dhrubo-os
Copy link
Collaborator

@dhrubo-os dhrubo-os commented Jun 12, 2023

Description

[From 2.8 we need to provide model group id during registering the model. So we needed to reflect that change. Also from 2.7 we are supporting to register pre-trained models. So I added detailed explanation in the notebook for better customer experience. ]

Issues Resolved

[List any issues this PR will resolve]

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff

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

@codecov
Copy link

codecov bot commented Jun 12, 2023

Codecov Report

Merging #176 (e7bb142) into main (634726f) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #176      +/-   ##
==========================================
+ Coverage   90.79%   90.80%   +0.01%     
==========================================
  Files          37       37              
  Lines        4042     4047       +5     
==========================================
+ Hits         3670     3675       +5     
  Misses        372      372              
Impacted Files Coverage Δ
opensearch_py_ml/ml_commons/__init__.py 100.00% <100.00%> (ø)
opensearch_py_ml/ml_commons/ml_common_utils.py 100.00% <100.00%> (ø)
opensearch_py_ml/ml_commons/ml_commons_client.py 80.15% <100.00%> (+0.15%) ⬆️
opensearch_py_ml/ml_commons/model_uploader.py 97.43% <100.00%> (-0.27%) ⬇️

Signed-off-by: Dhrubo Saha <dhrubo@amazon.com>
Signed-off-by: Dhrubo Saha <dhrubo@amazon.com>
Signed-off-by: Dhrubo Saha <dhrubo@amazon.com>
Signed-off-by: Dhrubo Saha <dhrubo@amazon.com>
@dhrubo-os dhrubo-os closed this Jun 20, 2023
@dhrubo-os dhrubo-os reopened this Jun 20, 2023
Signed-off-by: Dhrubo Saha <dhrubo@amazon.com>
@rbhavna
Copy link
Collaborator

rbhavna commented Jun 20, 2023

There will be some changes to create model group automatically in the backend when first model version is registered. We might need to reflect those changes to the documentation including this PR.

@dhrubo-os dhrubo-os merged commit 03199fb into opensearch-project:main Jun 20, 2023
@opensearch-trigger-bot
Copy link

The backport to 1.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-1.x 1.x
# Navigate to the new working tree
cd .worktrees/backport-1.x
# Create a new branch
git switch --create backport/backport-176-to-1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 03199fbc7a3a055b9a85971634ee5c94e1354c32
# Push it to GitHub
git push --set-upstream origin backport/backport-176-to-1.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-1.x

Then, create a pull request where the base branch is 1.x and the compare/head branch is backport/backport-176-to-1.x.

b4sjoo pushed a commit to b4sjoo/opensearch-py-ml that referenced this pull request Jun 21, 2023
* adding documentation for model group id

Signed-off-by: Dhrubo Saha <dhrubo@amazon.com>

* fixing release number

Signed-off-by: Dhrubo Saha <dhrubo@amazon.com>

* resolving commits

Signed-off-by: Dhrubo Saha <dhrubo@amazon.com>

* fixing lint

Signed-off-by: Dhrubo Saha <dhrubo@amazon.com>

* adding changelog

Signed-off-by: Dhrubo Saha <dhrubo@amazon.com>

---------

Signed-off-by: Dhrubo Saha <dhrubo@amazon.com>
Signed-off-by: Sicheng Song <sicheng.song@outlook.com>
dhrubo-os added a commit that referenced this pull request Jun 21, 2023
* adding documentation for model group id



* fixing release number



* resolving commits



* fixing lint



* adding changelog



---------

Signed-off-by: Dhrubo Saha <dhrubo@amazon.com>
Signed-off-by: Sicheng Song <sicheng.song@outlook.com>
Co-authored-by: Dhrubo Saha <dhrubo@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants