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

Improved description of add_items #289

Merged

Conversation

TakaakiFuruse
Copy link
Contributor

This is just a suggestion of doc improvement.

I have made description of labels and data_labels together since...

  1. There's no argument called labels for add_items func.
  2. It felt like labels were a typo of data_labels from a previous commit.

yurymalkov and others added 2 commits February 3, 2021 20:34
This is just a suggestion of doc improvement.

For `add_items` description, I have made `labels` part and `data_labels` part together since...

1. There's no argument called `labels` for `add_items` func.
2. It felt like `labels` were a typo of `data_labels` from a commit 5c20009.
@yurymalkov
Copy link
Member

Hi @TakaakiFuruse
Thank you for the PR!
It seems both names are wrong, and the correct name should be ids...(https://github.com/nmslib/hnswlib/blob/master/python_bindings/bindings.cpp#L664). It seems there are also some other names that are wrong.
I would appreciate if you fix it and update the PR.

@TakaakiFuruse
Copy link
Contributor Author

@yurymalkov

I am happy to fix my PR.

It seems there are also some other names that are wrong.

So for example,

add_items(data, data_labels, num_threads = -1)

should be

add_items(data, ids, num_threads = -1)

??

@yurymalkov
Copy link
Member

Yes, that would be nice!
Other stuff is also wrong. E.g. mark_deleted should have label instead of data_label .
init_index has wrong parameter order (M should come before ef_construction ).

@TakaakiFuruse
Copy link
Contributor Author

@yurymalkov
FIXED!!

@yurymalkov
Copy link
Member

@TakaakiFuruse thank you so much!

@yurymalkov yurymalkov changed the base branch from master to develop March 8, 2021 02:36
@yurymalkov yurymalkov merged commit 8a295df into nmslib:develop Mar 8, 2021
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.

None yet

2 participants