Update API docs (1334d16).

facebookresearch · Jan 29, 2025 · a2eb159 · a2eb159
1 parent d7fc851
commit a2eb159
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/xml/StandardGpuResources_8h.xml b/xml/StandardGpuResources_8h.xml
@@ -338,7 +338,7 @@
 <codeline lineno="162"><highlight class="comment"><sp/><sp/><sp/><sp/>/**</highlight></codeline>
 <codeline lineno="163"><highlight class="comment"><sp/><sp/><sp/><sp/><sp/>*<sp/>FIXME:<sp/>Integrating<sp/>these<sp/>in<sp/>a<sp/>separate<sp/>code<sp/>path<sp/>for<sp/>now.<sp/>Ultimately,</highlight></codeline>
 <codeline lineno="164"><highlight class="comment"><sp/><sp/><sp/><sp/><sp/>*<sp/>it<sp/>would<sp/>be<sp/>nice<sp/>if<sp/>we<sp/>use<sp/>a<sp/>simple<sp/>memory<sp/>resource<sp/>abstraction</highlight></codeline>
-<codeline lineno="165"><highlight class="comment"><sp/><sp/><sp/><sp/><sp/>*<sp/>in<sp/>FAISS<sp/>so<sp/>we<sp/>could<sp/>plug<sp/>in<sp/>whether<sp/>to<sp/>use<sp/>RMM&apos;s<sp/>memory<sp/>resources</highlight></codeline>
+<codeline lineno="165"><highlight class="comment"><sp/><sp/><sp/><sp/><sp/>*<sp/>in<sp/>Faiss<sp/>so<sp/>we<sp/>could<sp/>plug<sp/>in<sp/>whether<sp/>to<sp/>use<sp/>RMM&apos;s<sp/>memory<sp/>resources</highlight></codeline>
 <codeline lineno="166"><highlight class="comment"><sp/><sp/><sp/><sp/><sp/>*<sp/>or<sp/>the<sp/>default.</highlight></codeline>
 <codeline lineno="167"><highlight class="comment"><sp/><sp/><sp/><sp/><sp/>*</highlight></codeline>
 <codeline lineno="168"><highlight class="comment"><sp/><sp/><sp/><sp/><sp/>*<sp/>There&apos;s<sp/>enough<sp/>duplicated<sp/>logic<sp/>that<sp/>it<sp/>doesn&apos;t<sp/>*seem*<sp/>to<sp/>make<sp/>sense</highlight></codeline>

diff --git a/xml/avx512-inl_8h.xml b/xml/avx512-inl_8h.xml
@@ -76,7 +76,7 @@
 <codeline lineno="11"><highlight class="normal"></highlight><highlight class="comment">//<sp/>AVX512<sp/>version</highlight><highlight class="normal"></highlight></codeline>
 <codeline lineno="12"><highlight class="normal"></highlight><highlight class="comment">//<sp/>The<sp/>_mm512_popcnt_epi64<sp/>intrinsic<sp/>is<sp/>used<sp/>to<sp/>accelerate<sp/>Hamming<sp/>distance</highlight><highlight class="normal"></highlight></codeline>
 <codeline lineno="13"><highlight class="normal"></highlight><highlight class="comment">//<sp/>calculations<sp/>in<sp/>HammingComputerDefault<sp/>and<sp/>HammingComputer64.<sp/>This<sp/>intrinsic</highlight><highlight class="normal"></highlight></codeline>
-<codeline lineno="14"><highlight class="normal"></highlight><highlight class="comment">//<sp/>is<sp/>not<sp/>available<sp/>in<sp/>the<sp/>default<sp/>FAISS<sp/>avx512<sp/>build<sp/>mode<sp/>but<sp/>is<sp/>only</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="14"><highlight class="normal"></highlight><highlight class="comment">//<sp/>is<sp/>not<sp/>available<sp/>in<sp/>the<sp/>default<sp/>Faiss<sp/>avx512<sp/>build<sp/>mode<sp/>but<sp/>is<sp/>only</highlight><highlight class="normal"></highlight></codeline>
 <codeline lineno="15"><highlight class="normal"></highlight><highlight class="comment">//<sp/>available<sp/>in<sp/>the<sp/>avx512_spr<sp/>build<sp/>mode,<sp/>which<sp/>targets<sp/>Intel(R)<sp/>Sapphire</highlight><highlight class="normal"></highlight></codeline>
 <codeline lineno="16"><highlight class="normal"></highlight><highlight class="comment">//<sp/>Rapids.</highlight><highlight class="normal"></highlight></codeline>
 <codeline lineno="17"><highlight class="normal"></highlight></codeline>

diff --git a/xml/utils_8h.xml b/xml/utils_8h.xml
@@ -244,7 +244,7 @@
 <codeline lineno="37"><highlight class="comment"><sp/>*<sp/>Get<sp/>some<sp/>stats<sp/>about<sp/>the<sp/>system</highlight></codeline>
 <codeline lineno="38"><highlight class="comment"><sp/>**************************************************/</highlight><highlight class="normal"></highlight></codeline>
 <codeline lineno="39"><highlight class="normal"></highlight></codeline>
-<codeline lineno="40"><highlight class="normal"></highlight><highlight class="comment">//<sp/>Expose<sp/>FAISS<sp/>version<sp/>as<sp/>a<sp/>string</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="40"><highlight class="normal"></highlight><highlight class="comment">//<sp/>Expose<sp/>Faiss<sp/>version<sp/>as<sp/>a<sp/>string</highlight><highlight class="normal"></highlight></codeline>
 <codeline lineno="41"><highlight class="normal">std::string<sp/>get_version();</highlight></codeline>
 <codeline lineno="42"><highlight class="normal"></highlight><highlight class="comment"></highlight></codeline>
 <codeline lineno="43"><highlight class="comment">///<sp/>ms<sp/>elapsed<sp/>since<sp/>some<sp/>arbitrary<sp/>epoch</highlight></codeline>