Fix typos in documentation, tutorials, and C API

INSTALL.md

@@ -84,7 +84,7 @@ found to run on other platforms as well, see
 [other platforms](https://github.com/facebookresearch/faiss/wiki/Related-projects#bindings-to-other-languages-and-porting-to-other-platforms).
 
 The basic requirements are:
-- a C++17 compiler (with support for OpenMP support version 2 or higher),
+- a C++17 compiler (with OpenMP support version 2 or higher),
 - a BLAS implementation (on Intel machines we strongly recommend using Intel MKL for best
 performance).
 
@@ -197,7 +197,7 @@ For AVX512 features available since Intel(R) Sapphire Rapids.
 $ make -C build -j faiss_avx512_spr
 ```
 
-This will ensure the creation of neccesary files when building and installing the python package.
+This will ensure the creation of necessary files when building and installing the python package.
 
 ## Step 3: Building the python bindings (optional)
 

benchs/README.md

@@ -18,7 +18,7 @@ and
 ```
 @inproceedings{JDJ17,
    Author = {Jeff Johnson and Matthijs Douze and Herv{\'e} J{\'e}gou},
-   journal= {arXiv:1702.08734},,
+   journal = {arXiv:1702.08734},
    Title = {Billion-scale similarity search with GPUs},
    Year = {2017},
 }
@@ -150,10 +150,10 @@ The experiments in the appendix are only in the ArXiv version of the paper (tabl
 ```
 python bench_polysemous_1bn.py SIFT1000M OPQ8_64,IMI2x13,PQ8 nprobe={1,2,4,8,16,32,64,128},ht={20,24,26,28,30}
 
-               	R@1    R@10   R@100     time    %pass
-nprobe=1,ht=20 	0.0351 0.0616 0.0751    0.158   19.01
+                        R@1    R@10   R@100     time    %pass
+nprobe=1,ht=20          0.0351 0.0616 0.0751    0.158   19.01
 ...
-nprobe=32,ht=28 	0.1256 0.3563 0.5026    0.561   52.61
+nprobe=32,ht=28         0.1256 0.3563 0.5026    0.561   52.61
 ...
 ```
 Here again the runs are not exactly the same but the original result was obtained from nprobe=32,ht=28.

benchs/link_and_code/README.md

@@ -22,4 +22,4 @@ graph to improve the reconstruction. It is described in
 ArXiV [here](https://arxiv.org/abs/1804.09996)
 
 The necessary code for this paper was removed from Faiss in version 1.8.0.
-For a functioning verinsion, use Faiss 1.7.4.
+For a functioning version, use Faiss 1.7.4.

c_api/IndexFlat_c.h

@@ -35,7 +35,7 @@ int faiss_IndexFlat_new_with(
  *
  * @param index   opaque pointer to index object
  * @param p_xb    output, the pointer to the beginning of `xb`.
- * @param p_size  output, the current size of `sb` in number of float values.
+ * @param p_size  output, the current size of `xb` in number of float values.
  */
 void faiss_IndexFlat_xb(FaissIndexFlat* index, float** p_xb, size_t* p_size);
 

c_api/IndexIVF_c.h

@@ -174,7 +174,7 @@ inline void faiss_IndexIVFStats_init(FaissIndexIVFStats* stats) {
     faiss_IndexIVFStats_reset(stats);
 }
 
-/// global var that collects all statists
+/// global var that collects all statistics
 FaissIndexIVFStats* faiss_get_indexIVF_stats();
 
 #ifdef __cplusplus

c_api/impl/AuxIndexStructures_c.h

@@ -136,7 +136,7 @@ int faiss_BufferList_new(FaissBufferList** p_bl, size_t buffer_size);
 
 int faiss_BufferList_add(FaissBufferList* bl, idx_t id, float dis);
 
-/// copy elemnts ofs:ofs+n-1 seen as linear data in the buffers to
+/// copy elements ofs:ofs+n-1 seen as linear data in the buffers to
 /// tables dest_ids, dest_dis
 int faiss_BufferList_copy_range(
         FaissBufferList* bl,

faiss/impl/ResultHandler.h

@@ -572,7 +572,7 @@ struct RangeSearchBlockResultHandler : BlockResultHandler<C, use_sel> {
         RangeSearchPartialResult* pres;
         // there is one RangeSearchPartialResult structure per j0
         // (= block of columns of the large distance matrix)
-        // it is a bit tricky to find the poper PartialResult structure
+        // it is a bit tricky to find the proper PartialResult structure
         // because the inner loop is on db not on queries.
 
         if (pr < j0s.size() && j0 == j0s[pr]) {

faiss/python/class_wrappers.py

@@ -1093,7 +1093,7 @@ def replacement_vt_train(self, x):
         self.train_c(n, swig_ptr(x))
 
     replace_method(the_class, 'train', replacement_vt_train)
-    # apply is reserved in Pyton...
+    # apply is reserved in Python...
     the_class.apply_py = apply_method
     the_class.apply = apply_method
     replace_method(the_class, 'reverse_transform',
@@ -1164,7 +1164,7 @@ def replacement_train_inplace(self, x):
         The index must be trained before vectors can be added to it.
 
         This call WILL change the values in the input array, because
-        of two scaling proceduces being performed inplace.
+        of two scaling procedures being performed inplace.
 
         Parameters
         ----------
@@ -1262,7 +1262,7 @@ def handle_SearchParameters(the_class):
     """ this wrapper is to enable initializations of the form
     SearchParametersXX(a=3, b=SearchParamsYY)
     This also requires the enclosing class to keep a reference on the
-    sub-object, since the C++ code assumes the object ownwership is
+    sub-object, since the C++ code assumes the object ownership is
     handled externally.
     """
     the_class.original_init = the_class.__init__
@@ -1314,7 +1314,7 @@ def replacement_insert(self, codes, inserted=None):
     replace_method(the_class, 'insert', replacement_insert)
 
 ######################################################
-# Syntatic sugar for NeuralNet classes
+# Syntactic sugar for NeuralNet classes
 ######################################################
 
 
@@ -1405,7 +1405,7 @@ def from_array(self, array, bias=None):
     the_class.from_torch = from_torch
 
 ######################################################
-# Syntatic sugar for QINCo and QINCoStep
+# Syntactic sugar for QINCo and QINCoStep
 ######################################################
 
 

faiss/python/extra_wrappers.py

@@ -258,7 +258,7 @@ def add_result(self, D, I):
     def add_result_subset(self, subset, D, I):
         """
         Add results for a subset of heaps.
-        D, I should hold resutls for all the subset
+        D, I should hold results for all the subset
         as a special case, if I is 1D, then all ids are assumed to be the same
         """
         nsubset, kd = D.shape
@@ -591,7 +591,7 @@ def assign(self, x):
 
 
 ###########################################
-# Packing and unpacking bistrings
+# Packing and unpacking bitstrings
 ###########################################
 
 def is_sequence(x):

tutorial/python/7-PQFastScan.py

@@ -16,7 +16,7 @@
 xq[:, 0] += np.arange(nq) / 1000.
 
 m = 8   # 8 specifies that the number of sub-vector is 8
-k = 4   # number of dimension in etracted vector
+k = 4  # number of dimension in extracted vector
 n_bit = 4   # 4 specifies that each sub-vector is encoded as 4 bits
 bbs = 32    # build block size ( bbs % 32 == 0 ) for PQ
 index = faiss.IndexPQFastScan(d, m, n_bit, faiss.METRIC_L2, bbs)

tutorial/python/8-PQFastScanRefine.py

@@ -16,7 +16,7 @@
 xq[:, 0] += np.arange(nq) / 1000.
 
 m = 8  # 8 specifies that the number of sub-vector is 8
-k = 4  # number of dimension in etracted vector
+k = 4  # number of dimension in extracted vector
 n_bit = 4  # 4 specifies that each sub-vector is encoded as 4 bits
 bbs = 32  # build block size ( bbs % 32 == 0 ) for PQ