mlxvs 0.1.0__tar.gz

mlxvs-0.1.0/CMakeLists.txt

@@ -0,0 +1,74 @@
+cmake_minimum_required(VERSION 3.25)
+project(mlxvs VERSION 0.1.0 LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+if(NOT CMAKE_BUILD_TYPE)
+  set(CMAKE_BUILD_TYPE Release)
+endif()
+
+option(MLXVS_BUILD_PYTHON "Build the Python bindings (nanobind)" OFF)
+option(MLXVS_BUILD_TESTS "Build the C++ tests and benchmarks" ${PROJECT_IS_TOP_LEVEL})
+
+# MLX's C++ library. For the Python bindings, the one the `mlx` wheel ships, so
+# that one process holds one libmlx; otherwise an installed MLX (e.g. `brew
+# install mlx`), or -DMLX_ROOT. mlxvs pins the MLX version it was built against.
+if(MLXVS_BUILD_PYTHON)
+  find_package(
+    Python 3.10
+    COMPONENTS Interpreter Development.Module
+    REQUIRED)
+  execute_process(
+    COMMAND "${Python_EXECUTABLE}" -m mlx --cmake-dir
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    OUTPUT_VARIABLE MLX_ROOT)
+endif()
+find_package(MLX CONFIG REQUIRED)
+
+add_library(mlxvs STATIC src/knn.cpp src/kmeans.cpp src/nndescent.cpp
+                         src/all_neighbors.cpp src/search.cpp src/cagra.cpp)
+target_include_directories(mlxvs PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
+target_link_libraries(mlxvs PUBLIC mlx)
+
+if(MLXVS_BUILD_TESTS)
+  add_executable(test_knn tests/test_knn.cpp)
+  target_link_libraries(test_knn PRIVATE mlxvs)
+  add_executable(test_nnd tests/test_nnd.cpp)
+  target_link_libraries(test_nnd PRIVATE mlxvs)
+  add_executable(test_all_neighbors tests/test_all_neighbors.cpp)
+  target_link_libraries(test_all_neighbors PRIVATE mlxvs)
+  add_executable(bench_knn bench/bench_knn.cpp)
+  target_link_libraries(bench_knn PRIVATE mlxvs)
+  enable_testing()
+  add_test(NAME test_knn COMMAND test_knn)
+  add_test(NAME test_nnd COMMAND test_nnd)
+  add_executable(test_search tests/test_search.cpp)
+  target_link_libraries(test_search PRIVATE mlxvs)
+  add_test(NAME test_all_neighbors COMMAND test_all_neighbors)
+  add_test(NAME test_search COMMAND test_search)
+  add_executable(test_cagra tests/test_cagra.cpp)
+  target_link_libraries(test_cagra PRIVATE mlxvs)
+  add_test(NAME test_cagra COMMAND test_cagra)
+endif()
+
+if(MLXVS_BUILD_PYTHON)
+  # nanobind from the `nanobind` wheel (python -m nanobind --cmake_dir)
+  execute_process(
+    COMMAND "${Python_EXECUTABLE}" -m nanobind --cmake_dir
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    OUTPUT_VARIABLE nanobind_ROOT)
+  find_package(nanobind CONFIG REQUIRED)
+  # NB_DOMAIN mlx: mlx.core's array, Stream and Device types are shared with
+  # the extension, as MLX's own extension examples do
+  nanobind_add_module(
+    _core
+    NB_STATIC
+    LTO
+    NOMINSIZE
+    NB_DOMAIN
+    mlx
+    python/bindings.cpp)
+  target_link_libraries(_core PRIVATE mlxvs)
+  install(TARGETS _core LIBRARY DESTINATION mlxvs)
+endif()

mlxvs-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mlxvs-0.1.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include CMakeLists.txt LICENSE NOTICE README.md
+recursive-include include *.h
+recursive-include src *.h *.cpp
+include python/bindings.cpp
+recursive-include python/tests *.py

mlxvs-0.1.0/NOTICE

@@ -0,0 +1,13 @@
+mlxvs
+Copyright 2026 mikepapadim
+
+Licensed under the Apache License, Version 2.0.
+
+The NN-Descent kernels (src/nnd_kernels.h, src/nndescent.cpp) are a port to
+MLX of the Metal NN-Descent in JVector's jvector-gpu module
+(https://github.com/datastax/jvector, Apache License 2.0, Copyright DataStax,
+Inc.), from which the algorithm's structure, parameters and kernel design are
+taken: random start over permutation blocks, 16 samples per node, 64-member
+joins scored with SIMD-group matrices, hashed proposal slots and the bitonic
+merge. The prune-side top-k selection in src/kernels.h follows the same
+module's exact k-NN selection.

mlxvs-0.1.0/PKG-INFO

@@ -0,0 +1,213 @@
+Metadata-Version: 2.4
+Name: mlxvs
+Version: 0.1.0
+Summary: GPU k-NN search and k-NN graph construction on Apple silicon, built on MLX
+Author: mikepapadim
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/mikepapadim/mlxvs
+Project-URL: Issues, https://github.com/mikepapadim/mlxvs/issues
+Keywords: nearest-neighbors,knn,knn-graph,nn-descent,vector-search,k-means,gpu,metal,apple-silicon,mlx,cuvs,umap
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Environment :: GPU
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Database :: Database Engines/Servers
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: mlx<0.33,>=0.32.0
+Requires-Dist: numpy>=1.24
+Dynamic: license-file
+
+# mlxVS
+
+**cuVS for your Mac: GPU vector search on Apple silicon.**
+
+[![CI](https://github.com/mikepapadim/mlxvs/actions/workflows/ci.yml/badge.svg)](https://github.com/mikepapadim/mlxvs/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+Index a million vectors in 10 seconds, then answer 70,000 queries per second at 97.6% recall, on a MacBook Pro's
+GPU: twice the queries per second of HNSW on all 12 CPU cores at the same recall, from an index built 8 times faster
+([numbers](#benchmarks)). mlxVS brings NVIDIA [cuVS](https://github.com/rapidsai/cuvs)'s operations and parameter
+names to the Mac, built on [MLX](https://github.com/ml-explore/mlx): exact k-NN, k-means, NN-Descent, batched
+all-neighbors graphs, CAGRA graph pruning and search. NumPy or MLX arrays in, any M-series Mac.
+
+```python
+import mlxvs
+graph = mlxvs.cagra_build(vectors, graph_degree=32)              # 1M x 128 in ~10 s
+ids, dist = mlxvs.graph_search(vectors, graph, queries, k=10)    # ~70k queries/s at 97.6% recall
+```
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/mikepapadim/mlxvs/main/docs/img/sift1m-dark.png">
+  <img alt="SIFT1M on a MacBook Pro M3 Pro: queries per second against recall@10. mlxVS CAGRA degree 32 (built in 10.4 s) reaches 69,500 queries/s at 0.976 recall; hnswlib on 12 CPU cores (built in 88.1 s) reaches 32,200 at 0.964. Numbers in the Benchmarks table." src="https://raw.githubusercontent.com/mikepapadim/mlxvs/main/docs/img/sift1m-light.png" width="720">
+</picture>
+
+Use it for approximate nearest-neighbor search, for the k-NN graph behind UMAP, t-SNE, clustering and
+deduplication, for exact k-NN ground truth, or as the build step of a graph index (HNSW, Vamana, CAGRA).
+
+## What's in it
+
+| Function | What it does | cuVS counterpart |
+|---|---|---|
+| `brute_force_knn(base, queries, k)` | Exact k-NN: matrix multiply and a fused top-k kernel, tiled over the base | `brute_force::search` |
+| `kmeans_fit(x, clusters)`, `kmeans_predict(x, centroids, m)` | k-means++ and Lloyd; the `m` nearest centroids per row | `cluster::kmeans` |
+| `nn_descent(rows, k)` | Approximate k-NN graph of the rows, FP16 SIMD-group joins | `nn_descent::build` |
+| `all_neighbors(rows, k)` | k-NN graph built in overlapping k-means clusters, one on the GPU at a time; reads a NumPy array or memory-mapped file larger than memory where it is | `all_neighbors::build` |
+| `cagra_build(rows, graph_degree)` | Search graph: k-NN graph (`all_neighbors`) pruned by `cagra_optimize` | `cagra::build` |
+| `cagra_optimize(knn_graph, graph_degree)` | CAGRA's rank-based pruning (fewest two-hop detours) plus reverse edges | `cagra::optimize` |
+| `graph_search(base, graph, queries, k)` | Approximate k-NN of queries by beam search of a graph, one threadgroup per query (CAGRA's single-CTA search) | `cagra::search` |
+| `NearestNeighbors(n_neighbors).fit(X).kneighbors(Q)` | scikit-learn's interface over the above, NumPy in and out | |
+
+Metrics: `"l2"` (squared), `"cosine"`, `"inner_product"`. Next: Vamana pruning and export to HNSW and JVector; see
+[Roadmap](#roadmap).
+
+## 1. Install
+
+Needs an Apple-silicon Mac on macOS 14 or later (as MLX) and Python 3.10+.
+
+```bash
+pip install mlxvs
+```
+
+Wheels for Python 3.10 to 3.14 on Apple silicon, built against the `mlx` release they pin (MLX has no stable C++
+ABI). The latest code from GitHub builds the extension against your `mlx` wheel; that needs the Xcode Command Line
+Tools (`xcode-select --install`) and takes about a minute:
+
+```bash
+pip install git+https://github.com/mikepapadim/mlxvs
+```
+
+## 2. Use
+
+```python
+import numpy as np
+import mlxvs
+
+base = np.random.rand(1_000_000, 128).astype(np.float32)
+queries = base[:10_000]
+
+# exact k-NN: ids [nq, k], distances [nq, k], nearest first
+ids, dist = mlxvs.brute_force_knn(base, queries, k=10, metric="l2")
+
+# approximate k-NN graph: every row's 32 nearest other rows
+graph, graph_dist = mlxvs.nn_descent(base, k=32, metric="cosine")
+
+# the same graph in overlapping k-means clusters, as many as the GPU's memory asks for
+graph, graph_dist = mlxvs.all_neighbors(base, k=32, metric="cosine")
+
+# a search index: the k-NN graph pruned by CAGRA's rules, then queries searched over it;
+# itopk_size trades speed for recall
+index = mlxvs.cagra_build(base, graph_degree=32, metric="cosine")
+ids, dist = mlxvs.graph_search(base, index, queries, k=10, metric="cosine", itopk_size=64)
+
+graph = np.asarray(graph)  # results are mlx arrays; np.asarray converts without a copy
+```
+
+- Inputs: MLX arrays, NumPy arrays, or anything `np.asarray` accepts, in any real dtype (computed in float32).
+- Outputs: `int32` ids, `-1` where fewer neighbors exist; `float32` distances, squared for `"l2"`, similarities
+  (larger is closer) for `"cosine"` and `"inner_product"`.
+- `help(mlxvs.nn_descent)` and the others document every parameter.
+
+Data larger than memory: pass a `numpy.memmap`. The rows stay on disk; `all_neighbors` copies one cluster at a time
+to the GPU.
+
+```python
+rows = np.memmap("embeddings.f32", dtype=np.float32, mode="r").reshape(-1, 1024)
+graph, graph_dist = mlxvs.all_neighbors(rows, k=32, metric="cosine", verbose=True)
+```
+
+Coming from scikit-learn, change the import:
+
+```python
+nn = mlxvs.NearestNeighbors(n_neighbors=10, metric="euclidean").fit(base)
+distances, indices = nn.kneighbors(queries)   # NumPy arrays, scikit-learn's units
+distances, indices = nn.kneighbors()          # the base rows' own neighbors
+```
+
+Examples: [UMAP from a GPU k-NN graph](examples/umap_knn.py) and
+[exact ground truth for an ANN benchmark](examples/ground_truth.py) (`.fvecs` in, `.ivecs` out).
+
+C++: the same functions in [`include/mlxvs/mlxvs.h`](include/mlxvs/mlxvs.h), taking `mx::array` and a trailing
+`mx::StreamOrDevice s = {}` as MLX ops do. In CMake (MLX found through `CMAKE_PREFIX_PATH`, e.g. Homebrew's):
+
+```cmake
+add_subdirectory(mlxvs)          # or FetchContent
+target_link_libraries(app PRIVATE mlxvs)
+```
+
+## 3. Run the benchmarks
+
+```bash
+curl -O ftp://ftp.irisa.fr/local/texmex/corpus/sift.tar.gz && tar xzf sift.tar.gz
+pip install faiss-cpu pynndescent   # optional CPU baselines
+python bench/bench_graph.py sift/sift_base.fvecs --k 32 --clusters 1,8 --baselines faiss,pynndescent
+```
+
+It builds the k-NN graph with each method and scores 2,000 random rows against the exact neighbors.
+
+Search: build a graph, then recall@10 against queries per second over a sweep of `itopk_size`, optionally against
+hnswlib on the CPU.
+
+```bash
+pip install hnswlib   # optional CPU baseline
+python bench/bench_search.py sift/sift_base.fvecs sift/sift_query.fvecs --degree 32 --intermediate 64 \
+    --baselines hnswlib
+```
+
+### Benchmarks
+
+SIFT1M (985,462 x 128, L2, 10,000 queries in one batch, recall@10), MacBook Pro M3 Pro (18-core GPU, 12-core CPU),
+on power. mlxVS 0.1.0; hnswlib 0.8 with `M=16`, `ef_construction=200` on all 12 cores.
+
+| Index | Build | Search setting | Recall@10 | Queries/s |
+|---|---:|---|---:|---:|
+| mlxVS `cagra_build`, degree 32 (from 64) | 10.4 s | `itopk_size` 32 | 0.932 | 119,800 |
+| | | `itopk_size` 64 | 0.976 | 69,500 |
+| | | `itopk_size` 128 | 0.993 | 37,800 |
+| | | `itopk_size` 256 | 0.998 | 27,000 |
+| mlxVS `cagra_build`, degree 64 (from 128) | 19.6 s | `itopk_size` 32 | 0.977 | 79,500 |
+| | | `itopk_size` 64 | 0.994 | 43,600 |
+| mlxVS `nn_descent` k-NN graph, degree 32 (unpruned) | 8.8 s | `itopk_size` 128 | 0.939 | 42,400 |
+| hnswlib (CPU) | 88.1 s | `ef` 32 | 0.904 | 53,300 |
+| | | `ef` 64 | 0.964 | 32,200 |
+| | | `ef` 128 | 0.990 | 17,600 |
+| | | `ef` 256 | 0.998 | 10,200 |
+
+## Coming from cuVS
+
+| mlxvs | cuVS | Note |
+|---|---|---|
+| `nn_descent(rows, k, ...)` | `nn_descent::index_params::graph_degree` | cuVS default 64 |
+| lists of `max(64, k)` entries | `intermediate_graph_degree` | cuVS default 128 |
+| `max_iterations` = 24 | `max_iterations` = 20 | mlxvs samples 16 new neighbors per round and stops early when the lists settle |
+| `termination_threshold` = 1e-4 | `termination_threshold` = 1e-3 | tuned for graph quality in JVector; pass 1e-3 for cuVS's behaviour |
+| `all_neighbors(..., n_clusters, overlap_factor)` | `all_neighbors::index_params::{n_clusters, overlap_factor}` | overlap 2 as cuVS; `n_clusters` defaults to 0 (chosen from the GPU's memory), cuVS's to 1 |
+| `algo="brute_force"` / `"nn_descent"` | `all_neighbors::index_params::graph_build_params` | cuVS also offers IVF-PQ |
+| `"cosine"` returns the cosine similarity | `CosineExpanded` returns 1 - cosine | similarities are "larger is closer"; `"l2"` is squared, as `L2Expanded` |
+| `cagra_build(rows, graph_degree=32, intermediate_graph_degree=64)` | `cagra::index_params::{graph_degree, intermediate_graph_degree}` | cuVS defaults 64 and 128; NN-Descent here caps the intermediate degree at 128 |
+| `cagra_optimize(knn_graph, graph_degree)` | `cagra::optimize` | rank-based pruning and reverse edges, as cuVS; the reverse half fills from the lowest-rank edges |
+| `graph_search(base, graph, queries, k, ...)` | `cagra::search` | takes the dataset and graph directly, no index object yet |
+| `itopk_size` = 64, `search_width` = 1 | `search_params::{itopk_size, search_width}` | same defaults; `itopk_size` at most 256 |
+| `max_iterations` = 0 (automatic) | `search_params::max_iterations` | stops earlier once every list entry is expanded |
+| `num_random_samplings` = 1 | `search_params::num_random_samplings` | random start nodes; no seed nodes yet |
+| `int32` ids | `int64_t` ids | n < 2^31 rows |
+
+## Roadmap
+
+1. Vamana alpha pruning; export to HNSW (hnswlib) and JVector layouts (`cagra::serialize_to_hnswlib`).
+2. An index object holding the dataset and graph; float16 and int8 datasets for search.
+3. A C API for other languages (Java via Panama, as cuVS-java does).
+
+How the kernels work: [docs/DESIGN.md](docs/DESIGN.md). Building, testing and code style:
+[CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+Apache-2.0. The NN-Descent kernels are a port of JVector's `jvector-gpu` module (Apache-2.0, DataStax, Inc.); see
+[NOTICE](NOTICE).