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.

Sign up for GitHub

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

Jump to bottom

Documentation errors #3086

Closed
epishchik opened this issue Oct 10, 2023 · 1 comment
Closed

Documentation errors #3086

epishchik opened this issue Oct 10, 2023 · 1 comment
Labels
documentation enhancement

Comments

@epishchik
Copy link
Contributor

Summary

The documentation contains errors.

The IndexPQ constructor has duplicate parameter descriptions, metric parameter description doesn't exist.

IndexPQ(int d, size_t M, size_t nbits, MetricType metric = METRIC_L2)
  Constructor.
  
  Parameters:
  - d – dimensionality of the input vectors
  - M – number of subquantizers
  - nbits – number of bit per subvector index
  - d – dimensionality of the input vectors
  - M – number of subquantizers
  - nbits – number of bit per subvector index

Should I write about this here, or maybe fill in a form that I haven't found yet, because there are several such bugs.?
@mdouze
Copy link
Contributor

mdouze commented Oct 11, 2023

Right, this is because the doc is duplicated in Doxygen.

https://github.com/facebookresearch/faiss/blob/main/faiss/IndexPQ.h#L28

If you want to fix it, please submit a PR. Thanks!

@epishchik epishchik mentioned this issue Oct 12, 2023
Closed
facebook-github-bot pushed a commit that referenced this issue Nov 2, 2023
@epishchik @facebook-github-bot
Documentation fixes (#3092)
df7280b 
Summary:
As a follow-up to this issue #3086, I've fixed some bugs in the doxygen-generated documentation.

Pull Request resolved: #3092

Reviewed By: pemazare

Differential Revision: D50595811

Pulled By: mdouze

fbshipit-source-id: 74797d3f2594a20597e1eb6545e91f6eac6d035d
alexanderguzhva added a commit to alexanderguzhva/knowhere that referenced this issue Nov 27, 2023
@alexanderguzhva
Merge commit df7280b5f6d3c85a4b7e6f845e8e042a96b5c7a4 from Faiss mast…
95dadb5 
…er branch

Commit: df7280b5f6d3c85a4b7e6f845e8e042a96b5c7a4
Parents: 6b761503ba073688e3ebeaa60545633dad83d1ba
Author: pe4eniks <evgeniipishchik@mail.ru>
Committer: Facebook GitHub Bot <facebook-github-bot@users.noreply.github.com>
Date: Thu Nov 02 2023 13:06:03 GMT-0400 (Eastern Daylight Time)

Documentation fixes (#3092)

Summary:
As a follow-up to this issue facebookresearch/faiss#3086, I've fixed some bugs in the doxygen-generated documentation.

Pull Request resolved: facebookresearch/faiss#3092

Reviewed By: pemazare

Differential Revision: D50595811

Pulled By: mdouze

fbshipit-source-id: 74797d3f2594a20597e1eb6545e91f6eac6d035d
Signed-off-by: Alexandr Guzhva <alexanderguzhva@gmail.com>
alexanderguzhva added a commit to alexanderguzhva/knowhere that referenced this issue Nov 27, 2023
@alexanderguzhva
Merge commit df7280b5f6d3c85a4b7e6f845e8e042a96b5c7a4 from Faiss mast…
e2aba88 
…er branch

Commit: df7280b5f6d3c85a4b7e6f845e8e042a96b5c7a4
Parents: 6b761503ba073688e3ebeaa60545633dad83d1ba
Author: pe4eniks <evgeniipishchik@mail.ru>
Committer: Facebook GitHub Bot <facebook-github-bot@users.noreply.github.com>
Date: Thu Nov 02 2023 13:06:03 GMT-0400 (Eastern Daylight Time)

Documentation fixes (#3092)

Summary:
As a follow-up to this issue facebookresearch/faiss#3086, I've fixed some bugs in the doxygen-generated documentation.

Pull Request resolved: facebookresearch/faiss#3092

Reviewed By: pemazare

Differential Revision: D50595811

Pulled By: mdouze

fbshipit-source-id: 74797d3f2594a20597e1eb6545e91f6eac6d035d
Signed-off-by: Alexandr Guzhva <alexanderguzhva@gmail.com>
@mdouze mdouze closed this as completed Mar 20, 2024
abhinavdangeti pushed a commit to blevesearch/faiss that referenced this issue Jul 12, 2024
@epishchik @abhinavdangeti
Documentation fixes (facebookresearch#3092)
7e520f0 
Summary:
As a follow-up to this issue facebookresearch#3086, I've fixed some bugs in the doxygen-generated documentation.

Pull Request resolved: facebookresearch#3092

Reviewed By: pemazare

Differential Revision: D50595811

Pulled By: mdouze

fbshipit-source-id: 74797d3f2594a20597e1eb6545e91f6eac6d035d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mdouze @epishchik