Skip to content

Update neural stats API for 3.1 #10079

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

Merged
merged 6 commits into from
Jun 23, 2025
Merged

Conversation

q-andy
Copy link
Contributor

@q-andy q-andy commented Jun 12, 2025

Description

Updates neural stats for 3.1

Issues Resolved

Closes #9943

Version

3.1

Frontend features

n/a

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.

Signed-off-by: Andy Qin <qinandy@amazon.com>
Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@kolchfa-aws kolchfa-aws added release-notes PR: Include this PR in the automated release notes v3.1.0 labels Jun 13, 2025
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
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.

Thank you, @q-andy! In this documentation, we need to refer to the processors by their names. I rewrote the descriptions in the first couple of tables (making some guesses). Please review my rewrites and edit if necessary. Also, please rewrite the rest of the descriptions using the same verbiage. Thanks!

@kolchfa-aws kolchfa-aws added the Doc review PR: Doc review in progress label Jun 17, 2025
q-andy and others added 3 commits June 23, 2025 10:27
Signed-off-by: Andy Qin <qinandy@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
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.

Thank you, @q-andy! Moving on to editorial review.

@kolchfa-aws kolchfa-aws added Editorial review PR: Editorial review in progress and removed Doc review PR: Doc review in progress labels Jun 23, 2025
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.

Editorial review

Signed-off-by: Nathan Bower <nbower@amazon.com>
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.

LGTM

@natebower natebower removed their assignment Jun 23, 2025
@natebower natebower removed the Editorial review PR: Editorial review in progress label Jun 23, 2025
@natebower natebower merged commit 71a9824 into opensearch-project:main Jun 23, 2025
6 checks passed
akshansh-modi pushed a commit to akshansh-modi/documentation-website that referenced this pull request Jul 2, 2025
* Update neural stats API for 3.1

Signed-off-by: Andy Qin <qinandy@amazon.com>

* Doc review -I

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Use full processor names

Signed-off-by: Andy Qin <qinandy@amazon.com>

* More renamings

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Signed-off-by: Nathan Bower <nbower@amazon.com>

---------

Signed-off-by: Andy Qin <qinandy@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Nathan Bower <nbower@amazon.com>
Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: apple <akshanshmodi2002@gmail.com>
epugh pushed a commit to o19s/documentation-website that referenced this pull request Jul 2, 2025
* Update neural stats API for 3.1

Signed-off-by: Andy Qin <qinandy@amazon.com>

* Doc review -I

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Use full processor names

Signed-off-by: Andy Qin <qinandy@amazon.com>

* More renamings

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Signed-off-by: Nathan Bower <nbower@amazon.com>

---------

Signed-off-by: Andy Qin <qinandy@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Nathan Bower <nbower@amazon.com>
Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-notes PR: Include this PR in the automated release notes v3.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Update neural-search stats API docs with new stats added in 3.1
3 participants