Skip to content

Commit 73292e7

Browse files
Subhadeep Karanfacebook-github-bot
authored andcommitted
Fix typos in documentation, tutorials, and C API
Summary: * `for OpenMP support support` → `for OpenMP support` * `neccesary` → `necessary` * `journal= {arXiv:1702.08734},,` → `journal = {arXiv:1702.08734},` * `verinsion` → `version` * `consistency_check--config` → `consistency_check --config` * `etracted` → `extracted` (2 occurrences) * `sb` → `xb` (variable reference) * `statists` → `statistics` * `elemnts` → `elements` Reviewed By: alibeklfc Differential Revision: D86474214
1 parent 960d1a7 commit 73292e7

File tree

8 files changed

+12
-12
lines changed

8 files changed

+12
-12
lines changed

INSTALL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ found to run on other platforms as well, see
8484
[other platforms](https://github.com/facebookresearch/faiss/wiki/Related-projects#bindings-to-other-languages-and-porting-to-other-platforms).
8585

8686
The basic requirements are:
87-
- a C++17 compiler (with support for OpenMP support version 2 or higher),
87+
- a C++17 compiler (with OpenMP support version 2 or higher),
8888
- a BLAS implementation (on Intel machines we strongly recommend using Intel MKL for best
8989
performance).
9090

@@ -197,7 +197,7 @@ For AVX512 features available since Intel(R) Sapphire Rapids.
197197
$ make -C build -j faiss_avx512_spr
198198
```
199199

200-
This will ensure the creation of neccesary files when building and installing the python package.
200+
This will ensure the creation of necessary files when building and installing the python package.
201201

202202
## Step 3: Building the python bindings (optional)
203203

benchs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ and
1818
```
1919
@inproceedings{JDJ17,
2020
Author = {Jeff Johnson and Matthijs Douze and Herv{\'e} J{\'e}gou},
21-
journal= {arXiv:1702.08734},,
21+
journal = {arXiv:1702.08734},
2222
Title = {Billion-scale similarity search with GPUs},
2323
Year = {2017},
2424
}
@@ -150,10 +150,10 @@ The experiments in the appendix are only in the ArXiv version of the paper (tabl
150150
```
151151
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}
152152
153-
R@1 R@10 R@100 time %pass
154-
nprobe=1,ht=20 0.0351 0.0616 0.0751 0.158 19.01
153+
R@1 R@10 R@100 time %pass
154+
nprobe=1,ht=20 0.0351 0.0616 0.0751 0.158 19.01
155155
...
156-
nprobe=32,ht=28 0.1256 0.3563 0.5026 0.561 52.61
156+
nprobe=32,ht=28 0.1256 0.3563 0.5026 0.561 52.61
157157
...
158158
```
159159
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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ graph to improve the reconstruction. It is described in
2222
ArXiV [here](https://arxiv.org/abs/1804.09996)
2323

2424
The necessary code for this paper was removed from Faiss in version 1.8.0.
25-
For a functioning verinsion, use Faiss 1.7.4.
25+
For a functioning version, use Faiss 1.7.4.

c_api/IndexFlat_c.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ int faiss_IndexFlat_new_with(
3535
*
3636
* @param index opaque pointer to index object
3737
* @param p_xb output, the pointer to the beginning of `xb`.
38-
* @param p_size output, the current size of `sb` in number of float values.
38+
* @param p_size output, the current size of `xb` in number of float values.
3939
*/
4040
void faiss_IndexFlat_xb(FaissIndexFlat* index, float** p_xb, size_t* p_size);
4141

c_api/IndexIVF_c.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ inline void faiss_IndexIVFStats_init(FaissIndexIVFStats* stats) {
174174
faiss_IndexIVFStats_reset(stats);
175175
}
176176

177-
/// global var that collects all statists
177+
/// global var that collects all statistics
178178
FaissIndexIVFStats* faiss_get_indexIVF_stats();
179179

180180
#ifdef __cplusplus

c_api/impl/AuxIndexStructures_c.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ int faiss_BufferList_new(FaissBufferList** p_bl, size_t buffer_size);
136136

137137
int faiss_BufferList_add(FaissBufferList* bl, idx_t id, float dis);
138138

139-
/// copy elemnts ofs:ofs+n-1 seen as linear data in the buffers to
139+
/// copy elements ofs:ofs+n-1 seen as linear data in the buffers to
140140
/// tables dest_ids, dest_dis
141141
int faiss_BufferList_copy_range(
142142
FaissBufferList* bl,

tutorial/python/7-PQFastScan.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
xq[:, 0] += np.arange(nq) / 1000.
1717

1818
m = 8 # 8 specifies that the number of sub-vector is 8
19-
k = 4 # number of dimension in etracted vector
19+
k = 4 # number of dimension in extracted vector
2020
n_bit = 4 # 4 specifies that each sub-vector is encoded as 4 bits
2121
bbs = 32 # build block size ( bbs % 32 == 0 ) for PQ
2222
index = faiss.IndexPQFastScan(d, m, n_bit, faiss.METRIC_L2, bbs)

tutorial/python/8-PQFastScanRefine.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
xq[:, 0] += np.arange(nq) / 1000.
1717

1818
m = 8 # 8 specifies that the number of sub-vector is 8
19-
k = 4 # number of dimension in etracted vector
19+
k = 4 # number of dimension in extracted vector
2020
n_bit = 4 # 4 specifies that each sub-vector is encoded as 4 bits
2121
bbs = 32 # build block size ( bbs % 32 == 0 ) for PQ
2222

0 commit comments

Comments
 (0)