Skip to content

[KNN] Adding default value for oversampling in 9.1.0 #1290

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Samiul-TheSoccerFan
Copy link
Contributor

Adding default value for oversampling into the knn documentation. We have added this value from 9.1.0.

@Samiul-TheSoccerFan
Copy link
Contributor Author

@jimczi, can I get another review please?

Copy link

@jimczi jimczi left a comment

Choose a reason for hiding this comment

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

I left one comment

@Samiul-TheSoccerFan Samiul-TheSoccerFan requested review from leemthompo and removed request for benwtrent and leemthompo May 6, 2025 13:04
@Samiul-TheSoccerFan
Copy link
Contributor Author

@leemthompo Can I get another re-review please?

Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

Thanks. Let's keep wording the same for consistency.

Can you hold on merging and I'll take care of it? I just want to check with docs team on the latest plans for merging future-looking content.

@@ -913,7 +913,7 @@ All forms of quantization will result in some accuracy loss and as the quantizat

* `int8` requires minimal if any rescoring
* `int4` requires some rescoring for higher accuracy and larger recall scenarios. Generally, oversampling by 1.5x-2x recovers most of the accuracy loss.
* `bbq` requires rescoring except on exceptionally large indices or models specifically designed for quantization. We have found that between 3x-5x oversampling is generally sufficient. But for fewer dimensions or vectors that do not quantize well, higher oversampling may be required.
* `bbq` requires rescoring except on exceptionally large indices or models specifically designed for quantization. We have found that between 3x-5x oversampling is generally sufficient. But for fewer dimensions or vectors that do not quantize well, higher oversampling may be required. As noted above, we default to an oversampling factor of `3.0`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* `bbq` requires rescoring except on exceptionally large indices or models specifically designed for quantization. We have found that between 3x-5x oversampling is generally sufficient. But for fewer dimensions or vectors that do not quantize well, higher oversampling may be required. As noted above, we default to an oversampling factor of `3.0`.
* `bbq` requires rescoring except on exceptionally large indices or models specifically designed for quantization. We have found that between 3x-5x oversampling is generally sufficient. But for fewer dimensions or vectors that do not quantize well, higher oversampling may be required. Starting in `9.1.0`, the default oversampling factor is 3.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, that works. Thank you :)

@leemthompo leemthompo changed the title Adding default value for oversampling in the documentation [KNN] Adding default value for oversampling in 9.1.0 May 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation v9.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants