Skip to content

Treat warnings as errors in doc builds + MG ANNs Python API doc update #1350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rapids-bot merged 6 commits into from
Sep 29, 2025
Merged

Treat warnings as errors in doc builds + MG ANNs Python API doc update #1350

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
af8a000
Update MG Python API doc
viclafargue Sep 22, 2025
866cb52
Update ci/build_docs.sh
viclafargue Sep 25, 2025
52b946d
Merge branch 'branch-25.10' into update-mg-python-doc
viclafargue Sep 25, 2025
8e63d0d
doc correctives
viclafargue Sep 25, 2025
bced5bf
Update doc build
viclafargue Sep 26, 2025
750f577
Merge branch 'branch-25.10' into update-mg-python-doc
viclafargue Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ci/build_docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
# Copyright (c) 2023-2024, NVIDIA CORPORATION.
# Copyright (c) 2023-2025, NVIDIA CORPORATION.

set -euo pipefail

Expand Down Expand Up @@ -48,7 +48,7 @@ popd

rapids-logger "Build Python docs"
pushd docs
sphinx-build -b dirhtml source _html
sphinx-build -W -b dirhtml source _html
Copy link
Copy Markdown
Member

@jameslamb jameslamb Sep 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider putting this into the Makefile and using make dirhtml in any scripts where you want to build the docs:

cuvs/docs/Makefile

Line 5 in c07ab70

SPHINXOPTS =

That way, the settings would apply still if you switched from dirhtml to html, and you wouldn't have to keep this in sync with this other use:

cuvs/build.sh

Line 520 in c07ab70

sphinx-build -W -b html source _html

See how cudf does this for an example:

https://github.com/rapidsai/cudf/blob/1504ddc2ebb39b3be0847e680b8d76e8cc37a7a1/docs/cudf/Makefile#L5

https://github.com/rapidsai/cudf/blob/1504ddc2ebb39b3be0847e680b8d76e8cc37a7a1/ci/build_docs.sh#L56

Copy link
Copy Markdown
Member

@cjnolet cjnolet Sep 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@viclafargue do you mind creating a Github issue for this?

Copy link
Copy Markdown
Contributor Author

@viclafargue viclafargue Sep 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I created #1382.

mv ../rust/target/doc ./_html/_static/rust
mkdir -p "${RAPIDS_DOCS_DIR}/cuvs/"html
mv _html/* "${RAPIDS_DOCS_DIR}/cuvs/html"
Expand Down
4 changes: 4 additions & 0 deletions cpp/include/cuvs/neighbors/cagra.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1964,6 +1964,10 @@ void serialize_to_hnswlib(
std::optional<raft::host_matrix_view<const uint8_t, int64_t, raft::row_major>> dataset =
std::nullopt);

/**
* @}
*/

/**
* @defgroup cagra_cpp_index_merge CAGRA index build functions
* @{
Expand Down
4 changes: 4 additions & 0 deletions cpp/include/cuvs/neighbors/hnsw.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,10 @@ struct extend_params {
int num_threads = 0;
};

/**
* @}
*/

/**
* @defgroup hnsw_cpp_index_load Load CAGRA index as hnswlib index
* @{
Expand Down
4 changes: 4 additions & 0 deletions cpp/include/cuvs/neighbors/vamana.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,6 +488,10 @@ auto build(raft::resources const& res,
raft::host_matrix_view<const uint8_t, int64_t, raft::row_major> dataset)
-> cuvs::neighbors::vamana::index<uint8_t, uint32_t>;

/**
* @}
*/

/**
* @defgroup vamana_cpp_serialize Vamana serialize functions
* @{
Expand Down
10 changes: 5 additions & 5 deletions cpp/include/cuvs/preprocessing/spectral_embedding.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,6 @@

namespace cuvs::preprocessing::spectral_embedding {

/**
* @defgroup spectral_embedding Spectral Embedding
* @{
*/

/**
* @brief Parameters for spectral embedding algorithm
*
Expand Down Expand Up @@ -71,6 +66,11 @@ struct params {
uint64_t seed;
};

/**
* @defgroup spectral_embedding Spectral Embedding
* @{
*/

/**
* @brief Perform spectral embedding on input dataset
*
Expand Down
2 changes: 1 addition & 1 deletion docs/source/neighbors/all_neighbors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ All-neighbors supports multiple underlying algorithms:

The algorithm partitions the dataset into clusters and distributes the work across multiple GPUs when possible, making it suitable for large-scale graph construction tasks.

[ :doc:`C API <../c_api/neighbors_all_neighbors_c>` |:doc:`C++ API <../cpp_api/neighbors_all_neighbors>` | :doc:`Python API <../python_api/neighbors_all_neighbors>` ]
[ :doc:`C API <../c_api/neighbors_all_neighbors_c>` | :doc:`C++ API <../cpp_api/neighbors_all_neighbors>` | :doc:`Python API <../python_api/neighbors_all_neighbors>` ]

Algorithm Overview
------------------
Expand Down
16 changes: 8 additions & 8 deletions docs/source/python_api/neighbors_mg_cagra.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,42 +14,42 @@ Multi-GPU CAGRA extends the graph-based CAGRA algorithm to work across multiple
Index build parameters
######################

.. autoclass:: cuvs.neighbors.mg_cagra.IndexParams
.. autoclass:: cuvs.neighbors.mg.cagra.IndexParams
:members:

Index search parameters
#######################

.. autoclass:: cuvs.neighbors.mg_cagra.SearchParams
.. autoclass:: cuvs.neighbors.mg.cagra.SearchParams
:members:

Index
#####

.. autoclass:: cuvs.neighbors.mg_cagra.Index
.. autoclass:: cuvs.neighbors.mg.cagra.Index
:members:

Index build
###########

.. autofunction:: cuvs.neighbors.mg_cagra.build
.. autofunction:: cuvs.neighbors.mg.cagra.build

Index search
############

.. autofunction:: cuvs.neighbors.mg_cagra.search
.. autofunction:: cuvs.neighbors.mg.cagra.search

Index save
##########

.. autofunction:: cuvs.neighbors.mg_cagra.save
.. autofunction:: cuvs.neighbors.mg.cagra.save

Index load
##########

.. autofunction:: cuvs.neighbors.mg_cagra.load
.. autofunction:: cuvs.neighbors.mg.cagra.load

Index distribute
################

.. autofunction:: cuvs.neighbors.mg_cagra.distribute
.. autofunction:: cuvs.neighbors.mg.cagra.distribute
18 changes: 9 additions & 9 deletions docs/source/python_api/neighbors_mg_ivf_flat.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,47 +14,47 @@ Multi-GPU IVF-Flat extends the IVF-Flat algorithm to work across multiple GPUs,
Index build parameters
######################

.. autoclass:: cuvs.neighbors.mg_ivf_flat.IndexParams
.. autoclass:: cuvs.neighbors.mg.ivf_flat.IndexParams
:members:

Index search parameters
#######################

.. autoclass:: cuvs.neighbors.mg_ivf_flat.SearchParams
.. autoclass:: cuvs.neighbors.mg.ivf_flat.SearchParams
:members:

Index
#####

.. autoclass:: cuvs.neighbors.mg_ivf_flat.Index
.. autoclass:: cuvs.neighbors.mg.ivf_flat.Index
:members:

Index build
###########

.. autofunction:: cuvs.neighbors.mg_ivf_flat.build
.. autofunction:: cuvs.neighbors.mg.ivf_flat.build

Index search
############

.. autofunction:: cuvs.neighbors.mg_ivf_flat.search
.. autofunction:: cuvs.neighbors.mg.ivf_flat.search

Index extend
############

.. autofunction:: cuvs.neighbors.mg_ivf_flat.extend
.. autofunction:: cuvs.neighbors.mg.ivf_flat.extend

Index save
##########

.. autofunction:: cuvs.neighbors.mg_ivf_flat.save
.. autofunction:: cuvs.neighbors.mg.ivf_flat.save

Index load
##########

.. autofunction:: cuvs.neighbors.mg_ivf_flat.load
.. autofunction:: cuvs.neighbors.mg.ivf_flat.load

Index distribute
################

.. autofunction:: cuvs.neighbors.mg_ivf_flat.distribute
.. autofunction:: cuvs.neighbors.mg.ivf_flat.distribute
18 changes: 9 additions & 9 deletions docs/source/python_api/neighbors_mg_ivf_pq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,47 +14,47 @@ Multi-GPU IVF-PQ extends the IVF-PQ (Inverted File with Product Quantization) al
Index build parameters
######################

.. autoclass:: cuvs.neighbors.mg_ivf_pq.IndexParams
.. autoclass:: cuvs.neighbors.mg.ivf_pq.IndexParams
:members:

Index search parameters
#######################

.. autoclass:: cuvs.neighbors.mg_ivf_pq.SearchParams
.. autoclass:: cuvs.neighbors.mg.ivf_pq.SearchParams
:members:

Index
#####

.. autoclass:: cuvs.neighbors.mg_ivf_pq.Index
.. autoclass:: cuvs.neighbors.mg.ivf_pq.Index
:members:

Index build
###########

.. autofunction:: cuvs.neighbors.mg_ivf_pq.build
.. autofunction:: cuvs.neighbors.mg.ivf_pq.build

Index search
############

.. autofunction:: cuvs.neighbors.mg_ivf_pq.search
.. autofunction:: cuvs.neighbors.mg.ivf_pq.search

Index extend
############

.. autofunction:: cuvs.neighbors.mg_ivf_pq.extend
.. autofunction:: cuvs.neighbors.mg.ivf_pq.extend

Index save
##########

.. autofunction:: cuvs.neighbors.mg_ivf_pq.save
.. autofunction:: cuvs.neighbors.mg.ivf_pq.save

Index load
##########

.. autofunction:: cuvs.neighbors.mg_ivf_pq.load
.. autofunction:: cuvs.neighbors.mg.ivf_pq.load

Index distribute
################

.. autofunction:: cuvs.neighbors.mg_ivf_pq.distribute
.. autofunction:: cuvs.neighbors.mg.ivf_pq.distribute