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 ML Profile APIs #787

Merged
merged 4 commits into from
Jan 14, 2025

Conversation

nathaliellenaa
Copy link
Contributor

@nathaliellenaa nathaliellenaa commented Jan 13, 2025

Description

Added missing ML Profile APIs.

Issues Resolved

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

ML Profile APIs to add

  • GET /_plugins/_ml/profile
  • GET /_plugins/_ml/profile/models
  • GET /_plugins/_ml/profile/models/{model_id}
  • GET /_plugins/_ml/profile/tasks
  • GET /_plugins/_ml/profile/tasks/{task_id}

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.

Copy link
Contributor

github-actions bot commented Jan 13, 2025

Changes Analysis

Commit SHA: b55abd6
Comparing To SHA: 5e22b8b

API Changes

Summary

├─┬Paths
│ ├──[➕] path (5546:3)
│ ├──[➕] path (5529:3)
│ ├──[➕] path (5598:3)
│ ├──[➕] path (5581:3)
│ └──[➕] path (5563:3)
└─┬Components
  ├──[➕] requestBodies (28168:7)
  ├──[➕] requestBodies (28163:7)
  ├──[➕] requestBodies (28173:7)
  ├──[➕] responses (31784:7)
  ├──[➕] responses (31796:7)
  ├──[➕] responses (31790:7)
  ├──[➕] parameters (23746:7)
  ├──[➕] parameters (23752:7)
  ├──[➕] schemas (55990:7)
  ├──[➕] schemas (55619:7)
  ├──[➕] schemas (56130:7)
  ├──[➕] schemas (55921:7)
  ├──[➕] schemas (56172:7)
  ├──[➕] schemas (55956:7)
  ├──[➕] schemas (55983:7)
  └──[➕] schemas (56646:7)

Document Element Total Changes Breaking Changes
paths 5 0
components 16 0
  • Total Changes: 21
  • Additions: 21

Report

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

API Coverage

Before After Δ
Covered (%) 647 (63.37 %) 652 (63.86 %) 5 (0.49 %)
Uncovered (%) 374 (36.63 %) 369 (36.14 %) -5 (-0.49 %)
Unknown 43 43 0

@nathaliellenaa
Copy link
Contributor Author

nathaliellenaa commented Jan 13, 2025

Seems like the Memory Circuit Breaker flaky error still persists even after this fix was made. Created a new fix.

@dblock
Copy link
Member

dblock commented Jan 14, 2025

Check out vale/review errors in the diff, some spellings.

Signed-off-by: Nathalie Jonathan <nathhjo@amazon.com>
… link in CHANGELOG.md.

Signed-off-by: Nathalie Jonathan <nathhjo@amazon.com>
…hreshold, fixed vale errors.

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

Spec Test Coverage Analysis

Total Tested
582 581 (99.83 %)

Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

File naming doesn't follow convention.

We really need something that enforces it automagically. I opened #792.

tests/plugins/ml/ml/profile/get.yaml Outdated Show resolved Hide resolved
tests/plugins/ml/ml/profile/get_models.yaml Outdated Show resolved Hide resolved
tests/plugins/ml/ml/profile/get_tasks.yaml Outdated Show resolved Hide resolved
@nathaliellenaa
Copy link
Contributor Author

File naming doesn't follow convention.

We really need something that enforces it automagically. I opened #792.

Agree, it's a nice feature to have! Is there any doc or clear rule about the file naming convention?

Signed-off-by: Nathalie Jonathan <nathhjo@amazon.com>
@dblock
Copy link
Member

dblock commented Jan 14, 2025

File naming doesn't follow convention.
We really need something that enforces it automagically. I opened #792.

Agree, it's a nice feature to have! Is there any doc or clear rule about the file naming convention?

We have https://github.com/opensearch-project/opensearch-api-specification/blob/main/TESTING_GUIDE.md#writing-spec-tests. Maybe you want to improve it at least to match my idea of naming? ;)

@dblock dblock merged commit 806b25f into opensearch-project:main Jan 14, 2025
30 checks passed
@nathaliellenaa
Copy link
Contributor Author

We have https://github.com/opensearch-project/opensearch-api-specification/blob/main/TESTING_GUIDE.md#writing-spec-tests. Maybe you want to improve it at least to match my idea of naming? ;)

Sure, I'll open an issue for the improvement.

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.

2 participants