Skip to content

Fix parameter names in docstrings #3795

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
kit1980 wants to merge 3 commits into from
Closed

Fix parameter names in docstrings #3795

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1fb0fec
Fix parameter name in docstring
kit1980 Aug 26, 2024
77ff2b9
Update extra_wrappers.py
kit1980 Aug 26, 2024
dee4af3
Merge branch 'main' into patch-1
junjieqi Aug 26, 2024
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
2 changes: 1 addition & 1 deletion faiss/python/class_wrappers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
"""
Expand Down
2 changes: 1 addition & 1 deletion faiss/python/extra_wrappers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down