Fix parameter names in docstrings (facebookresearch#3795)

Summary: Pull Request resolved: facebookresearch#3795 Reviewed By: bshethmeta Differential Revision: D61817514 Pulled By: junjieqi fbshipit-source-id: a1b06825b9e4d5a38bd3d800c1e540a8298c80eb
alexanderguzhva · Aug 27, 2024 · 084496a · 084496a
1 parent 3614cc7
commit 084496a
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/faiss/python/class_wrappers.py b/faiss/python/class_wrappers.py
@@ -96,7 +96,7 @@ def replacement_train_encoded(self, x, codec, index, weights=None):
             Index used to decode the vectors. Should have dimension `self.d`.
         index : faiss.Index
             Index used for assignment. The dimension of the index should be `self.d`.
-        weigths : array_like, optional
+        weights : array_like, optional
             Per training sample weight (size n) used when computing the weighted
             average to obtain the centroid (default is 1 for all training vectors).
         """

diff --git a/faiss/python/extra_wrappers.py b/faiss/python/extra_wrappers.py
@@ -345,7 +345,7 @@ def knn(xq, xb, k, metric=METRIC_L2, metric_arg=0.0):
         `dtype` must be float32.
     k : int
         Number of nearest neighbors.
-    distance_type : MetricType, optional
+    metric : MetricType, optional
         distance measure to use (either METRIC_L2 or METRIC_INNER_PRODUCT)
 
     Returns