From b49d78b3f960f9cbdbd25fb9f20c5f85c4e1722a Mon Sep 17 00:00:00 2001
From: facebook-github-bot <facebook-github-bot@users.noreply.github.com>
Date: Fri, 1 Sep 2023 09:41:30 +0000
Subject: [PATCH] Update API docs (82352dd4).

---
 xml/IndexHNSW_8h.xml                   |  8 ++++----
 xml/IndexNSG_8h.xml                    | 20 ++++++++++----------
 xml/index.xml                          |  4 ++--
 xml/structfaiss_1_1IndexHNSW.xml       |  3 +++
 xml/structfaiss_1_1IndexHNSW2Level.xml |  3 +++
 xml/structfaiss_1_1IndexHNSWFlat.xml   |  3 +++
 xml/structfaiss_1_1IndexHNSWPQ.xml     | 14 +++++++++++---
 xml/structfaiss_1_1IndexHNSWSQ.xml     |  3 +++
 xml/structfaiss_1_1IndexNSG.xml        |  8 ++++++++
 xml/structfaiss_1_1IndexNSGFlat.xml    |  8 ++++++++
 xml/structfaiss_1_1IndexNSGPQ.xml      | 19 ++++++++++++++++---
 xml/structfaiss_1_1IndexNSGSQ.xml      |  8 ++++++++
 12 files changed, 79 insertions(+), 22 deletions(-)

diff --git a/xml/IndexHNSW_8h.xml b/xml/IndexHNSW_8h.xml
index 9b2ecd08c6..853ed7f7d7 100644
--- a/xml/IndexHNSW_8h.xml
+++ b/xml/IndexHNSW_8h.xml
@@ -489,10 +489,10 @@
 <codeline lineno="74"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="structfaiss_1_1HNSW" kindref="compound">HNSW</ref><sp/>hnsw;</highlight></codeline>
 <codeline lineno="75"><highlight class="normal"></highlight></codeline>
 <codeline lineno="76"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>the<sp/>sequential<sp/>storage</highlight><highlight class="normal"></highlight></codeline>
-<codeline lineno="77"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/>own_fields;</highlight></codeline>
-<codeline lineno="78"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="structfaiss_1_1Index" kindref="compound">Index</ref>*<sp/>storage;</highlight></codeline>
+<codeline lineno="77"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/>own_fields<sp/>=<sp/></highlight><highlight class="keyword">false</highlight><highlight class="normal">;</highlight></codeline>
+<codeline lineno="78"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="structfaiss_1_1Index" kindref="compound">Index</ref>*<sp/>storage<sp/>=<sp/></highlight><highlight class="keyword">nullptr</highlight><highlight class="normal">;</highlight></codeline>
 <codeline lineno="79"><highlight class="normal"></highlight></codeline>
-<codeline lineno="80"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="structfaiss_1_1ReconstructFromNeighbors" kindref="compound">ReconstructFromNeighbors</ref>*<sp/>reconstruct_from_neighbors;</highlight></codeline>
+<codeline lineno="80"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="structfaiss_1_1ReconstructFromNeighbors" kindref="compound">ReconstructFromNeighbors</ref>*<sp/>reconstruct_from_neighbors<sp/>=<sp/></highlight><highlight class="keyword">nullptr</highlight><highlight class="normal">;</highlight></codeline>
 <codeline lineno="81"><highlight class="normal"></highlight></codeline>
 <codeline lineno="82"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">explicit</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexHNSW" kindref="compound">IndexHNSW</ref>(</highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1Index_1a2a002388d2c081c2dbab8508dcefe73d" kindref="member">d</ref><sp/>=<sp/>0,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>M<sp/>=<sp/>32,<sp/><ref refid="namespacefaiss_1afd12191c638da74760ff397cf319752c" kindref="member">MetricType</ref><sp/>metric<sp/>=<sp/><ref refid="namespacefaiss_1afd12191c638da74760ff397cf319752cace9aa175fe11f346aa0a70df58977ff1" kindref="member">METRIC_L2</ref>);</highlight></codeline>
 <codeline lineno="83"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">explicit</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexHNSW" kindref="compound">IndexHNSW</ref>(<ref refid="structfaiss_1_1Index" kindref="compound">Index</ref>*<sp/>storage,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>M<sp/>=<sp/>32);</highlight></codeline>
@@ -567,7 +567,7 @@
 <codeline lineno="152"><highlight class="comment"><sp/>*/</highlight><highlight class="normal"></highlight></codeline>
 <codeline lineno="153" refid="structfaiss_1_1IndexHNSWPQ" refkind="compound"><highlight class="normal"></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structfaiss_1_1IndexHNSWPQ" kindref="compound">IndexHNSWPQ</ref><sp/>:<sp/><ref refid="structfaiss_1_1IndexHNSW" kindref="compound">IndexHNSW</ref><sp/>{</highlight></codeline>
 <codeline lineno="154"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="structfaiss_1_1IndexHNSWPQ" kindref="compound">IndexHNSWPQ</ref>();</highlight></codeline>
-<codeline lineno="155"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="structfaiss_1_1IndexHNSWPQ" kindref="compound">IndexHNSWPQ</ref>(</highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1Index_1a2a002388d2c081c2dbab8508dcefe73d" kindref="member">d</ref>,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>pq_m,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>M);</highlight></codeline>
+<codeline lineno="155"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="structfaiss_1_1IndexHNSWPQ" kindref="compound">IndexHNSWPQ</ref>(</highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1Index_1a2a002388d2c081c2dbab8508dcefe73d" kindref="member">d</ref>,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>pq_m,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>M,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>pq_nbits<sp/>=<sp/>8);</highlight></codeline>
 <codeline lineno="156" refid="structfaiss_1_1IndexHNSWPQ_1ae99b976eeb25717d10055b1786aa011c" refkind="member"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexHNSWPQ_1ae99b976eeb25717d10055b1786aa011c" kindref="member">train</ref>(<ref refid="namespacefaiss_1ad63e84aa82f5bb0405ed924d58b20e2e" kindref="member">idx_t</ref><sp/>n,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">float</highlight><highlight class="normal">*<sp/>x)<sp/></highlight><highlight class="keyword">override</highlight><highlight class="normal">;</highlight></codeline>
 <codeline lineno="157"><highlight class="normal">};</highlight></codeline>
 <codeline lineno="158"><highlight class="normal"></highlight><highlight class="comment"></highlight></codeline>
diff --git a/xml/IndexNSG_8h.xml b/xml/IndexNSG_8h.xml
index ea9d282234..33f72c06a6 100644
--- a/xml/IndexNSG_8h.xml
+++ b/xml/IndexNSG_8h.xml
@@ -487,25 +487,25 @@
 <codeline lineno="28" refid="structfaiss_1_1IndexNSG_1a8ef9a38cf4c8876a2d2d2c309125cd68" refkind="member"><highlight class="comment"></highlight><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="structfaiss_1_1NSG" kindref="compound">NSG</ref><sp/><ref refid="structfaiss_1_1IndexNSG_1a8ef9a38cf4c8876a2d2d2c309125cd68" kindref="member">nsg</ref>;</highlight></codeline>
 <codeline lineno="29"><highlight class="normal"></highlight><highlight class="comment"></highlight></codeline>
 <codeline lineno="30"><highlight class="comment"><sp/><sp/><sp/><sp/>///<sp/>the<sp/>sequential<sp/>storage</highlight></codeline>
-<codeline lineno="31" refid="structfaiss_1_1IndexNSG_1a6e95ff08dcda324764fead2438ae04aa" refkind="member"><highlight class="comment"></highlight><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexNSG_1a6e95ff08dcda324764fead2438ae04aa" kindref="member">own_fields</ref>;</highlight></codeline>
-<codeline lineno="32"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="structfaiss_1_1Index" kindref="compound">Index</ref>*<sp/>storage;</highlight></codeline>
+<codeline lineno="31" refid="structfaiss_1_1IndexNSG_1a6e95ff08dcda324764fead2438ae04aa" refkind="member"><highlight class="comment"></highlight><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexNSG_1a6e95ff08dcda324764fead2438ae04aa" kindref="member">own_fields</ref><sp/>=<sp/></highlight><highlight class="keyword">false</highlight><highlight class="normal">;</highlight></codeline>
+<codeline lineno="32"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="structfaiss_1_1Index" kindref="compound">Index</ref>*<sp/>storage<sp/>=<sp/></highlight><highlight class="keyword">nullptr</highlight><highlight class="normal">;</highlight></codeline>
 <codeline lineno="33"><highlight class="normal"></highlight><highlight class="comment"></highlight></codeline>
 <codeline lineno="34"><highlight class="comment"><sp/><sp/><sp/><sp/>///<sp/>the<sp/>index<sp/>is<sp/>built<sp/>or<sp/>not</highlight></codeline>
-<codeline lineno="35" refid="structfaiss_1_1IndexNSG_1a48d5640864be98b5db017f7459c2f3fc" refkind="member"><highlight class="comment"></highlight><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexNSG_1a48d5640864be98b5db017f7459c2f3fc" kindref="member">is_built</ref>;</highlight></codeline>
+<codeline lineno="35" refid="structfaiss_1_1IndexNSG_1a48d5640864be98b5db017f7459c2f3fc" refkind="member"><highlight class="comment"></highlight><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexNSG_1a48d5640864be98b5db017f7459c2f3fc" kindref="member">is_built</ref><sp/>=<sp/></highlight><highlight class="keyword">false</highlight><highlight class="normal">;</highlight></codeline>
 <codeline lineno="36"><highlight class="normal"></highlight><highlight class="comment"></highlight></codeline>
 <codeline lineno="37"><highlight class="comment"><sp/><sp/><sp/><sp/>///<sp/>K<sp/>of<sp/>KNN<sp/>graph<sp/>for<sp/>building</highlight></codeline>
-<codeline lineno="38" refid="structfaiss_1_1IndexNSG_1ab42dd8a2ccd955bac425b68fc604d7a9" refkind="member"><highlight class="comment"></highlight><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexNSG_1ab42dd8a2ccd955bac425b68fc604d7a9" kindref="member">GK</ref>;</highlight></codeline>
+<codeline lineno="38" refid="structfaiss_1_1IndexNSG_1ab42dd8a2ccd955bac425b68fc604d7a9" refkind="member"><highlight class="comment"></highlight><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexNSG_1ab42dd8a2ccd955bac425b68fc604d7a9" kindref="member">GK</ref><sp/>=<sp/>64;</highlight></codeline>
 <codeline lineno="39"><highlight class="normal"></highlight><highlight class="comment"></highlight></codeline>
 <codeline lineno="40"><highlight class="comment"><sp/><sp/><sp/><sp/>///<sp/>indicate<sp/>how<sp/>to<sp/>build<sp/>a<sp/>knn<sp/>graph</highlight></codeline>
 <codeline lineno="41"><highlight class="comment"><sp/><sp/><sp/><sp/>///<sp/>-<sp/>0:<sp/>build<sp/>NSG<sp/>with<sp/>brute<sp/>force<sp/>search</highlight></codeline>
 <codeline lineno="42"><highlight class="comment"><sp/><sp/><sp/><sp/>///<sp/>-<sp/>1:<sp/>build<sp/>NSG<sp/>with<sp/>NNDescent</highlight></codeline>
-<codeline lineno="43" refid="structfaiss_1_1IndexNSG_1aa51ad0b18442396b6df5ee99fefe21c6" refkind="member"><highlight class="comment"></highlight><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">char</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexNSG_1aa51ad0b18442396b6df5ee99fefe21c6" kindref="member">build_type</ref>;</highlight></codeline>
+<codeline lineno="43" refid="structfaiss_1_1IndexNSG_1aa51ad0b18442396b6df5ee99fefe21c6" refkind="member"><highlight class="comment"></highlight><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">char</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexNSG_1aa51ad0b18442396b6df5ee99fefe21c6" kindref="member">build_type</ref><sp/>=<sp/>0;</highlight></codeline>
 <codeline lineno="44"><highlight class="normal"></highlight><highlight class="comment"></highlight></codeline>
 <codeline lineno="45"><highlight class="comment"><sp/><sp/><sp/><sp/>///<sp/>parameters<sp/>for<sp/>nndescent</highlight></codeline>
-<codeline lineno="46" refid="structfaiss_1_1IndexNSG_1ac1fbc1508f8ab8d4675da13048195ff9" refkind="member"><highlight class="comment"></highlight><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexNSG_1ac1fbc1508f8ab8d4675da13048195ff9" kindref="member">nndescent_S</ref>;</highlight></codeline>
-<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>nndescent_R;</highlight></codeline>
-<codeline lineno="48"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>nndescent_L;</highlight></codeline>
-<codeline lineno="49"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>nndescent_iter;</highlight></codeline>
+<codeline lineno="46" refid="structfaiss_1_1IndexNSG_1ac1fbc1508f8ab8d4675da13048195ff9" refkind="member"><highlight class="comment"></highlight><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexNSG_1ac1fbc1508f8ab8d4675da13048195ff9" kindref="member">nndescent_S</ref><sp/>=<sp/>10;</highlight></codeline>
+<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>nndescent_R<sp/>=<sp/>100;</highlight></codeline>
+<codeline lineno="48"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>nndescent_L;<sp/></highlight><highlight class="comment">//<sp/>set<sp/>to<sp/>GK<sp/>+<sp/>50</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="49"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>nndescent_iter<sp/>=<sp/>10;</highlight></codeline>
 <codeline lineno="50"><highlight class="normal"></highlight></codeline>
 <codeline lineno="51"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">explicit</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexNSG" kindref="compound">IndexNSG</ref>(</highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1Index_1a2a002388d2c081c2dbab8508dcefe73d" kindref="member">d</ref><sp/>=<sp/>0,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>R<sp/>=<sp/>32,<sp/><ref refid="namespacefaiss_1afd12191c638da74760ff397cf319752c" kindref="member">MetricType</ref><sp/>metric<sp/>=<sp/><ref refid="namespacefaiss_1afd12191c638da74760ff397cf319752cace9aa175fe11f346aa0a70df58977ff1" kindref="member">METRIC_L2</ref>);</highlight></codeline>
 <codeline lineno="52"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">explicit</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexNSG" kindref="compound">IndexNSG</ref>(<ref refid="structfaiss_1_1Index" kindref="compound">Index</ref>*<sp/>storage,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>R<sp/>=<sp/>32);</highlight></codeline>
@@ -549,7 +549,7 @@
 <codeline lineno="90"><highlight class="comment"><sp/>*/</highlight><highlight class="normal"></highlight></codeline>
 <codeline lineno="91" refid="structfaiss_1_1IndexNSGPQ" refkind="compound"><highlight class="normal"></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structfaiss_1_1IndexNSGPQ" kindref="compound">IndexNSGPQ</ref><sp/>:<sp/><ref refid="structfaiss_1_1IndexNSG" kindref="compound">IndexNSG</ref><sp/>{</highlight></codeline>
 <codeline lineno="92"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="structfaiss_1_1IndexNSGPQ" kindref="compound">IndexNSGPQ</ref>();</highlight></codeline>
-<codeline lineno="93"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="structfaiss_1_1IndexNSGPQ" kindref="compound">IndexNSGPQ</ref>(</highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1Index_1a2a002388d2c081c2dbab8508dcefe73d" kindref="member">d</ref>,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>pq_m,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>M);</highlight></codeline>
+<codeline lineno="93"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="structfaiss_1_1IndexNSGPQ" kindref="compound">IndexNSGPQ</ref>(</highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1Index_1a2a002388d2c081c2dbab8508dcefe73d" kindref="member">d</ref>,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>pq_m,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>M,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>pq_nbits<sp/>=<sp/>8);</highlight></codeline>
 <codeline lineno="94" refid="structfaiss_1_1IndexNSGPQ_1afa79e49f634ed87c0f597b9d9fc2f111" refkind="member"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1IndexNSGPQ_1afa79e49f634ed87c0f597b9d9fc2f111" kindref="member">train</ref>(<ref refid="namespacefaiss_1ad63e84aa82f5bb0405ed924d58b20e2e" kindref="member">idx_t</ref><sp/>n,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">float</highlight><highlight class="normal">*<sp/>x)<sp/></highlight><highlight class="keyword">override</highlight><highlight class="normal">;</highlight></codeline>
 <codeline lineno="95"><highlight class="normal">};</highlight></codeline>
 <codeline lineno="96"><highlight class="normal"></highlight><highlight class="comment"></highlight></codeline>
diff --git a/xml/index.xml b/xml/index.xml
index aaaea46bcc..d62451e1b7 100644
--- a/xml/index.xml
+++ b/xml/index.xml
@@ -2651,7 +2651,7 @@
   </compound>
   <compound refid="structfaiss_1_1IndexHNSWPQ" kind="struct"><name>faiss::IndexHNSWPQ</name>
     <member refid="structfaiss_1_1IndexHNSWPQ_1ac8c54c9715e5fa2a44534d23581cf65b" kind="function"><name>IndexHNSWPQ</name></member>
-    <member refid="structfaiss_1_1IndexHNSWPQ_1a12e170ee06d954c267e5352b9b050bfd" kind="function"><name>IndexHNSWPQ</name></member>
+    <member refid="structfaiss_1_1IndexHNSWPQ_1a233ba94f8e3a81bde718b3d035840e13" kind="function"><name>IndexHNSWPQ</name></member>
     <member refid="structfaiss_1_1IndexHNSWPQ_1ae99b976eeb25717d10055b1786aa011c" kind="function"><name>train</name></member>
     <member refid="structfaiss_1_1IndexHNSW_1a04a761ce17d0f9040b3bc8a77bd627d9" kind="function"><name>add</name></member>
     <member refid="structfaiss_1_1IndexHNSW_1abafcab9d359f7c511f6e1e9d053a4409" kind="function"><name>search</name></member>
@@ -4794,7 +4794,7 @@
   </compound>
   <compound refid="structfaiss_1_1IndexNSGPQ" kind="struct"><name>faiss::IndexNSGPQ</name>
     <member refid="structfaiss_1_1IndexNSGPQ_1a0196d670a1dc73d9de668b61700880b9" kind="function"><name>IndexNSGPQ</name></member>
-    <member refid="structfaiss_1_1IndexNSGPQ_1abc6d53e8fae2dc277a49cbe6c0cdf48c" kind="function"><name>IndexNSGPQ</name></member>
+    <member refid="structfaiss_1_1IndexNSGPQ_1abaf1e3e304625736081796d09642ba6f" kind="function"><name>IndexNSGPQ</name></member>
     <member refid="structfaiss_1_1IndexNSGPQ_1afa79e49f634ed87c0f597b9d9fc2f111" kind="function"><name>train</name></member>
     <member refid="structfaiss_1_1IndexNSG_1a5f8d4dc0ef239c5d6d29252c728dd9fa" kind="function"><name>build</name></member>
     <member refid="structfaiss_1_1IndexNSG_1a9fc38a1c373f96d845364143ff933207" kind="function"><name>add</name></member>
diff --git a/xml/structfaiss_1_1IndexHNSW.xml b/xml/structfaiss_1_1IndexHNSW.xml
index 22591c01b3..eac7ab64b7 100644
--- a/xml/structfaiss_1_1IndexHNSW.xml
+++ b/xml/structfaiss_1_1IndexHNSW.xml
@@ -68,6 +68,7 @@
         <definition>bool faiss::IndexHNSW::own_fields</definition>
         <argsstring></argsstring>
         <name>own_fields</name>
+        <initializer>= false</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -81,6 +82,7 @@
         <definition>Index* faiss::IndexHNSW::storage</definition>
         <argsstring></argsstring>
         <name>storage</name>
+        <initializer>= nullptr</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -94,6 +96,7 @@
         <definition>ReconstructFromNeighbors* faiss::IndexHNSW::reconstruct_from_neighbors</definition>
         <argsstring></argsstring>
         <name>reconstruct_from_neighbors</name>
+        <initializer>= nullptr</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
diff --git a/xml/structfaiss_1_1IndexHNSW2Level.xml b/xml/structfaiss_1_1IndexHNSW2Level.xml
index e8285f5e12..fd379fbc4b 100644
--- a/xml/structfaiss_1_1IndexHNSW2Level.xml
+++ b/xml/structfaiss_1_1IndexHNSW2Level.xml
@@ -1128,6 +1128,7 @@
         <definition>bool faiss::IndexHNSW::own_fields</definition>
         <argsstring></argsstring>
         <name>own_fields</name>
+        <initializer>= false</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1141,6 +1142,7 @@
         <definition>Index* faiss::IndexHNSW::storage</definition>
         <argsstring></argsstring>
         <name>storage</name>
+        <initializer>= nullptr</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1154,6 +1156,7 @@
         <definition>ReconstructFromNeighbors* faiss::IndexHNSW::reconstruct_from_neighbors</definition>
         <argsstring></argsstring>
         <name>reconstruct_from_neighbors</name>
+        <initializer>= nullptr</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
diff --git a/xml/structfaiss_1_1IndexHNSWFlat.xml b/xml/structfaiss_1_1IndexHNSWFlat.xml
index 1a6e780b79..e73d17ab0c 100644
--- a/xml/structfaiss_1_1IndexHNSWFlat.xml
+++ b/xml/structfaiss_1_1IndexHNSWFlat.xml
@@ -1113,6 +1113,7 @@
         <definition>bool faiss::IndexHNSW::own_fields</definition>
         <argsstring></argsstring>
         <name>own_fields</name>
+        <initializer>= false</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1126,6 +1127,7 @@
         <definition>Index* faiss::IndexHNSW::storage</definition>
         <argsstring></argsstring>
         <name>storage</name>
+        <initializer>= nullptr</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1139,6 +1141,7 @@
         <definition>ReconstructFromNeighbors* faiss::IndexHNSW::reconstruct_from_neighbors</definition>
         <argsstring></argsstring>
         <name>reconstruct_from_neighbors</name>
+        <initializer>= nullptr</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
diff --git a/xml/structfaiss_1_1IndexHNSWPQ.xml b/xml/structfaiss_1_1IndexHNSWPQ.xml
index 34dfcc16dc..ab637e6cce 100644
--- a/xml/structfaiss_1_1IndexHNSWPQ.xml
+++ b/xml/structfaiss_1_1IndexHNSWPQ.xml
@@ -18,10 +18,10 @@
         </inbodydescription>
         <location file="faiss/IndexHNSW.h" line="154" column="5"/>
       </memberdef>
-      <memberdef kind="function" id="structfaiss_1_1IndexHNSWPQ_1a12e170ee06d954c267e5352b9b050bfd" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+      <memberdef kind="function" id="structfaiss_1_1IndexHNSWPQ_1a233ba94f8e3a81bde718b3d035840e13" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type></type>
         <definition>faiss::IndexHNSWPQ::IndexHNSWPQ</definition>
-        <argsstring>(int d, int pq_m, int M)</argsstring>
+        <argsstring>(int d, int pq_m, int M, int pq_nbits=8)</argsstring>
         <name>IndexHNSWPQ</name>
         <param>
           <type>int</type>
@@ -35,6 +35,11 @@
           <type>int</type>
           <declname>M</declname>
         </param>
+        <param>
+          <type>int</type>
+          <declname>pq_nbits</declname>
+          <defval>8</defval>
+        </param>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1111,6 +1116,7 @@
         <definition>bool faiss::IndexHNSW::own_fields</definition>
         <argsstring></argsstring>
         <name>own_fields</name>
+        <initializer>= false</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1124,6 +1130,7 @@
         <definition>Index* faiss::IndexHNSW::storage</definition>
         <argsstring></argsstring>
         <name>storage</name>
+        <initializer>= nullptr</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1137,6 +1144,7 @@
         <definition>ReconstructFromNeighbors* faiss::IndexHNSW::reconstruct_from_neighbors</definition>
         <argsstring></argsstring>
         <name>reconstruct_from_neighbors</name>
+        <initializer>= nullptr</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1315,7 +1323,7 @@
       <member refid="structfaiss_1_1IndexHNSW_1a973769979e047374a8310b9fa891214c" prot="public" virt="non-virtual"><scope>faiss::IndexHNSWPQ</scope><name>IndexHNSW</name></member>
       <member refid="structfaiss_1_1IndexHNSW_1a74d1ec193f1749a55ec83b6c7779119c" prot="public" virt="non-virtual"><scope>faiss::IndexHNSWPQ</scope><name>IndexHNSW</name></member>
       <member refid="structfaiss_1_1IndexHNSWPQ_1ac8c54c9715e5fa2a44534d23581cf65b" prot="public" virt="non-virtual"><scope>faiss::IndexHNSWPQ</scope><name>IndexHNSWPQ</name></member>
-      <member refid="structfaiss_1_1IndexHNSWPQ_1a12e170ee06d954c267e5352b9b050bfd" prot="public" virt="non-virtual"><scope>faiss::IndexHNSWPQ</scope><name>IndexHNSWPQ</name></member>
+      <member refid="structfaiss_1_1IndexHNSWPQ_1a233ba94f8e3a81bde718b3d035840e13" prot="public" virt="non-virtual"><scope>faiss::IndexHNSWPQ</scope><name>IndexHNSWPQ</name></member>
       <member refid="structfaiss_1_1IndexHNSW_1ab9c75063090927f8f65d1896b6949af4" prot="public" virt="non-virtual"><scope>faiss::IndexHNSWPQ</scope><name>init_level_0_from_entry_points</name></member>
       <member refid="structfaiss_1_1IndexHNSW_1a9a86c58212f3f9cf88394f5297cba525" prot="public" virt="non-virtual"><scope>faiss::IndexHNSWPQ</scope><name>init_level_0_from_knngraph</name></member>
       <member refid="structfaiss_1_1Index_1a6e92732617c4dbe364e7678dd8773a7f" prot="public" virt="non-virtual"><scope>faiss::IndexHNSWPQ</scope><name>is_trained</name></member>
diff --git a/xml/structfaiss_1_1IndexHNSWSQ.xml b/xml/structfaiss_1_1IndexHNSWSQ.xml
index a895a78391..60781d7199 100644
--- a/xml/structfaiss_1_1IndexHNSWSQ.xml
+++ b/xml/structfaiss_1_1IndexHNSWSQ.xml
@@ -1117,6 +1117,7 @@
         <definition>bool faiss::IndexHNSW::own_fields</definition>
         <argsstring></argsstring>
         <name>own_fields</name>
+        <initializer>= false</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1130,6 +1131,7 @@
         <definition>Index* faiss::IndexHNSW::storage</definition>
         <argsstring></argsstring>
         <name>storage</name>
+        <initializer>= nullptr</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1143,6 +1145,7 @@
         <definition>ReconstructFromNeighbors* faiss::IndexHNSW::reconstruct_from_neighbors</definition>
         <argsstring></argsstring>
         <name>reconstruct_from_neighbors</name>
+        <initializer>= nullptr</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
diff --git a/xml/structfaiss_1_1IndexNSG.xml b/xml/structfaiss_1_1IndexNSG.xml
index 349e0a7eb7..b2407cd054 100644
--- a/xml/structfaiss_1_1IndexNSG.xml
+++ b/xml/structfaiss_1_1IndexNSG.xml
@@ -27,6 +27,7 @@
         <definition>bool faiss::IndexNSG::own_fields</definition>
         <argsstring></argsstring>
         <name>own_fields</name>
+        <initializer>= false</initializer>
         <briefdescription>
 <para>the sequential storage </para>
         </briefdescription>
@@ -41,6 +42,7 @@
         <definition>Index* faiss::IndexNSG::storage</definition>
         <argsstring></argsstring>
         <name>storage</name>
+        <initializer>= nullptr</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -54,6 +56,7 @@
         <definition>bool faiss::IndexNSG::is_built</definition>
         <argsstring></argsstring>
         <name>is_built</name>
+        <initializer>= false</initializer>
         <briefdescription>
 <para>the index is built or not </para>
         </briefdescription>
@@ -68,6 +71,7 @@
         <definition>int faiss::IndexNSG::GK</definition>
         <argsstring></argsstring>
         <name>GK</name>
+        <initializer>= 64</initializer>
         <briefdescription>
 <para>K of KNN graph for building. </para>
         </briefdescription>
@@ -82,6 +86,7 @@
         <definition>char faiss::IndexNSG::build_type</definition>
         <argsstring></argsstring>
         <name>build_type</name>
+        <initializer>= 0</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -100,6 +105,7 @@
         <definition>int faiss::IndexNSG::nndescent_S</definition>
         <argsstring></argsstring>
         <name>nndescent_S</name>
+        <initializer>= 10</initializer>
         <briefdescription>
 <para>parameters for nndescent </para>
         </briefdescription>
@@ -114,6 +120,7 @@
         <definition>int faiss::IndexNSG::nndescent_R</definition>
         <argsstring></argsstring>
         <name>nndescent_R</name>
+        <initializer>= 100</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -140,6 +147,7 @@
         <definition>int faiss::IndexNSG::nndescent_iter</definition>
         <argsstring></argsstring>
         <name>nndescent_iter</name>
+        <initializer>= 10</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
diff --git a/xml/structfaiss_1_1IndexNSGFlat.xml b/xml/structfaiss_1_1IndexNSGFlat.xml
index 3b33296414..4bf2f69aea 100644
--- a/xml/structfaiss_1_1IndexNSGFlat.xml
+++ b/xml/structfaiss_1_1IndexNSGFlat.xml
@@ -952,6 +952,7 @@
         <definition>bool faiss::IndexNSG::own_fields</definition>
         <argsstring></argsstring>
         <name>own_fields</name>
+        <initializer>= false</initializer>
         <briefdescription>
 <para>the sequential storage </para>
         </briefdescription>
@@ -966,6 +967,7 @@
         <definition>Index* faiss::IndexNSG::storage</definition>
         <argsstring></argsstring>
         <name>storage</name>
+        <initializer>= nullptr</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -979,6 +981,7 @@
         <definition>bool faiss::IndexNSG::is_built</definition>
         <argsstring></argsstring>
         <name>is_built</name>
+        <initializer>= false</initializer>
         <briefdescription>
 <para>the index is built or not </para>
         </briefdescription>
@@ -993,6 +996,7 @@
         <definition>int faiss::IndexNSG::GK</definition>
         <argsstring></argsstring>
         <name>GK</name>
+        <initializer>= 64</initializer>
         <briefdescription>
 <para>K of KNN graph for building. </para>
         </briefdescription>
@@ -1007,6 +1011,7 @@
         <definition>char faiss::IndexNSG::build_type</definition>
         <argsstring></argsstring>
         <name>build_type</name>
+        <initializer>= 0</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1025,6 +1030,7 @@
         <definition>int faiss::IndexNSG::nndescent_S</definition>
         <argsstring></argsstring>
         <name>nndescent_S</name>
+        <initializer>= 10</initializer>
         <briefdescription>
 <para>parameters for nndescent </para>
         </briefdescription>
@@ -1039,6 +1045,7 @@
         <definition>int faiss::IndexNSG::nndescent_R</definition>
         <argsstring></argsstring>
         <name>nndescent_R</name>
+        <initializer>= 100</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1065,6 +1072,7 @@
         <definition>int faiss::IndexNSG::nndescent_iter</definition>
         <argsstring></argsstring>
         <name>nndescent_iter</name>
+        <initializer>= 10</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
diff --git a/xml/structfaiss_1_1IndexNSGPQ.xml b/xml/structfaiss_1_1IndexNSGPQ.xml
index 7fcec91fa8..0155582d75 100644
--- a/xml/structfaiss_1_1IndexNSGPQ.xml
+++ b/xml/structfaiss_1_1IndexNSGPQ.xml
@@ -18,10 +18,10 @@
         </inbodydescription>
         <location file="faiss/IndexNSG.h" line="92" column="5"/>
       </memberdef>
-      <memberdef kind="function" id="structfaiss_1_1IndexNSGPQ_1abc6d53e8fae2dc277a49cbe6c0cdf48c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+      <memberdef kind="function" id="structfaiss_1_1IndexNSGPQ_1abaf1e3e304625736081796d09642ba6f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type></type>
         <definition>faiss::IndexNSGPQ::IndexNSGPQ</definition>
-        <argsstring>(int d, int pq_m, int M)</argsstring>
+        <argsstring>(int d, int pq_m, int M, int pq_nbits=8)</argsstring>
         <name>IndexNSGPQ</name>
         <param>
           <type>int</type>
@@ -35,6 +35,11 @@
           <type>int</type>
           <declname>M</declname>
         </param>
+        <param>
+          <type>int</type>
+          <declname>pq_nbits</declname>
+          <defval>8</defval>
+        </param>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -950,6 +955,7 @@
         <definition>bool faiss::IndexNSG::own_fields</definition>
         <argsstring></argsstring>
         <name>own_fields</name>
+        <initializer>= false</initializer>
         <briefdescription>
 <para>the sequential storage </para>
         </briefdescription>
@@ -964,6 +970,7 @@
         <definition>Index* faiss::IndexNSG::storage</definition>
         <argsstring></argsstring>
         <name>storage</name>
+        <initializer>= nullptr</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -977,6 +984,7 @@
         <definition>bool faiss::IndexNSG::is_built</definition>
         <argsstring></argsstring>
         <name>is_built</name>
+        <initializer>= false</initializer>
         <briefdescription>
 <para>the index is built or not </para>
         </briefdescription>
@@ -991,6 +999,7 @@
         <definition>int faiss::IndexNSG::GK</definition>
         <argsstring></argsstring>
         <name>GK</name>
+        <initializer>= 64</initializer>
         <briefdescription>
 <para>K of KNN graph for building. </para>
         </briefdescription>
@@ -1005,6 +1014,7 @@
         <definition>char faiss::IndexNSG::build_type</definition>
         <argsstring></argsstring>
         <name>build_type</name>
+        <initializer>= 0</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1023,6 +1033,7 @@
         <definition>int faiss::IndexNSG::nndescent_S</definition>
         <argsstring></argsstring>
         <name>nndescent_S</name>
+        <initializer>= 10</initializer>
         <briefdescription>
 <para>parameters for nndescent </para>
         </briefdescription>
@@ -1037,6 +1048,7 @@
         <definition>int faiss::IndexNSG::nndescent_R</definition>
         <argsstring></argsstring>
         <name>nndescent_R</name>
+        <initializer>= 100</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1063,6 +1075,7 @@
         <definition>int faiss::IndexNSG::nndescent_iter</definition>
         <argsstring></argsstring>
         <name>nndescent_iter</name>
+        <initializer>= 10</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1262,7 +1275,7 @@
       <member refid="structfaiss_1_1IndexNSG_1a2c671de0473165fd9372731a2a7065f0" prot="public" virt="non-virtual"><scope>faiss::IndexNSGPQ</scope><name>IndexNSG</name></member>
       <member refid="structfaiss_1_1IndexNSG_1a055fc2195abfa7237ce15be50d8c385d" prot="public" virt="non-virtual"><scope>faiss::IndexNSGPQ</scope><name>IndexNSG</name></member>
       <member refid="structfaiss_1_1IndexNSGPQ_1a0196d670a1dc73d9de668b61700880b9" prot="public" virt="non-virtual"><scope>faiss::IndexNSGPQ</scope><name>IndexNSGPQ</name></member>
-      <member refid="structfaiss_1_1IndexNSGPQ_1abc6d53e8fae2dc277a49cbe6c0cdf48c" prot="public" virt="non-virtual"><scope>faiss::IndexNSGPQ</scope><name>IndexNSGPQ</name></member>
+      <member refid="structfaiss_1_1IndexNSGPQ_1abaf1e3e304625736081796d09642ba6f" prot="public" virt="non-virtual"><scope>faiss::IndexNSGPQ</scope><name>IndexNSGPQ</name></member>
       <member refid="structfaiss_1_1IndexNSG_1a48d5640864be98b5db017f7459c2f3fc" prot="public" virt="non-virtual"><scope>faiss::IndexNSGPQ</scope><name>is_built</name></member>
       <member refid="structfaiss_1_1Index_1a6e92732617c4dbe364e7678dd8773a7f" prot="public" virt="non-virtual"><scope>faiss::IndexNSGPQ</scope><name>is_trained</name></member>
       <member refid="structfaiss_1_1Index_1a989b8815705e95d61adcb87380660415" prot="public" virt="virtual"><scope>faiss::IndexNSGPQ</scope><name>merge_from</name></member>
diff --git a/xml/structfaiss_1_1IndexNSGSQ.xml b/xml/structfaiss_1_1IndexNSGSQ.xml
index 92f7f5f462..c7f48e9cec 100644
--- a/xml/structfaiss_1_1IndexNSGSQ.xml
+++ b/xml/structfaiss_1_1IndexNSGSQ.xml
@@ -956,6 +956,7 @@
         <definition>bool faiss::IndexNSG::own_fields</definition>
         <argsstring></argsstring>
         <name>own_fields</name>
+        <initializer>= false</initializer>
         <briefdescription>
 <para>the sequential storage </para>
         </briefdescription>
@@ -970,6 +971,7 @@
         <definition>Index* faiss::IndexNSG::storage</definition>
         <argsstring></argsstring>
         <name>storage</name>
+        <initializer>= nullptr</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -983,6 +985,7 @@
         <definition>bool faiss::IndexNSG::is_built</definition>
         <argsstring></argsstring>
         <name>is_built</name>
+        <initializer>= false</initializer>
         <briefdescription>
 <para>the index is built or not </para>
         </briefdescription>
@@ -997,6 +1000,7 @@
         <definition>int faiss::IndexNSG::GK</definition>
         <argsstring></argsstring>
         <name>GK</name>
+        <initializer>= 64</initializer>
         <briefdescription>
 <para>K of KNN graph for building. </para>
         </briefdescription>
@@ -1011,6 +1015,7 @@
         <definition>char faiss::IndexNSG::build_type</definition>
         <argsstring></argsstring>
         <name>build_type</name>
+        <initializer>= 0</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1029,6 +1034,7 @@
         <definition>int faiss::IndexNSG::nndescent_S</definition>
         <argsstring></argsstring>
         <name>nndescent_S</name>
+        <initializer>= 10</initializer>
         <briefdescription>
 <para>parameters for nndescent </para>
         </briefdescription>
@@ -1043,6 +1049,7 @@
         <definition>int faiss::IndexNSG::nndescent_R</definition>
         <argsstring></argsstring>
         <name>nndescent_R</name>
+        <initializer>= 100</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>
@@ -1069,6 +1076,7 @@
         <definition>int faiss::IndexNSG::nndescent_iter</definition>
         <argsstring></argsstring>
         <name>nndescent_iter</name>
+        <initializer>= 10</initializer>
         <briefdescription>
         </briefdescription>
         <detaileddescription>