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
165 lines
20 KiB
HTML
165 lines
20 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/GpuClonerOptions.h 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> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">GpuClonerOptions.h</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> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "GpuIndicesOptions.h"</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">namespace </span>faiss { <span class="keyword">namespace </span>gpu {</div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">/// set some options on how to copy to GPU</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html"> 17</a></span> <span class="comment"></span><span class="keyword">struct </span><a class="code" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html">GpuClonerOptions</a> {</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <a class="code" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html">GpuClonerOptions</a>();</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> /// how should indices be stored on index types that support indices</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> /// (anything but GpuIndexFlat*)?</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#ad960ac51b7cc607fcb1a1b07efc32a9e"> 22</a></span> <span class="comment"></span> IndicesOptions <a class="code" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#ad960ac51b7cc607fcb1a1b07efc32a9e">indicesOptions</a>;</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> /// is the coarse quantizer in float16?</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#a85f3093908b6e9a503c24bb226b17b1b"> 25</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#a85f3093908b6e9a503c24bb226b17b1b">useFloat16CoarseQuantizer</a>;</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> /// for GpuIndexIVFFlat, is storage in float16?</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> /// for GpuIndexIVFPQ, are intermediate calculations in float16?</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#ac7cc57d6091d6a79ea6020bf8d1fbe27"> 29</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#ac7cc57d6091d6a79ea6020bf8d1fbe27">useFloat16</a>;</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> /// use precomputed tables?</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#abc9c607f2dfc9f23942a523fb49c63fe"> 32</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#abc9c607f2dfc9f23942a523fb49c63fe">usePrecomputed</a>;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> /// reserve vectors in the invfiles?</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#ab60dd87e51af59373a48d73852573f04"> 35</a></span> <span class="comment"></span> <span class="keywordtype">long</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#ab60dd87e51af59373a48d73852573f04">reserveVecs</a>;</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> /// For GpuIndexFlat, store data in transposed layout?</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#a5f2470ec5b2a8fe7aae0542f113b781d"> 38</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#a5f2470ec5b2a8fe7aae0542f113b781d">storeTransposed</a>;</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> /// Set verbose options on the index</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#abc7d0451773e0f2f640338533abc1397"> 41</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#abc7d0451773e0f2f640338533abc1397">verbose</a>;</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> };</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuMultipleClonerOptions.html"> 44</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1gpu_1_1GpuMultipleClonerOptions.html">GpuMultipleClonerOptions</a> : <span class="keyword">public</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html">GpuClonerOptions</a> {</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="structfaiss_1_1gpu_1_1GpuMultipleClonerOptions.html">GpuMultipleClonerOptions</a> ();</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> /// Whether to shard the index across GPUs, versus replication</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> /// across GPUs</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuMultipleClonerOptions.html#a7c5bd7a840f6641d5d68699f4416d79d"> 49</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuMultipleClonerOptions.html#a7c5bd7a840f6641d5d68699f4416d79d">shard</a>;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> /// IndexIVF::copy_subset_to subset type</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuMultipleClonerOptions.html#a9548f823297298b0a78109dec7feb45e"> 52</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuMultipleClonerOptions.html#a9548f823297298b0a78109dec7feb45e">shard_type</a>;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> };</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> } } <span class="comment">// namespace</span></div>
|
|
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuMultipleClonerOptions_html_a7c5bd7a840f6641d5d68699f4416d79d"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuMultipleClonerOptions.html#a7c5bd7a840f6641d5d68699f4416d79d">faiss::gpu::GpuMultipleClonerOptions::shard</a></div><div class="ttdeci">bool shard</div><div class="ttdef"><b>Definition:</b> <a href="GpuClonerOptions_8h_source.html#l00049">GpuClonerOptions.h:49</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuClonerOptions_html_a5f2470ec5b2a8fe7aae0542f113b781d"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#a5f2470ec5b2a8fe7aae0542f113b781d">faiss::gpu::GpuClonerOptions::storeTransposed</a></div><div class="ttdeci">bool storeTransposed</div><div class="ttdoc">For GpuIndexFlat, store data in transposed layout? </div><div class="ttdef"><b>Definition:</b> <a href="GpuClonerOptions_8h_source.html#l00038">GpuClonerOptions.h:38</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuClonerOptions_html"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuClonerOptions.html">faiss::gpu::GpuClonerOptions</a></div><div class="ttdoc">set some options on how to copy to GPU </div><div class="ttdef"><b>Definition:</b> <a href="GpuClonerOptions_8h_source.html#l00017">GpuClonerOptions.h:17</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuClonerOptions_html_abc9c607f2dfc9f23942a523fb49c63fe"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#abc9c607f2dfc9f23942a523fb49c63fe">faiss::gpu::GpuClonerOptions::usePrecomputed</a></div><div class="ttdeci">bool usePrecomputed</div><div class="ttdoc">use precomputed tables? </div><div class="ttdef"><b>Definition:</b> <a href="GpuClonerOptions_8h_source.html#l00032">GpuClonerOptions.h:32</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuMultipleClonerOptions_html"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuMultipleClonerOptions.html">faiss::gpu::GpuMultipleClonerOptions</a></div><div class="ttdef"><b>Definition:</b> <a href="GpuClonerOptions_8h_source.html#l00044">GpuClonerOptions.h:44</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuClonerOptions_html_ac7cc57d6091d6a79ea6020bf8d1fbe27"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#ac7cc57d6091d6a79ea6020bf8d1fbe27">faiss::gpu::GpuClonerOptions::useFloat16</a></div><div class="ttdeci">bool useFloat16</div><div class="ttdef"><b>Definition:</b> <a href="GpuClonerOptions_8h_source.html#l00029">GpuClonerOptions.h:29</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuClonerOptions_html_ad960ac51b7cc607fcb1a1b07efc32a9e"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#ad960ac51b7cc607fcb1a1b07efc32a9e">faiss::gpu::GpuClonerOptions::indicesOptions</a></div><div class="ttdeci">IndicesOptions indicesOptions</div><div class="ttdef"><b>Definition:</b> <a href="GpuClonerOptions_8h_source.html#l00022">GpuClonerOptions.h:22</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuMultipleClonerOptions_html_a9548f823297298b0a78109dec7feb45e"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuMultipleClonerOptions.html#a9548f823297298b0a78109dec7feb45e">faiss::gpu::GpuMultipleClonerOptions::shard_type</a></div><div class="ttdeci">int shard_type</div><div class="ttdoc">IndexIVF::copy_subset_to subset type. </div><div class="ttdef"><b>Definition:</b> <a href="GpuClonerOptions_8h_source.html#l00052">GpuClonerOptions.h:52</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuClonerOptions_html_a85f3093908b6e9a503c24bb226b17b1b"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#a85f3093908b6e9a503c24bb226b17b1b">faiss::gpu::GpuClonerOptions::useFloat16CoarseQuantizer</a></div><div class="ttdeci">bool useFloat16CoarseQuantizer</div><div class="ttdoc">is the coarse quantizer in float16? </div><div class="ttdef"><b>Definition:</b> <a href="GpuClonerOptions_8h_source.html#l00025">GpuClonerOptions.h:25</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuClonerOptions_html_abc7d0451773e0f2f640338533abc1397"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#abc7d0451773e0f2f640338533abc1397">faiss::gpu::GpuClonerOptions::verbose</a></div><div class="ttdeci">bool verbose</div><div class="ttdoc">Set verbose options on the index. </div><div class="ttdef"><b>Definition:</b> <a href="GpuClonerOptions_8h_source.html#l00041">GpuClonerOptions.h:41</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuClonerOptions_html_ab60dd87e51af59373a48d73852573f04"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#ab60dd87e51af59373a48d73852573f04">faiss::gpu::GpuClonerOptions::reserveVecs</a></div><div class="ttdeci">long reserveVecs</div><div class="ttdoc">reserve vectors in the invfiles? </div><div class="ttdef"><b>Definition:</b> <a href="GpuClonerOptions_8h_source.html#l00035">GpuClonerOptions.h:35</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>
|