Skip to content

Update code comment regarding PQ's search metrics #3733

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

Closed
asadoughi wants to merge 1 commit into from
Closed

Update code comment regarding PQ's search metrics #3733

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion faiss/impl/ProductQuantizer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,11 @@

namespace faiss {

/** Product Quantizer. Implemented only for METRIC_L2 */
/** Product Quantizer.
* PQ is trained using k-means, minimizing the L2 distance to centroids.
* PQ supports L2 and Inner Product search, however the quantization error is
* biased towards L2 distance.
*/
struct ProductQuantizer : Quantizer {
size_t M; ///< number of subquantizers
size_t nbits; ///< number of bits per quantization index
Expand Down