Added tutorial on ML Inference processor with the by-field rerank type #8694
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We needed to show users the power of combining a agnostic remote model inference processor and reranking your documents based on what was returned by the ml inference processor. Testing was done by running a docker compose using the commands shown in the tutorial. Signed-off-by: Brian Flores <[email protected]>
brianf-aws
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
|
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. |
brianf-aws
commented
Nov 7, 2024
_search-plugins/search-relevance/ml-inference-rerank-by-field.md
Outdated
Show resolved
Hide resolved
removed unneeded comment Signed-off-by: Brian Flores <[email protected]>
brianf-aws
commented
Nov 7, 2024
_search-plugins/search-relevance/ml-inference-rerank-by-field.md
Outdated
Show resolved
Hide resolved
Capitalized Harlem Signed-off-by: Brian Flores <[email protected]>
mingshl
reviewed
Nov 7, 2024
_search-plugins/search-relevance/ml-inference-rerank-by-field.md
Outdated
Show resolved
Hide resolved
_search-plugins/search-relevance/ml-inference-rerank-by-field.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Brian Flores <[email protected]>
…ocumentation-website into ml-inference-rerank
ylwu-amzn
reviewed
Nov 8, 2024
_search-plugins/search-relevance/ml-inference-rerank-by-field.md
Outdated
Show resolved
Hide resolved
ylwu-amzn
reviewed
Nov 8, 2024
_search-plugins/search-relevance/ml-inference-rerank-by-field.md
Outdated
Show resolved
Hide resolved
ylwu-amzn
reviewed
Nov 8, 2024
_search-plugins/search-relevance/ml-inference-rerank-by-field.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Brian Flores <[email protected]>
Signed-off-by: Brian Flores <[email protected]>
brianf-aws
commented
Nov 18, 2024
_search-plugins/search-relevance/ml-inference-rerank-by-field.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Brian Flores <[email protected]>
|
Hey @kolchfa-aws! I think this PR is ready to be reviewed. Do you mind taking a look? Thank you |
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
brianf-aws
commented
Nov 20, 2024
_search-plugins/search-relevance/rerank-by-field-cross-encoder.md
Outdated
Show resolved
Hide resolved
_search-plugins/search-relevance/rerank-by-field-cross-encoder.md
Outdated
Show resolved
Hide resolved
_search-plugins/search-relevance/rerank-by-field-cross-encoder.md
Outdated
Show resolved
Hide resolved
_search-plugins/search-relevance/rerank-by-field-cross-encoder.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Brian Flores <[email protected]>
Signed-off-by: Brian Flores <[email protected]>
Signed-off-by: Brian Flores <[email protected]>
Signed-off-by: Brian Flores <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
natebower
reviewed
Nov 25, 2024
There was a problem hiding this comment.
@kolchfa-aws @brianf-aws Please see my comment and changes and let me know if you have any questions. Thanks!
| @@ -0,0 +1,276 @@ | |||
| --- | |||
| layout: default | |||
| title: Reranking by a field using a cross-encoder | |||
There was a problem hiding this comment.
"using an externally hosted cross-encoder model"?
There was a problem hiding this comment.
This is too long for a left nav; that's why I shortened it
_search-plugins/search-relevance/rerank-by-field-cross-encoder.md
Outdated
Show resolved
Hide resolved
_search-plugins/search-relevance/rerank-by-field-cross-encoder.md
Outdated
Show resolved
Hide resolved
_search-plugins/search-relevance/rerank-by-field-cross-encoder.md
Outdated
Show resolved
Hide resolved
_search-plugins/search-relevance/rerank-by-field-cross-encoder.md
Outdated
Show resolved
Hide resolved
_search-plugins/search-relevance/rerank-by-field-cross-encoder.md
Outdated
Show resolved
Hide resolved
_search-plugins/search-relevance/rerank-by-field-cross-encoder.md
Outdated
Show resolved
Hide resolved
_search-plugins/search-relevance/rerank-by-field-cross-encoder.md
Outdated
Show resolved
Hide resolved
_search-plugins/search-relevance/rerank-by-field-cross-encoder.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
kolchfa-aws
approved these changes
Nov 25, 2024
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Nov 25, 2024
#8694) * Added tutorial on ML Inference processor with the by-field rerank type We needed to show users the power of combining a agnostic remote model inference processor and reranking your documents based on what was returned by the ml inference processor. Testing was done by running a docker compose using the commands shown in the tutorial. Signed-off-by: Brian Flores <[email protected]> * Update _search-plugins/search-relevance/ml-inference-rerank-by-field.md removed unneeded comment Signed-off-by: Brian Flores <[email protected]> * Update _search-plugins/search-relevance/ml-inference-rerank-by-field.md Capitalized Harlem Signed-off-by: Brian Flores <[email protected]> * Added SageMaker step and links to processors Signed-off-by: Brian Flores <[email protected]> * fix: grammar and simplifying tutorial Signed-off-by: Brian Flores <[email protected]> * Fix: broken link Signed-off-by: Brian Flores <[email protected]> * Update _search-plugins/search-relevance/ml-inference-rerank-by-field.md Signed-off-by: Brian Flores <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * Add copy button Signed-off-by: Fanit Kolchina <[email protected]> * Small rewrite Signed-off-by: Fanit Kolchina <[email protected]> * Heading change Signed-off-by: Fanit Kolchina <[email protected]> * updating explanation on pipeline config Signed-off-by: Brian Flores <[email protected]> * spacing on config Signed-off-by: Brian Flores <[email protected]> * Added endpoint info Signed-off-by: Brian Flores <[email protected]> * modelUrl -> Sagemaker_endpoint Signed-off-by: Brian Flores <[email protected]> * Rewording Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: Brian Flores <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit db21c43) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
|
Thank you @kolchfa-aws and @natebower! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
We needed to show users the power of combining a agnostic remote model inference processor and reranking your documents based on what was returned by the ml inference processor. Testing was done by running a docker compose using the commands shown in the tutorial.
Issues Resolved
Closes opensearch-project/ml-commons#3175
Closes #8693
Version
2.18
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.