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] Update ef_search default value to 100 #3436

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Conversation

itaismith
Copy link
Contributor

@itaismith itaismith commented Jan 8, 2025

Description of changes

Update the default value of ef_search to 100. Many users experienced bad recall with large collections, and increasing ef_search generally ameliorates the issue. Example: #1737

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

Collection configuration section updated.

Copy link

github-actions bot commented Jan 8, 2025

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/ef-search-update branch from eeb86b5 to d2e3131 Compare January 8, 2025 03:24
@itaismith itaismith changed the title [ENH] Update ef_search default value to 100 [ENH] Update ef_search default value to 100 Jan 8, 2025
@itaismith itaismith requested a review from atroyn January 8, 2025 05:25
@atroyn
Copy link
Contributor

atroyn commented Jan 8, 2025

I think this is fine, we should communicate the bump in the migration log and explain to people how to get the improvement.

@itaismith
Copy link
Contributor Author

Sounds good. Will include in the next release announcement.

@itaismith itaismith merged commit f987ba6 into main Jan 8, 2025
78 checks passed
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.

2 participants