250 lines
18 KiB
HTML
250 lines
18 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: faiss::gpu::StandardGpuResources Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><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="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</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="namespacefaiss.html">faiss</a></li><li class="navelem"><b>gpu</b></li><li class="navelem"><a class="el" href="classfaiss_1_1gpu_1_1StandardGpuResources.html">StandardGpuResources</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classfaiss_1_1gpu_1_1StandardGpuResources-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">faiss::gpu::StandardGpuResources Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="StandardGpuResources_8h_source.html">StandardGpuResources.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for faiss::gpu::StandardGpuResources:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classfaiss_1_1gpu_1_1StandardGpuResources.png" usemap="#faiss::gpu::StandardGpuResources_map" alt=""/>
|
|
<map id="faiss::gpu::StandardGpuResources_map" name="faiss::gpu::StandardGpuResources_map">
|
|
<area href="classfaiss_1_1gpu_1_1GpuResources.html" alt="faiss::gpu::GpuResources" shape="rect" coords="0,0,205,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a6431477a7328ac147797b3b4e3fcf651"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1StandardGpuResources.html#a6431477a7328ac147797b3b4e3fcf651">noTempMemory</a> ()</td></tr>
|
|
<tr class="separator:a6431477a7328ac147797b3b4e3fcf651"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a367102e65b16bfdc7a32770a4f5854a6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1StandardGpuResources.html#a367102e65b16bfdc7a32770a4f5854a6">setTempMemory</a> (size_t size)</td></tr>
|
|
<tr class="separator:a367102e65b16bfdc7a32770a4f5854a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99ee4e66cb497873de804b9bd9042705"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1StandardGpuResources.html#a99ee4e66cb497873de804b9bd9042705">setTempMemoryFraction</a> (float fraction)</td></tr>
|
|
<tr class="separator:a99ee4e66cb497873de804b9bd9042705"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9acb23ac323f85fa5dab4ed968ccd51"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1StandardGpuResources.html#af9acb23ac323f85fa5dab4ed968ccd51">setPinnedMemory</a> (size_t size)</td></tr>
|
|
<tr class="separator:af9acb23ac323f85fa5dab4ed968ccd51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb2729678638ed89f7b8b38470f96056"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb2729678638ed89f7b8b38470f96056"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1StandardGpuResources.html#adb2729678638ed89f7b8b38470f96056">initializeForDevice</a> (int device) override</td></tr>
|
|
<tr class="memdesc:adb2729678638ed89f7b8b38470f96056"><td class="mdescLeft"> </td><td class="mdescRight">Internal system calls. <br/></td></tr>
|
|
<tr class="separator:adb2729678638ed89f7b8b38470f96056"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7560435c7f45fd59d94ee947330a58da"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7560435c7f45fd59d94ee947330a58da"></a>
|
|
cublasHandle_t </td><td class="memItemRight" valign="bottom"><b>getBlasHandle</b> (int device) override</td></tr>
|
|
<tr class="separator:a7560435c7f45fd59d94ee947330a58da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a954f34ef68fd36b8d502ca3a21f7e8a8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a954f34ef68fd36b8d502ca3a21f7e8a8"></a>
|
|
cudaStream_t </td><td class="memItemRight" valign="bottom"><b>getDefaultStream</b> (int device) override</td></tr>
|
|
<tr class="separator:a954f34ef68fd36b8d502ca3a21f7e8a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ebf68604864cb890a4c2e3d0a6f9952"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ebf68604864cb890a4c2e3d0a6f9952"></a>
|
|
std::vector< cudaStream_t > </td><td class="memItemRight" valign="bottom"><b>getAlternateStreams</b> (int device) override</td></tr>
|
|
<tr class="separator:a9ebf68604864cb890a4c2e3d0a6f9952"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a35da92117dd4b47ee773444af716d634"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35da92117dd4b47ee773444af716d634"></a>
|
|
<a class="el" href="classfaiss_1_1gpu_1_1DeviceMemory.html">DeviceMemory</a> & </td><td class="memItemRight" valign="bottom"><b>getMemoryManager</b> (int device) override</td></tr>
|
|
<tr class="separator:a35da92117dd4b47ee773444af716d634"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae7418f127cac2ac663ac0ae2e6f88e8d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7418f127cac2ac663ac0ae2e6f88e8d"></a>
|
|
std::pair< void *, size_t > </td><td class="memItemRight" valign="bottom"><b>getPinnedMemory</b> () override</td></tr>
|
|
<tr class="separator:ae7418f127cac2ac663ac0ae2e6f88e8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf89d4731c826df889f51fe42287b15d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf89d4731c826df889f51fe42287b15d"></a>
|
|
cudaStream_t </td><td class="memItemRight" valign="bottom"><b>getAsyncCopyStream</b> (int device) override</td></tr>
|
|
<tr class="separator:adf89d4731c826df889f51fe42287b15d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classfaiss_1_1gpu_1_1GpuResources"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classfaiss_1_1gpu_1_1GpuResources')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classfaiss_1_1gpu_1_1GpuResources.html">faiss::gpu::GpuResources</a></td></tr>
|
|
<tr class="memitem:a00cb7bcbc5f1a00da673f30749149b12 inherit pub_methods_classfaiss_1_1gpu_1_1GpuResources"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00cb7bcbc5f1a00da673f30749149b12"></a>
|
|
cublasHandle_t </td><td class="memItemRight" valign="bottom"><b>getBlasHandleCurrentDevice</b> ()</td></tr>
|
|
<tr class="separator:a00cb7bcbc5f1a00da673f30749149b12 inherit pub_methods_classfaiss_1_1gpu_1_1GpuResources"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa0354aa570c24e17a9f8a6a45b153ed2 inherit pub_methods_classfaiss_1_1gpu_1_1GpuResources"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0354aa570c24e17a9f8a6a45b153ed2"></a>
|
|
cudaStream_t </td><td class="memItemRight" valign="bottom"><b>getDefaultStreamCurrentDevice</b> ()</td></tr>
|
|
<tr class="separator:aa0354aa570c24e17a9f8a6a45b153ed2 inherit pub_methods_classfaiss_1_1gpu_1_1GpuResources"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a622f95597cc2ed2f10f3ae9400dc685b inherit pub_methods_classfaiss_1_1gpu_1_1GpuResources"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a622f95597cc2ed2f10f3ae9400dc685b"></a>
|
|
std::vector< cudaStream_t > </td><td class="memItemRight" valign="bottom"><b>getAlternateStreamsCurrentDevice</b> ()</td></tr>
|
|
<tr class="separator:a622f95597cc2ed2f10f3ae9400dc685b inherit pub_methods_classfaiss_1_1gpu_1_1GpuResources"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1dda2dc3db1bd62cde6657c5cdbfb6e1 inherit pub_methods_classfaiss_1_1gpu_1_1GpuResources"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1dda2dc3db1bd62cde6657c5cdbfb6e1"></a>
|
|
<a class="el" href="classfaiss_1_1gpu_1_1DeviceMemory.html">DeviceMemory</a> & </td><td class="memItemRight" valign="bottom"><b>getMemoryManagerCurrentDevice</b> ()</td></tr>
|
|
<tr class="separator:a1dda2dc3db1bd62cde6657c5cdbfb6e1 inherit pub_methods_classfaiss_1_1gpu_1_1GpuResources"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aefb90d15fade57cdfcff03ec800183d4 inherit pub_methods_classfaiss_1_1gpu_1_1GpuResources"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aefb90d15fade57cdfcff03ec800183d4"></a>
|
|
cudaStream_t </td><td class="memItemRight" valign="bottom"><b>getAsyncCopyStreamCurrentDevice</b> ()</td></tr>
|
|
<tr class="separator:aefb90d15fade57cdfcff03ec800183d4 inherit pub_methods_classfaiss_1_1gpu_1_1GpuResources"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Default implementation of <a class="el" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a> that allocates a cuBLAS stream and 2 streams for use, as well as temporary memory </p>
|
|
|
|
<p>Definition at line <a class="el" href="StandardGpuResources_8h_source.html#l00023">23</a> of file <a class="el" href="StandardGpuResources_8h_source.html">StandardGpuResources.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a6431477a7328ac147797b3b4e3fcf651"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void faiss::gpu::StandardGpuResources::noTempMemory </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Disable allocation of temporary memory; all temporary memory requests will call cudaMalloc / cudaFree at the point of use </p>
|
|
|
|
<p>Definition at line <a class="el" href="StandardGpuResources_8cpp_source.html#l00071">71</a> of file <a class="el" href="StandardGpuResources_8cpp_source.html">StandardGpuResources.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af9acb23ac323f85fa5dab4ed968ccd51"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void faiss::gpu::StandardGpuResources::setPinnedMemory </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set amount of pinned memory to allocate, for async GPU <-> CPU transfers </p>
|
|
|
|
<p>Definition at line <a class="el" href="StandardGpuResources_8cpp_source.html#l00089">89</a> of file <a class="el" href="StandardGpuResources_8cpp_source.html">StandardGpuResources.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a367102e65b16bfdc7a32770a4f5854a6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void faiss::gpu::StandardGpuResources::setTempMemory </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Specify that we wish to use a certain fixed size of memory on all devices as temporary memory </p>
|
|
|
|
<p>Definition at line <a class="el" href="StandardGpuResources_8cpp_source.html#l00076">76</a> of file <a class="el" href="StandardGpuResources_8cpp_source.html">StandardGpuResources.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a99ee4e66cb497873de804b9bd9042705"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void faiss::gpu::StandardGpuResources::setTempMemoryFraction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>fraction</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Specify that we wish to use a certain fraction of memory on all devices as temporary memory </p>
|
|
|
|
<p>Definition at line <a class="el" href="StandardGpuResources_8cpp_source.html#l00082">82</a> of file <a class="el" href="StandardGpuResources_8cpp_source.html">StandardGpuResources.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>/data/users/matthijs/github_faiss/faiss/gpu/<a class="el" href="StandardGpuResources_8h_source.html">StandardGpuResources.h</a></li>
|
|
<li>/data/users/matthijs/github_faiss/faiss/gpu/<a class="el" href="StandardGpuResources_8cpp_source.html">StandardGpuResources.cpp</a></li>
|
|
</ul>
|
|
</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>
|