Skip to content

Commit 5cdacca

Browse files
kit1980aalekhpatel07
authored andcommitted
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
1 parent 7b9f4ef commit 5cdacca

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

faiss/python/class_wrappers.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ def replacement_train_encoded(self, x, codec, index, weights=None):
9696
Index used to decode the vectors. Should have dimension `self.d`.
9797
index : faiss.Index
9898
Index used for assignment. The dimension of the index should be `self.d`.
99-
weigths : array_like, optional
99+
weights : array_like, optional
100100
Per training sample weight (size n) used when computing the weighted
101101
average to obtain the centroid (default is 1 for all training vectors).
102102
"""

faiss/python/extra_wrappers.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ def knn(xq, xb, k, metric=METRIC_L2, metric_arg=0.0):
345345
`dtype` must be float32.
346346
k : int
347347
Number of nearest neighbors.
348-
distance_type : MetricType, optional
348+
metric : MetricType, optional
349349
distance measure to use (either METRIC_L2 or METRIC_INNER_PRODUCT)
350350
351351
Returns

0 commit comments

Comments
 (0)