-
Notifications
You must be signed in to change notification settings - Fork 159
Adds a small section and navigation link to BBQ documentation on the 'Dense vector' page #2575
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
Conversation
🔍 Preview links for changed docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not very familiar with the topic, but this is looking readable and clear. Left a few suggestions for your consideration, hope they are helpful!
Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left a few suggestions to primarily add clarity or add some gravity to certain parts of the docs, which I think can help with instilling confidence in folks who read them. Particularly worth clarifying that BBQ is default only for vectors >384 dims. Please feel free to take or leave any of it. If you have questions or concerns about BBQ or the comments I suggested don't hesitate to ask. In general the docs look good to me and I really appreciate you putting them together. thanks! lgtm
Co-authored-by: John Wagster <[email protected]>
Co-authored-by: John Wagster <[email protected]>
Co-authored-by: John Wagster <[email protected]>
Co-authored-by: John Wagster <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great, my only concern is about splitting reference content between the "solution/use case" docs and the ES reference docs, I think most folks would prefer everything in one place.
So my one ask would be to question whether this content shouldn't live in the ES reference. I think we need to rethink how we approach this entire solution/use case section TBH.
If we're happy to have it here, we'll need to richly link from the ES reference to this content at the very least. :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The content and the structure look great! Nice work!
Agree that it should live in ES reference, specifically under Index settings
from the top of my head. We should add cross-links to this dense vector page that point to the reference material.
Co-authored-by: Liam Thompson <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the changes! LGTM!
📸 Preview
This PR introduces a new section on Better Binary Quantization (BBQ) in the Reference documentation.
In this PR, I've added a link to that newly added page.
Related issue: https://github.com/elastic/developer-docs-team/issues/333