Skip to content

Commit

Permalink
Update code comment regarding PQ's search metrics (#3733)
Browse files Browse the repository at this point in the history
Summary:
Pull Request resolved: #3733

Update code comment in response to Alexandr's inquiry

#3714

Reviewed By: mengdilin

Differential Revision: D60907205

fbshipit-source-id: ae0f2c9208b8bafd4343910a3c539fa40985191d
  • Loading branch information
Amir Sadoughi authored and facebook-github-bot committed Aug 8, 2024
1 parent e5f4647 commit 90b1da4
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion faiss/impl/ProductQuantizer.h
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

0 comments on commit 90b1da4

Please sign in to comment.