Skip to content

Add ML Profile APIs#787

Merged
dblock merged 4 commits intoopensearch-project:mainfrom
nathaliellenaa:add-ml-profile-api
Jan 14, 2025
Merged

Add ML Profile APIs#787
dblock merged 4 commits intoopensearch-project:mainfrom
nathaliellenaa:add-ml-profile-api

Conversation

@nathaliellenaa
Copy link
Copy Markdown
Contributor

@nathaliellenaa nathaliellenaa commented Jan 13, 2025 •
edited
Loading

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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 13, 2025 •
edited
Loading

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
Copy Markdown
Contributor Author

nathaliellenaa commented Jan 13, 2025 •
edited
Loading

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

@dblock
Copy link
Copy Markdown
Member

dblock commented Jan 14, 2025

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

@nathaliellenaa
Added ML get profile APIs.
fde866b 
Signed-off-by: Nathalie Jonathan <nathhjo@amazon.com>
@nathaliellenaa
Modified response payload state from RUNNING to COMPLETED, updated PR…
c79be48 
… link in CHANGELOG.md.

Signed-off-by: Nathalie Jonathan <nathhjo@amazon.com>
@nathaliellenaa
Rebase, changed native memory threshold settings to JVP heap memory t…
96579ce 
…hreshold, fixed vale errors.

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

github-actions bot commented Jan 14, 2025

Spec Test Coverage Analysis

Total Tested
582 581 (99.83 %)

dblock
dblock suggested changes Jan 14, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@dblock dblock left a comment •
edited
Loading

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.

Comment thread tests/plugins/ml/ml/profile/get.yaml
Comment thread tests/plugins/ml/ml/profile/get_models.yaml
Comment thread tests/plugins/ml/ml/profile/get_tasks.yaml
@dblock dblock mentioned this pull request Jan 14, 2025
Closed
@nathaliellenaa
Copy link
Copy Markdown
Contributor Author

nathaliellenaa 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?

@nathaliellenaa
Renamed files to follow the naming convention.
b55abd6 
Signed-off-by: Nathalie Jonathan <nathhjo@amazon.com>
@dblock
Copy link
Copy Markdown
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
@nathaliellenaa
Copy link
Copy Markdown
Contributor Author

nathaliellenaa commented Jan 14, 2025

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.

@nathaliellenaa nathaliellenaa mentioned this pull request Jan 15, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@harshavamsi harshavamsi Awaiting requested review from harshavamsi harshavamsi is a code owner

@sachetalva sachetalva Awaiting requested review from sachetalva sachetalva is a code owner

@nhtruong nhtruong Awaiting requested review from nhtruong

@Xtansia Xtansia Awaiting requested review from Xtansia Xtansia is a code owner

@VachaShah VachaShah Awaiting requested review from VachaShah VachaShah is a code owner

@Tokesh Tokesh Awaiting requested review from Tokesh Tokesh is a code owner

@aabeshov aabeshov Awaiting requested review from aabeshov aabeshov is a code owner

1 more reviewer

@dblock dblock dblock approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@nathaliellenaa @dblock