Skip to content

Commit 0e18107

Browse files
lee-taejunfacebook-github-bot
authored andcommitted
Fix incorrect constructor docstring for IndexScalarQuantizer (#4350)
Summary: This PR fixes a docstring inconsistency in the IndexScalarQuantizer constructor. The current doc refers to M and nbits, which are not actual parameters. This change updates the documentation to reflect the correct usage: (d, qtype, metric). Pull Request resolved: #4350 Reviewed By: subhadeepkaran Differential Revision: D75803130 Pulled By: mnorris11 fbshipit-source-id: cf773e461234c68f079850f4e6691f4602f25790
1 parent 043534c commit 0e18107

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

faiss/IndexScalarQuantizer.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ struct IndexScalarQuantizer : IndexFlatCodes {
2929
/** Constructor.
3030
*
3131
* @param d dimensionality of the input vectors
32-
* @param M number of subquantizers
33-
* @param nbits number of bit per subvector index
32+
* @param qtype type of scalar quantizer (e.g., QT_4bit)
33+
* @param metric distance metric used for search (default: METRIC_L2)
3434
*/
3535
IndexScalarQuantizer(
3636
int d,

0 commit comments

Comments
 (0)