IVF-SQ Python API

c/src/neighbors/ivf_sq.cpp

@@ -339,6 +339,8 @@ extern "C" cuvsError_t cuvsIvfSqExtend(cuvsResources_t res,
 extern "C" cuvsError_t cuvsIvfSqIndexGetNLists(cuvsIvfSqIndex_t index, int64_t* n_lists)
 {
   return cuvs::core::translate_exceptions([=] {
+    RAFT_EXPECTS(index != nullptr, "index cannot be null");
+    RAFT_EXPECTS(index->addr != 0, "index must be built before getting n_lists");
     auto index_ptr =
       reinterpret_cast<cuvs::neighbors::ivf_sq::index<uint8_t>*>(index->addr);
     *n_lists = index_ptr->n_lists();
@@ -348,6 +350,8 @@ extern "C" cuvsError_t cuvsIvfSqIndexGetNLists(cuvsIvfSqIndex_t index, int64_t*
 extern "C" cuvsError_t cuvsIvfSqIndexGetDim(cuvsIvfSqIndex_t index, int64_t* dim)
 {
   return cuvs::core::translate_exceptions([=] {
+    RAFT_EXPECTS(index != nullptr, "index cannot be null");
+    RAFT_EXPECTS(index->addr != 0, "index must be built before getting dim");
     auto index_ptr =
       reinterpret_cast<cuvs::neighbors::ivf_sq::index<uint8_t>*>(index->addr);
     *dim = index_ptr->dim();
@@ -357,6 +361,8 @@ extern "C" cuvsError_t cuvsIvfSqIndexGetDim(cuvsIvfSqIndex_t index, int64_t* dim
 extern "C" cuvsError_t cuvsIvfSqIndexGetSize(cuvsIvfSqIndex_t index, int64_t* size)
 {
   return cuvs::core::translate_exceptions([=] {
+    RAFT_EXPECTS(index != nullptr, "index cannot be null");
+    RAFT_EXPECTS(index->addr != 0, "index must be built before getting size");
     auto index_ptr =
       reinterpret_cast<cuvs::neighbors::ivf_sq::index<uint8_t>*>(index->addr);
     *size = index_ptr->size();

fern/docs.yml

@@ -409,6 +409,8 @@ navigation:
             path: "./pages/python_api/python-api-neighbors-ivf-flat.md"
           - page: "Neighbors IVF PQ"
             path: "./pages/python_api/python-api-neighbors-ivf-pq.md"
+          - page: "Neighbors IVF SQ"
+            path: "./pages/python_api/python-api-neighbors-ivf-sq.md"
           - page: "Neighbors NN Descent"
             path: "./pages/python_api/python-api-neighbors-nn-descent.md"
           - page: "Neighbors"

fern/pages/python_api/index.md

@@ -29,6 +29,7 @@ These pages are generated from the Python and Cython sources under `python/cuvs/
 - [HNSW](/api-reference/python-api-neighbors-hnsw)
 - [IVF Flat](/api-reference/python-api-neighbors-ivf-flat)
 - [IVF PQ](/api-reference/python-api-neighbors-ivf-pq)
+- [IVF SQ](/api-reference/python-api-neighbors-ivf-sq)
 - [NN Descent](/api-reference/python-api-neighbors-nn-descent)
 - [Neighbors](/api-reference/python-api-neighbors)
 - [Tiered Index](/api-reference/python-api-neighbors-tiered-index)