Skip to content

Commit ec877e7

Browse files
Subhadeep Karanmeta-codesync[bot]
authored andcommitted
Fix typos in comments and documentation (#4660)
Summary: Pull Request resolved: #4660 Fixed 41 typos across 23 files in the faiss codebase, primarily in comments and documentation strings. These typos were identified through a comprehensive review of all source files. Most common fixes: - "vecors" → "vectors" (3 occurrences) - "bissection" → "bisection" (3 occurrences) - "Syntatic" → "Syntactic" (2 occurrences) - "streans" → "streams" (2 occurrences) All changes are in comments, docstrings, or documentation - no functional code changes. Reviewed By: juancarpio27 Differential Revision: D86404695 fbshipit-source-id: 48d7399747ef7929e72933acac03d012fa69e514
1 parent 3de200f commit ec877e7

File tree

8 files changed

+8
-8
lines changed

8 files changed

+8
-8
lines changed

faiss/AutoTune.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ bool OperatingPoints::add(
125125
}
126126
} else {
127127
int i;
128-
// stricto sensu this should be a bissection
128+
// stricto sensu this should be a bisection
129129
for (i = 0; i < a.size(); i++) {
130130
if (a[i].perf >= perf) {
131131
break;

faiss/AutoTune.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ struct AutoTuneCriterion {
3232

3333
AutoTuneCriterion(idx_t nq, idx_t nnn);
3434

35-
/** Intitializes the gt_D and gt_I vectors. Must be called before evaluating
35+
/** Initializes the gt_D and gt_I vectors. Must be called before evaluating
3636
*
3737
* @param gt_D_in size nq * gt_nnn
3838
* @param gt_I_in size nq * gt_nnn

faiss/Clustering.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ struct Clustering : ClusteringParameters {
109109

110110
/** run with encoded vectors
111111
*
112-
* win addition to train()'s parameters takes a codec as parameter
112+
* in addition to train()'s parameters takes a codec as parameter
113113
* to decode the input vectors.
114114
*
115115
* @param codec codec used to decode the vectors (nullptr =

faiss/Index.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ struct Index {
125125
/** Perform training on a representative set of vectors
126126
*
127127
* @param n nb of training vectors
128-
* @param x training vecors, size n * d
128+
* @param x training vectors, size n * d
129129
*/
130130
virtual void train(idx_t n, const float* x);
131131

faiss/IndexBinary.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ struct IndexBinary {
4949
/** Perform training on a representative set of vectors.
5050
*
5151
* @param n nb of training vectors
52-
* @param x training vecors, size n * d / 8
52+
* @param x training vectors, size n * d / 8
5353
*/
5454
virtual void train(idx_t n, const uint8_t* x);
5555
virtual void train_ex(idx_t n, const void* x, NumericType numeric_type) {

faiss/IndexFlat.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ struct IndexFlat : IndexFlatCodes {
6666

6767
FlatCodesDistanceComputer* get_FlatCodesDistanceComputer() const override;
6868

69-
/* The stanadlone codec interface (just memcopies in this case) */
69+
/* The standalone codec interface (just memcopies in this case) */
7070
void sa_encode(idx_t n, const float* x, uint8_t* bytes) const override;
7171

7272
void sa_decode(idx_t n, const uint8_t* bytes, float* x) const override;

faiss/MetricType.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ enum MetricType {
3535

3636
/// sum_i(min(a_i, b_i)) / sum_i(max(a_i, b_i)) where a_i, b_i > 0
3737
METRIC_Jaccard,
38-
/// Squared Eucliden distance, ignoring NaNs
38+
/// Squared Euclidean distance, ignoring NaNs
3939
METRIC_NaNEuclidean,
4040
/// Gower's distance - numeric dimensions are in [0,1] and categorical
4141
/// dimensions are negative integers

faiss/VectorTransform.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ struct VectorTransform {
3737
* nothing by default.
3838
*
3939
* @param n nb of training vectors
40-
* @param x training vecors, size n * d
40+
* @param x training vectors, size n * d
4141
*/
4242
virtual void train(idx_t n, const float* x);
4343

0 commit comments

Comments
 (0)