MOre updates

rapidsai · Oct 2, 2024 · 55f11ee · 55f11ee
1 parent 831c2a2
commit 55f11ee
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 12 deletions.
diff --git a/docs/source/cuvs_bench/param_tuning.rst b/docs/source/cuvs_bench/param_tuning.rst
@@ -638,16 +638,37 @@ hnswlib
 
  * - `efConstruction`
    - `build`
+   - Y
+   - Positive integer >0
+   -
+   - Controls index time and accuracy. Bigger values increase the index quality. At some point, increasing this will no longer improve the quality.
 
+ * - `M`
+   - `build`
+   - Y
+   - Positive integer. Often between 2-100
    -
+   - umber of bi-directional links create for every new element during construction. Higher values work for higher intrinsic dimensionality and/or high recall, low values can work for datasets with low intrinsic dimensionality and/or low recalls. Also affects the algorithm's memory consumption.
+
+ * - `numThreads`
+   - `build`
+   - N
+   - Positive integer >0
+   - 1
+   - Number of threads to use to build the index.
 
+ * - `ef`
+   - `search`
+   - Y
+   - Positive integer >0
+   -
+   - Size of the dynamic list for the nearest neighbors used for search. Higher value leads to more accurate but slower search. Cannot be lower than `k`.
 
-| Parameter        | Type      | Required | Data Type                            | Default | Description                                                                                                                                                                                                                                                                                       |
-|------------------|-----------|----------|--------------------------------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `efConstruction` | `build`   | Y        | Positive Integer >0                  |         | Controls index time and accuracy. Bigger values increase the index quality. At some point, increasing this will no longer improve the quality.                                                                                                                                                    |
-| `M`              | `build`   | Y        | Positive Integer often between 2-100 |         | Number of bi-directional links create for every new element during construction. Higher values work for higher intrinsic dimensionality and/or high recall, low values can work for datasets with low intrinsic dimensionality and/or low recalls. Also affects the algorithm's memory consumption. |
-| `numThreads`     | `build`   | N        | Positive Integer >0                  | 1       | Number of threads to use to build the index.                                                                                                                                                                                                                                                      |
-| `ef`             | `search`  | Y        | Positive Integer >0                  |         | Size of the dynamic list for the nearest neighbors used for search. Higher value leads to more accurate but slower search. Cannot be lower than `k`.                                                                                                                                              |
-| `numThreads`     | `search` | N        | Positive Integer >0                  | 1       | Number of threads to use for queries.                                                                                                                                                                                                                                                             |
+ * - `numThreads`
+   - `search`
+   - N
+   - Positive integer >0
+   - 1
+   - Number of threads to use for queries.
 
 Please refer to `HNSW algorithm parameters guide <https://github.com/nmslib/hnswlib/blob/master/ALGO_PARAMS.md>`_ from `hnswlib` to learn more about these arguments.
diff --git a/docs/source/indexes/bruteforce.rst b/docs/source/indexes/bruteforce.rst
@@ -60,8 +60,3 @@ Index footprint
 Raw vectors: :math:`n_vectors * n_dimensions * precision`
 
 Vector norms (for distances which require them): :math:`n_vectors * precision`
-
-Search footprint
-~~~~~~~~~~~~~~~~
-
-TBD