Add documentation for pruning neural sparse vectors #8984
Merged
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
Signed-off-by: zhichao-aws <[email protected]>
zhichao-aws
requested review from
kolchfa-aws,
Naarcha-AWS,
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. |
|
The PR is ready for review now |
kolchfa-aws
reviewed
Dec 24, 2024
kolchfa-aws
reviewed
Dec 24, 2024
_search-plugins/search-pipelines/neural-sparse-query-two-phase-processor.md
Outdated
Show resolved
Hide resolved
_search-plugins/search-pipelines/neural-sparse-query-two-phase-processor.md
Outdated
Show resolved
Hide resolved
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: zhichao-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: zhichao-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: zhichao-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: zhichao-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: zhichao-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: zhichao-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: zhichao-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: zhichao-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: zhichao-aws <[email protected]>
…-processor.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: zhichao-aws <[email protected]>
…-processor.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: zhichao-aws <[email protected]>
|
Thanks @kolchfa-aws ! All suggest changes are taken :) |
kolchfa-aws
added
5 - Editorial review
natebower
reviewed
Jan 2, 2025
There was a problem hiding this comment.
@zhichao-aws @kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!
| | Prune type | Valid prune ratio | Description | | ||
| |:---|:---|:---| | ||
| `max_ratio` | Float [0, 1) | Prunes a sparse vector by keeping only elements whose values are within the `prune_ratio` of the largest value in the vector. | ||
| abs_value | Float in (0, +∞) | Prunes a sparse vector by removing elements with values below the prune_ratio. |
There was a problem hiding this comment.
"below" => "lower than"?
| `max_ratio` | Float [0, 1) | Prunes a sparse vector by keeping only elements whose values are within the `prune_ratio` of the largest value in the vector. | ||
| abs_value | Float in (0, +∞) | Prunes a sparse vector by removing elements with values below the prune_ratio. | ||
| alpha_mass | Float in [0, 1) | Prunes a sparse vector by keeping only elements whose cumulative sum of values is within the prune_ratio of the total sum. | ||
| `top_k` | Integer (0, +∞) | Prunes a sparse vector by keeping only the top `prune_ratio` elements with the highest values. |
There was a problem hiding this comment.
Can "top" be safely removed here (are "top" and "highest values" redundant)?
There was a problem hiding this comment.
It's better to remove "highest values".
_search-plugins/search-pipelines/neural-sparse-query-two-phase-processor.md
Outdated
Show resolved
Hide resolved
_search-plugins/search-pipelines/neural-sparse-query-two-phase-processor.md
Outdated
Show resolved
Hide resolved
kolchfa-aws
reviewed
Jan 2, 2025
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
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
Add documentation for pruning neural sparse vectors.
Issue: opensearch-project/neural-search#946
PR: opensearch-project/neural-search#988
Issues Resolved
Version
2.19
Frontend features
N/A
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.