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

Improved documentation of supported model types in LTR plugin #8831

Conversation

JohannesDaniel
Copy link
Contributor

Description

Enhanced LTR documentation by explicitly mentioning other supported RankLib models and showing RankNet Example

Issues Resolved

Closes opensearch-project/opensearch-learning-to-rank-base#72

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.

…ankLib models and showing RankNet Example

Signed-off-by: Johannes Peter <[email protected]>
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.

Copy link
Collaborator

@epugh epugh left a comment

Choose a reason for hiding this comment

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

LGTM

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, @JohannesDaniel! Just a couple of suggestions.

_search-plugins/ltr/training-models.md Outdated Show resolved Hide resolved
_search-plugins/ltr/training-models.md Outdated Show resolved Hide resolved
_search-plugins/ltr/training-models.md Outdated Show resolved Hide resolved
JohannesDaniel and others added 3 commits December 5, 2024 09:27
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Johannes Peter <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Johannes Peter <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Johannes Peter <[email protected]>
@JohannesDaniel
Copy link
Contributor Author

@kolchfa-aws Thank you, just committed all of your suggestions.

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.

@JohannesDaniel @kolchfa-aws Just a few changes. Thanks!

_search-plugins/ltr/training-models.md Outdated Show resolved Hide resolved
_search-plugins/ltr/training-models.md Outdated Show resolved Hide resolved
@kolchfa-aws kolchfa-aws merged commit e770b61 into opensearch-project:main Dec 6, 2024
5 checks passed
@kolchfa-aws kolchfa-aws added the backport 2.18 PR: Backport label for 2.18 label Dec 6, 2024
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 6, 2024
* Enhanced LTR documentation by explicitly mentioning other supported RankLib models and showing RankNet Example

Signed-off-by: Johannes Peter <[email protected]>

* Update _search-plugins/ltr/training-models.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Johannes Peter <[email protected]>

* Update _search-plugins/ltr/training-models.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Johannes Peter <[email protected]>

* Update _search-plugins/ltr/training-models.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Johannes Peter <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Johannes Peter <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit e770b61)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws added a commit that referenced this pull request Dec 6, 2024
…#8894)

* Enhanced LTR documentation by explicitly mentioning other supported RankLib models and showing RankNet Example



* Update _search-plugins/ltr/training-models.md




* Update _search-plugins/ltr/training-models.md




* Update _search-plugins/ltr/training-models.md




* Apply suggestions from code review




---------





(cherry picked from commit e770b61)

Signed-off-by: Johannes Peter <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.18 PR: Backport label for 2.18
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Improve documentation of supported model types
4 participants