Skip to content

Commit

Permalink
Sphinx rebuild (8d3fa91).
Browse files Browse the repository at this point in the history
  • Loading branch information
facebook-github-bot committed Nov 20, 2024
1 parent 8d3fa91 commit 380e656
Show file tree
Hide file tree
Showing 11 changed files with 177 additions and 10 deletions.
14 changes: 13 additions & 1 deletion docs/cpp_api/class/classfaiss_1_1gpu_1_1GpuResources.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,12 @@ <h1>Class faiss::gpu::GpuResources<a class="headerlink" href="#class-faiss-gpu-g
<dd><p>Call to pre-allocate resources for a particular device. If this is not called, then resources will be allocated at the first time of demand </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu12GpuResources16supportsBFloat16Ei">
<span id="_CPPv3N5faiss3gpu12GpuResources16supportsBFloat16Ei"></span><span id="_CPPv2N5faiss3gpu12GpuResources16supportsBFloat16Ei"></span><span id="faiss::gpu::GpuResources::supportsBFloat16__i"></span><span class="target" id="classfaiss_1_1gpu_1_1GpuResources_1ab4b064a700f9d3d6ecf486be6e23c55c"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">supportsBFloat16</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">device</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5faiss3gpu12GpuResources16supportsBFloat16Ei" title="Permalink to this definition"></a><br /></dt>
<dd><p>Does the given GPU support bfloat16? </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu12GpuResources13getBlasHandleEi">
<span id="_CPPv3N5faiss3gpu12GpuResources13getBlasHandleEi"></span><span id="_CPPv2N5faiss3gpu12GpuResources13getBlasHandleEi"></span><span id="faiss::gpu::GpuResources::getBlasHandle__i"></span><span class="target" id="classfaiss_1_1gpu_1_1GpuResources_1aa2682b8503dfdab4f7f5ef867035ad29"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">cublasHandle_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getBlasHandle</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">device</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5faiss3gpu12GpuResources13getBlasHandleEi" title="Permalink to this definition"></a><br /></dt>
Expand Down Expand Up @@ -182,11 +188,17 @@ <h1>Class faiss::gpu::GpuResources<a class="headerlink" href="#class-faiss-gpu-g
<dd><p>Returns the stream on which we perform async CPU &lt;-&gt; GPU copies. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu12GpuResources29supportsBFloat16CurrentDeviceEv">
<span id="_CPPv3N5faiss3gpu12GpuResources29supportsBFloat16CurrentDeviceEv"></span><span id="_CPPv2N5faiss3gpu12GpuResources29supportsBFloat16CurrentDeviceEv"></span><span id="faiss::gpu::GpuResources::supportsBFloat16CurrentDevice"></span><span class="target" id="classfaiss_1_1gpu_1_1GpuResources_1a867681740486f732c786f0d1af782076"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">supportsBFloat16CurrentDevice</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5faiss3gpu12GpuResources29supportsBFloat16CurrentDeviceEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Does the current GPU support bfloat16? </p>
<p>Functions provided by default </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu12GpuResources26getBlasHandleCurrentDeviceEv">
<span id="_CPPv3N5faiss3gpu12GpuResources26getBlasHandleCurrentDeviceEv"></span><span id="_CPPv2N5faiss3gpu12GpuResources26getBlasHandleCurrentDeviceEv"></span><span id="faiss::gpu::GpuResources::getBlasHandleCurrentDevice"></span><span class="target" id="classfaiss_1_1gpu_1_1GpuResources_1a00cb7bcbc5f1a00da673f30749149b12"></span><span class="n"><span class="pre">cublasHandle_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getBlasHandleCurrentDevice</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5faiss3gpu12GpuResources26getBlasHandleCurrentDeviceEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Calls getBlasHandle with the current device. </p>
<p>Functions provided by default </p>
</dd></dl>

<dl class="cpp function">
Expand Down
12 changes: 12 additions & 0 deletions docs/cpp_api/class/classfaiss_1_1gpu_1_1StandardGpuResources.html
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,18 @@ <h1>Class faiss::gpu::StandardGpuResources<a class="headerlink" href="#class-fai
<dd><p>Returns the shared resources object. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu20StandardGpuResources16supportsBFloat16Ei">
<span id="_CPPv3N5faiss3gpu20StandardGpuResources16supportsBFloat16Ei"></span><span id="_CPPv2N5faiss3gpu20StandardGpuResources16supportsBFloat16Ei"></span><span id="faiss::gpu::StandardGpuResources::supportsBFloat16__i"></span><span class="target" id="classfaiss_1_1gpu_1_1StandardGpuResources_1acbb018d9baccc288a6d36f5509c83fb9"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">supportsBFloat16</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">device</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5faiss3gpu20StandardGpuResources16supportsBFloat16Ei" title="Permalink to this definition"></a><br /></dt>
<dd><p>Whether or not the given device supports native bfloat16 arithmetic. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu20StandardGpuResources29supportsBFloat16CurrentDeviceEv">
<span id="_CPPv3N5faiss3gpu20StandardGpuResources29supportsBFloat16CurrentDeviceEv"></span><span id="_CPPv2N5faiss3gpu20StandardGpuResources29supportsBFloat16CurrentDeviceEv"></span><span id="faiss::gpu::StandardGpuResources::supportsBFloat16CurrentDevice"></span><span class="target" id="classfaiss_1_1gpu_1_1StandardGpuResources_1a3166b521fbdf5a1f1ccb14a8ced3ae00"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">supportsBFloat16CurrentDevice</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5faiss3gpu20StandardGpuResources29supportsBFloat16CurrentDeviceEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Whether or not the current device supports native bfloat16 arithmetic. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu20StandardGpuResources12noTempMemoryEv">
<span id="_CPPv3N5faiss3gpu20StandardGpuResources12noTempMemoryEv"></span><span id="_CPPv2N5faiss3gpu20StandardGpuResources12noTempMemoryEv"></span><span id="faiss::gpu::StandardGpuResources::noTempMemory"></span><span class="target" id="classfaiss_1_1gpu_1_1StandardGpuResources_1a6431477a7328ac147797b3b4e3fcf651"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">noTempMemory</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5faiss3gpu20StandardGpuResources12noTempMemoryEv" title="Permalink to this definition"></a><br /></dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,12 @@ <h1>Class faiss::gpu::StandardGpuResourcesImpl<a class="headerlink" href="#class
<span id="_CPPv3N5faiss3gpu24StandardGpuResourcesImplD0Ev"></span><span id="_CPPv2N5faiss3gpu24StandardGpuResourcesImplD0Ev"></span><span id="faiss::gpu::StandardGpuResourcesImpl::~StandardGpuResourcesImpl"></span><span class="target" id="classfaiss_1_1gpu_1_1StandardGpuResourcesImpl_1a6c05d4e676be74d65d44ccb23eb63f63"></span><span class="sig-name descname"><span class="n"><span class="pre">~StandardGpuResourcesImpl</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5faiss3gpu24StandardGpuResourcesImplD0Ev" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu24StandardGpuResourcesImpl16supportsBFloat16Ei">
<span id="_CPPv3N5faiss3gpu24StandardGpuResourcesImpl16supportsBFloat16Ei"></span><span id="_CPPv2N5faiss3gpu24StandardGpuResourcesImpl16supportsBFloat16Ei"></span><span id="faiss::gpu::StandardGpuResourcesImpl::supportsBFloat16__i"></span><span class="target" id="classfaiss_1_1gpu_1_1StandardGpuResourcesImpl_1ad2267943823c25e95b28733bf1177935"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">supportsBFloat16</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">device</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5faiss3gpu24StandardGpuResourcesImpl16supportsBFloat16Ei" title="Permalink to this definition"></a><br /></dt>
<dd><p>Does the given GPU support bfloat16? </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu24StandardGpuResourcesImpl12noTempMemoryEv">
<span id="_CPPv3N5faiss3gpu24StandardGpuResourcesImpl12noTempMemoryEv"></span><span id="_CPPv2N5faiss3gpu24StandardGpuResourcesImpl12noTempMemoryEv"></span><span id="faiss::gpu::StandardGpuResourcesImpl::noTempMemory"></span><span class="target" id="classfaiss_1_1gpu_1_1StandardGpuResourcesImpl_1a37459ad7862e50792e6498289c7f81b7"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">noTempMemory</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5faiss3gpu24StandardGpuResourcesImpl12noTempMemoryEv" title="Permalink to this definition"></a><br /></dt>
Expand Down Expand Up @@ -229,11 +235,17 @@ <h1>Class faiss::gpu::StandardGpuResourcesImpl<a class="headerlink" href="#class
<dd><p>Returns the stream on which we perform async CPU &lt;-&gt; GPU copies. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu24StandardGpuResourcesImpl29supportsBFloat16CurrentDeviceEv">
<span id="_CPPv3N5faiss3gpu24StandardGpuResourcesImpl29supportsBFloat16CurrentDeviceEv"></span><span id="_CPPv2N5faiss3gpu24StandardGpuResourcesImpl29supportsBFloat16CurrentDeviceEv"></span><span id="faiss::gpu::StandardGpuResourcesImpl::supportsBFloat16CurrentDevice"></span><span class="target" id="classfaiss_1_1gpu_1_1GpuResources_1a867681740486f732c786f0d1af782076"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">supportsBFloat16CurrentDevice</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5faiss3gpu24StandardGpuResourcesImpl29supportsBFloat16CurrentDeviceEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Does the current GPU support bfloat16? </p>
<p>Functions provided by default </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu24StandardGpuResourcesImpl26getBlasHandleCurrentDeviceEv">
<span id="_CPPv3N5faiss3gpu24StandardGpuResourcesImpl26getBlasHandleCurrentDeviceEv"></span><span id="_CPPv2N5faiss3gpu24StandardGpuResourcesImpl26getBlasHandleCurrentDeviceEv"></span><span id="faiss::gpu::StandardGpuResourcesImpl::getBlasHandleCurrentDevice"></span><span class="target" id="classfaiss_1_1gpu_1_1GpuResources_1a00cb7bcbc5f1a00da673f30749149b12"></span><span class="n"><span class="pre">cublasHandle_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getBlasHandleCurrentDevice</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5faiss3gpu24StandardGpuResourcesImpl26getBlasHandleCurrentDeviceEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Calls getBlasHandle with the current device. </p>
<p>Functions provided by default </p>
</dd></dl>

<dl class="cpp function">
Expand Down
5 changes: 5 additions & 0 deletions docs/cpp_api/file/GpuDistance_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,11 @@ <h1>File GpuDistance.h<a class="headerlink" href="#file-gpudistance-h" title="Pe
<span id="_CPPv3N5faiss3gpu16DistanceDataType3F16E"></span><span id="_CPPv2N5faiss3gpu16DistanceDataType3F16E"></span><span class="target" id="GpuDistance_8h_1aa22865a7603feb994c5946c7c4d12268a56d8353718e6fdc78b8d69078a2cdb94"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">F16</span></span></span><a class="headerlink" href="#_CPPv4N5faiss3gpu16DistanceDataType3F16E" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu16DistanceDataType4BF16E">
<span id="_CPPv3N5faiss3gpu16DistanceDataType4BF16E"></span><span id="_CPPv2N5faiss3gpu16DistanceDataType4BF16E"></span><span class="target" id="GpuDistance_8h_1aa22865a7603feb994c5946c7c4d12268af656bbf613964dcf710b771b0918ab30"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BF16</span></span></span><a class="headerlink" href="#_CPPv4N5faiss3gpu16DistanceDataType4BF16E" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>

</dd></dl>

<dl class="cpp enum-class">
Expand Down
14 changes: 13 additions & 1 deletion docs/cpp_api/file/GpuResources_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -671,6 +671,12 @@ <h1>File GpuResources.h<a class="headerlink" href="#file-gpuresources-h" title="
<dd><p>Call to pre-allocate resources for a particular device. If this is not called, then resources will be allocated at the first time of demand </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu12GpuResources16supportsBFloat16Ei">
<span id="_CPPv3N5faiss3gpu12GpuResources16supportsBFloat16Ei"></span><span id="_CPPv2N5faiss3gpu12GpuResources16supportsBFloat16Ei"></span><span id="faiss::gpu::GpuResources::supportsBFloat16__i"></span><span class="target" id="classfaiss_1_1gpu_1_1GpuResources_1ab4b064a700f9d3d6ecf486be6e23c55c"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">supportsBFloat16</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">device</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><br /></dt>
<dd><p>Does the given GPU support bfloat16? </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu12GpuResources13getBlasHandleEi">
<span id="_CPPv3N5faiss3gpu12GpuResources13getBlasHandleEi"></span><span id="_CPPv2N5faiss3gpu12GpuResources13getBlasHandleEi"></span><span id="faiss::gpu::GpuResources::getBlasHandle__i"></span><span class="target" id="classfaiss_1_1gpu_1_1GpuResources_1aa2682b8503dfdab4f7f5ef867035ad29"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">cublasHandle_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getBlasHandle</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">device</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><br /></dt>
Expand Down Expand Up @@ -725,11 +731,17 @@ <h1>File GpuResources.h<a class="headerlink" href="#file-gpuresources-h" title="
<dd><p>Returns the stream on which we perform async CPU &lt;-&gt; GPU copies. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu12GpuResources29supportsBFloat16CurrentDeviceEv">
<span id="_CPPv3N5faiss3gpu12GpuResources29supportsBFloat16CurrentDeviceEv"></span><span id="_CPPv2N5faiss3gpu12GpuResources29supportsBFloat16CurrentDeviceEv"></span><span id="faiss::gpu::GpuResources::supportsBFloat16CurrentDevice"></span><span class="target" id="classfaiss_1_1gpu_1_1GpuResources_1a867681740486f732c786f0d1af782076"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">supportsBFloat16CurrentDevice</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><br /></dt>
<dd><p>Does the current GPU support bfloat16? </p>
<p>Functions provided by default </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss3gpu12GpuResources26getBlasHandleCurrentDeviceEv">
<span id="_CPPv3N5faiss3gpu12GpuResources26getBlasHandleCurrentDeviceEv"></span><span id="_CPPv2N5faiss3gpu12GpuResources26getBlasHandleCurrentDeviceEv"></span><span id="faiss::gpu::GpuResources::getBlasHandleCurrentDevice"></span><span class="target" id="classfaiss_1_1gpu_1_1GpuResources_1a00cb7bcbc5f1a00da673f30749149b12"></span><span class="n"><span class="pre">cublasHandle_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getBlasHandleCurrentDevice</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><br /></dt>
<dd><p>Calls getBlasHandle with the current device. </p>
<p>Functions provided by default </p>
</dd></dl>

<dl class="cpp function">
Expand Down
Loading

0 comments on commit 380e656

Please sign in to comment.