Skip to content

Add version for ML Predict, Train APIs#763

Merged
dblock merged 1 commit intoopensearch-project:mainfrom
nathaliellenaa:ml-predict-train-version
Jan 21, 2025
Merged

Add version for ML Predict, Train APIs#763
dblock merged 1 commit intoopensearch-project:mainfrom
nathaliellenaa:ml-predict-train-version

Conversation

@nathaliellenaa
Copy link
Copy Markdown
Contributor

Description

Added version for ML train, predict, train and predict APIs.

Issues Resolved

Part of opensearch-project/opensearch-py#867.

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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 3, 2025

Changes Analysis

Commit SHA: d35604b
Comparing To SHA: d8e4583

API Changes

Summary

└─┬Paths
  ├─┬/_plugins/_ml/_train/{algorithm_name}
  │ └─┬POST
  │   └─┬Extensions
  │     └──[➕] x-version-added (4679:24)
  ├─┬/_plugins/_ml/_predict/{algorithm_name}/{model_id}
  │ └─┬POST
  │   └─┬Extensions
  │     └──[➕] x-version-added (4642:24)
  └─┬/_plugins/_ml/_train_predict/{algorithm_name}
    └─┬POST
      └─┬Extensions
        └──[➕] x-version-added (4661:24)

Document Element Total Changes Breaking Changes
paths 3 0
  • Total Changes: 3
  • Additions: 3

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/12893382825/artifacts/2463396033

API Coverage

Before After Δ
Covered (%) 662 (64.84 %) 662 (64.84 %) 0 (0 %)
Uncovered (%) 359 (35.16 %) 359 (35.16 %) 0 (0 %)
Unknown 45 45 0

dblock
dblock previously approved these changes Jan 3, 2025
@Tokesh
Copy link
Copy Markdown
Collaborator

Tokesh commented Jan 4, 2025

Hello!
I quickly checked few versions, at least it should be > 2.1
Maybe I'm wrong somewhere
But I think just in case it's necessary to add tests of other versions specifically for ML

Comment thread spec/namespaces/ml.yaml
@nathaliellenaa
Copy link
Copy Markdown
Contributor Author

Hello! I quickly checked few versions, at least it should be > 2.1 Maybe I'm wrong somewhere But I think just in case it's necessary to add tests of other versions specifically for ML

I tried to set up a 1.3 OpenSearch cluster and run the test, and it seems that the tests for train, predict, train and predict APIs passed.

Screenshot 2025-01-07 at 11 56 32 AM

@Tokesh
Copy link
Copy Markdown
Collaborator

Tokesh commented Jan 7, 2025

Hello! I quickly checked few versions, at least it should be > 2.1 Maybe I'm wrong somewhere But I think just in case it's necessary to add tests of other versions specifically for ML

I tried to set up a 1.3 OpenSearch cluster and run the test, and it seems that the tests for train, predict, train and predict APIs passed.

Screenshot 2025-01-07 at 11 56 32 AM

Great, I apologize for my excessive OCD. I was also trying OS 1.3 with Docker Compose, which we have in the ML folder, and it wouldn't start on these versions, so I thought there might be an error here. Most likely, in the future, if we introduce 1.3 and test on them, we will have to redo the Docker Compose we have there now

Tokesh
Tokesh previously approved these changes Jan 7, 2025
@nathaliellenaa
Copy link
Copy Markdown
Contributor Author

nathaliellenaa commented Jan 7, 2025

Great, I apologize for my excessive OCD. I was also trying OS 1.3 with Docker Compose, which we have in the ML folder, and it wouldn't start on these versions, so I thought there might be an error here. Most likely, in the future, if we introduce 1.3 and test on them, we will have to redo the Docker Compose we have there now

No problem at all! I I referenced the Docker Compose from here, which potentially more accurate :)

Signed-off-by: Nathalie Jonathan <nathhjo@amazon.com>
@github-actions
Copy link
Copy Markdown
Contributor

Spec Test Coverage Analysis

Total Tested
594 593 (99.83 %)

@dblock dblock merged commit 9e75335 into opensearch-project:main Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants