mirror of
https://github.com/facebookresearch/faiss.git
synced 2025-06-03 21:54:02 +08:00
0df3f646fc
various bugfixes from github issues kmean with some frozen centroids GPU better tiling for large flat datasets default AVX for vector ops
208 lines
21 KiB
HTML
208 lines
21 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.5"/>
|
|
<title>Faiss: /data/users/matthijs/github_faiss/faiss/gpu/perf/WriteIndex.cpp Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Faiss
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_6b3ae6988449b0834e9596fad5d75199.html">gpu</a></li><li class="navelem"><a class="el" href="dir_02dc1cf4df13911cc8cfd20f07047b71.html">perf</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">WriteIndex.cpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2015-present, Facebook, Inc.</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This source code is licensed under the BSD+Patents license found in the</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Copyright 2004-present Facebook. All Rights Reserved.</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "../../IndexIVF.h"</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "../../IndexIVFPQ.h"</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "../../IndexFlat.h"</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "../../index_io.h"</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "../test/TestUtils.h"</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <gflags/gflags.h></span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// For IVFPQ:</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> DEFINE_bool(ivfpq, <span class="keyword">false</span>, <span class="stringliteral">"use IVFPQ encoding"</span>);</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> DEFINE_int32(codes, 4, <span class="stringliteral">"number of PQ codes per vector"</span>);</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> DEFINE_int32(bits_per_code, 8, <span class="stringliteral">"number of bits per PQ code"</span>);</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// For IVFFlat:</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> DEFINE_bool(l2, <span class="keyword">true</span>, <span class="stringliteral">"use L2 metric (versus IP metric)"</span>);</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> DEFINE_bool(ivfflat, <span class="keyword">false</span>, <span class="stringliteral">"use IVF flat encoding"</span>);</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// For both:</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> DEFINE_string(out, <span class="stringliteral">"/home/jhj/local/index.out"</span>, <span class="stringliteral">"index file for output"</span>);</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> DEFINE_int32(dim, 128, <span class="stringliteral">"vector dimension"</span>);</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> DEFINE_int32(num_coarse, 100, <span class="stringliteral">"number of coarse centroids"</span>);</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> DEFINE_int32(num, 100000, <span class="stringliteral">"total database size"</span>);</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> DEFINE_int32(num_train, -1, <span class="stringliteral">"number of database vecs to train on"</span>);</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">void</span> fillAndSave(T& index, <span class="keywordtype">int</span> numTrain, <span class="keywordtype">int</span> num, <span class="keywordtype">int</span> dim) {</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">auto</span> trainVecs = faiss::gpu::randVecs(numTrain, dim);</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  index.train(numTrain, trainVecs.data());</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  constexpr <span class="keywordtype">int</span> kAddChunk = 1000000;</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < num; i += kAddChunk) {</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">int</span> numRemaining = (num - i) < kAddChunk ? (num - i) : kAddChunk;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">auto</span> vecs = faiss::gpu::randVecs(numRemaining, dim);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  printf(<span class="stringliteral">"adding at %d: %d\n"</span>, i, numRemaining);</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  index.add(numRemaining, vecs.data());</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  }</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  faiss::write_index(&index, FLAGS_out.c_str());</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> }</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv) {</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  gflags::ParseCommandLineFlags(&argc, &argv, <span class="keyword">true</span>);</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// Either ivfpq or ivfflat must be set</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">if</span> ((FLAGS_ivfpq && FLAGS_ivfflat) ||</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  (!FLAGS_ivfpq && !FLAGS_ivfflat)) {</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  printf(<span class="stringliteral">"must specify either ivfpq or ivfflat\n"</span>);</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">return</span> 1;</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  }</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">auto</span> dim = FLAGS_dim;</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">auto</span> numCentroids = FLAGS_num_coarse;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">auto</span> num = FLAGS_num;</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">auto</span> numTrain = FLAGS_num_train;</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  numTrain = numTrain == -1 ? std::max((num / 4), 1) : numTrain;</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  numTrain = std::min(num, numTrain);</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">if</span> (FLAGS_ivfpq) {</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="structfaiss_1_1IndexFlatL2.html">faiss::IndexFlatL2</a> quantizer(dim);</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="structfaiss_1_1IndexIVFPQ.html">faiss::IndexIVFPQ</a> index(&quantizer, dim, numCentroids,</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  FLAGS_codes, FLAGS_bits_per_code);</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  index.verbose = <span class="keyword">true</span>;</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  printf(<span class="stringliteral">"IVFPQ: codes %d bits per code %d\n"</span>,</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  FLAGS_codes, FLAGS_bits_per_code);</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  printf(<span class="stringliteral">"Lists: %d\n"</span>, numCentroids);</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  printf(<span class="stringliteral">"Database: dim %d num vecs %d trained on %d\n"</span>, dim, num, numTrain);</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  printf(<span class="stringliteral">"output file: %s\n"</span>, FLAGS_out.c_str());</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  fillAndSave(index, numTrain, num, dim);</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (FLAGS_ivfflat) {</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="structfaiss_1_1IndexFlatL2.html">faiss::IndexFlatL2</a> quantizerL2(dim);</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="structfaiss_1_1IndexFlatIP.html">faiss::IndexFlatIP</a> quantizerIP(dim);</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="structfaiss_1_1IndexFlat.html">faiss::IndexFlat</a>* quantizer = FLAGS_l2 ?</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  (<a class="code" href="structfaiss_1_1IndexFlat.html">faiss::IndexFlat</a>*) &quantizerL2 :</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  (<a class="code" href="structfaiss_1_1IndexFlat.html">faiss::IndexFlat</a>*) &quantizerIP;</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="structfaiss_1_1IndexIVFFlat.html">faiss::IndexIVFFlat</a> index(quantizer, dim, numCentroids,</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  FLAGS_l2 ? faiss::METRIC_L2 :</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  faiss::METRIC_INNER_PRODUCT);</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  printf(<span class="stringliteral">"IVFFlat: metric %s\n"</span>, FLAGS_l2 ? <span class="stringliteral">"L2"</span> : <span class="stringliteral">"IP"</span>);</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  printf(<span class="stringliteral">"Lists: %d\n"</span>, numCentroids);</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  printf(<span class="stringliteral">"Database: dim %d num vecs %d trained on %d\n"</span>, dim, num, numTrain);</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  printf(<span class="stringliteral">"output file: %s\n"</span>, FLAGS_out.c_str());</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  fillAndSave(index, numTrain, num, dim);</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  }</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordflow">return</span> 0;</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> }</div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat_html"><div class="ttname"><a href="structfaiss_1_1IndexFlat.html">faiss::IndexFlat</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00023">IndexFlat.h:23</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlatL2_html"><div class="ttname"><a href="structfaiss_1_1IndexFlatL2.html">faiss::IndexFlatL2</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00079">IndexFlat.h:79</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexIVFFlat_html"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlat.html">faiss::IndexIVFFlat</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00181">IndexIVF.h:181</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlatIP_html"><div class="ttname"><a href="structfaiss_1_1IndexFlatIP.html">faiss::IndexFlatIP</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00073">IndexFlat.h:73</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexIVFPQ_html"><div class="ttname"><a href="structfaiss_1_1IndexIVFPQ.html">faiss::IndexIVFPQ</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFPQ_8h_source.html#l00029">IndexIVFPQ.h:29</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|