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

[ENH] Consume HNSW from config #2895

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

itaismith
Copy link
Contributor

@itaismith itaismith commented Oct 3, 2024

Description of changes

  • Consume HNSW parameters from a collection's HNSWConfiguration instead of metadata.
  • Remove usage of hnsw: metadata values to set HNSW parameters.
  • Migrate older versions to use the new HNSWConfiguration.

Test plan

  • property tests to validate new behavior with various HNSWConfigurations.
  • cross_version to test migrating to new behavior.
  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

WIP

  • Add documentation to demonstrate how to set HNSW parameters with an HNSWConfiguration.

Note: API work on configuration builders is also in progress.

Copy link

github-actions bot commented Oct 3, 2024

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@itaismith itaismith force-pushed the itai/consume-collection-config branch 6 times, most recently from 577ab25 to 92fd102 Compare October 3, 2024 22:13
@itaismith itaismith requested a review from HammadB October 7, 2024 16:27
@itaismith itaismith force-pushed the itai/consume-collection-config branch 2 times, most recently from 3c1f172 to 214b216 Compare October 9, 2024 23:18
@itaismith itaismith force-pushed the itai/consume-collection-config branch from 962a90f to 49de7c2 Compare October 10, 2024 05:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant