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

search_k documentation is inconsistent #382

Open
txntxn opened this issue Apr 10, 2019 · 3 comments
Open

search_k documentation is inconsistent #382

txntxn opened this issue Apr 10, 2019 · 3 comments

Comments

@txntxn
Copy link

@txntxn txntxn commented Apr 10, 2019

The documentation for search_k is inconsistent.

In some places, it says: "search_k nodes which defaults to n_trees * n if not provided"

In other places, it says: "If search_k is not provided, it will default to n * n_trees * D where n is the number of approximate nearest neighbors and D is a constant depending on the metric."

Which is it?

And if it is D, could you enumerate the different D values for each metric? I searched the code for a few minutes but I was unable to determine what D is.

@erikbern
Copy link
Collaborator

@erikbern erikbern commented Apr 11, 2019

where does it say something about D? that seems incorrect

@txntxn
Copy link
Author

@txntxn txntxn commented Apr 15, 2019

In the README. Perhaps in other places too? But definitely in the README.

@erikbern
Copy link
Collaborator

@erikbern erikbern commented Apr 15, 2019

ok will take a look and fix

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.