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

Java Docs Fix for 2.x in Linux Machine #2191

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
### Bug Fixes
* KNN80DocValues should only be considered for BinaryDocValues fields [#2147](https://github.com/opensearch-project/k-NN/pull/2147)
* Score Fix for Binary Quantized Vector and Setting Default value in case of shard level rescoring is disabled for oversampling factor[#2183](https://github.com/opensearch-project/k-NN/pull/2183)
* Java Docs Fix For 2.x
### Infrastructure
### Documentation
### Maintenance
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,30 +43,6 @@ public final class RescoreContext {
* Flag to track whether the oversample factor is user-provided or default. The Reason to introduce
* this is to set default when Shard Level rescoring is false,
* else we end up overriding user provided value in NativeEngineKnnVectorQuery
*
*
* This flag is crucial to differentiate between user-defined oversample factors and system-assigned
* default values. The behavior of oversampling logic, especially when shard-level rescoring is disabled,
* depends on whether the user explicitly provided an oversample factor or whether the system is using
* a default value.
*
* When shard-level rescoring is disabled, the system applies dimension-based oversampling logic,
* overriding any default values. However, if the user provides their own oversample factor, the system
* should respect the user’s input and avoid overriding it with the dimension-based logic.
*
* This flag is set to {@code true} when the oversample factor is provided by the user, ensuring
* that their value is not overridden. It is set to {@code false} when the oversample factor is
* determined by system defaults (e.g., through a compression level or automatic logic). The system
* then applies its own oversampling rules if necessary.
*
* Key scenarios:
* - If {@code userProvided} is {@code true} and shard-level rescoring is disabled, the user's
* oversample factor is used as is, without applying the dimension-based logic.
* - If {@code userProvided} is {@code false}, the system applies dimension-based oversampling
* when shard-level rescoring is disabled.
*
* This flag enables flexibility, allowing the system to handle both user-defined and default
* behaviors, ensuring the correct oversampling logic is applied based on the context.
*/
@Builder.Default
private boolean userProvided = true;
Expand Down
Loading