-
Notifications
You must be signed in to change notification settings - Fork 195
Adding new docs link(s) to readme. Adding landing page for API refs #2228
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.
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
Open
cjnolet
wants to merge
15
commits into
NVIDIA:main
Choose a base branch
from
cjnolet:readme-nvida-docs-link
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
14a4b27
Update Fern and reorganize guide navigation
cjnolet 8feffa0
Move integration patterns under field guide
cjnolet 066d806
Update field guide docs
cjnolet 6ff921e
Update fern/pages/advanced_topics.md
cjnolet 729e9d2
Fix Fern API reference formatting
cjnolet 55a0438
Set NVIDIA global Fern theme
cjnolet fc579bc
Updating README to point to new docs
cjnolet 8dc29fc
Add API Reference landing page
cjnolet 89fdd26
Merge docs updates into README branch
cjnolet 1bd7776
Merge branch 'main' into readme-nvida-docs-link
cjnolet e9d4c55
Merge branch 'main' into readme-nvida-docs-link
cjnolet 8b546f1
Merge remote-tracking branch 'rapidsai/main' into readme-nvida-docs-link
cjnolet 07d9eaa
Merge remote-tracking branch 'cjnolet/readme-nvida-docs-link' into re…
cjnolet 24bc426
Update cuVS repository URLs
cjnolet 3b89c3c
Fix style after repository URL update
cjnolet File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
170 changes: 85 additions & 85 deletions
170
cpp/tests/neighbors/ann_cagra/bug_iterative_cagra_build.cu
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,85 +1,85 @@ | ||
| /* | ||
| * SPDX-FileCopyrightText: Copyright (c) 2025-2026, NVIDIA CORPORATION. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
| #include <gtest/gtest.h> | ||
| #include <cuvs/neighbors/cagra.hpp> | ||
| #include <raft/core/device_mdarray.hpp> | ||
| #include <raft/core/device_resources.hpp> | ||
| #include <raft/random/rng.cuh> | ||
| #include <cstdint> | ||
| #include <type_traits> | ||
| namespace cuvs::neighbors::cagra { | ||
| template <typename DataT> | ||
| class CagraIterativeBuildBugTest : public ::testing::Test { | ||
| public: | ||
| using data_type = DataT; | ||
| protected: | ||
| void run() | ||
| { | ||
| // Set up iterative CAGRA graph building | ||
| cagra::index_params index_params; | ||
| // The bug manifests when graph_degree is equal to intermediate_graph_degree | ||
| // see issue https://github.com/rapidsai/cuvs/issues/1818 | ||
| index_params.graph_degree = 16; | ||
| index_params.intermediate_graph_degree = 16; | ||
| // Use iterative CAGRA search for graph building | ||
| index_params.graph_build_params = graph_build_params::iterative_search_params(); | ||
| // Build the index | ||
| auto cagra_index = cagra::build(res, index_params, raft::make_const_mdspan(dataset->view())); | ||
| raft::resource::sync_stream(res); | ||
| // Verify the index was built successfully | ||
| ASSERT_GT(cagra_index.size(), 0); | ||
| ASSERT_EQ(cagra_index.dim(), n_dim); | ||
| } | ||
| void SetUp() override | ||
| { | ||
| dataset.emplace(raft::make_device_matrix<data_type, int64_t>(res, n_samples, n_dim)); | ||
| raft::random::RngState r(1234ULL); | ||
| // Generate random data based on type | ||
| if constexpr (std::is_same_v<data_type, float>) { | ||
| raft::random::normal( | ||
| res, r, dataset->data_handle(), n_samples * n_dim, data_type(0), data_type(1)); | ||
| } else if constexpr (std::is_same_v<data_type, int8_t>) { | ||
| raft::random::uniformInt( | ||
| res, r, dataset->data_handle(), n_samples * n_dim, int8_t(-128), int8_t(127)); | ||
| } else if constexpr (std::is_same_v<data_type, uint8_t>) { | ||
| raft::random::uniformInt( | ||
| res, r, dataset->data_handle(), n_samples * n_dim, uint8_t(0), uint8_t(255)); | ||
| } | ||
| raft::resource::sync_stream(res); | ||
| } | ||
| void TearDown() override | ||
| { | ||
| dataset.reset(); | ||
| raft::resource::sync_stream(res); | ||
| } | ||
| private: | ||
| raft::resources res; | ||
| std::optional<raft::device_matrix<data_type, int64_t>> dataset = std::nullopt; | ||
| constexpr static int64_t n_samples = 10000; | ||
| constexpr static int64_t n_dim = 1024; | ||
| }; | ||
| // Instantiate test for different data types | ||
| using TestTypes = ::testing::Types<float, int8_t, uint8_t>; | ||
| TYPED_TEST_SUITE(CagraIterativeBuildBugTest, TestTypes); | ||
| TYPED_TEST(CagraIterativeBuildBugTest, IterativeBuildTest) { this->run(); } | ||
| } // namespace cuvs::neighbors::cagra | ||
| /* | ||
| * SPDX-FileCopyrightText: Copyright (c) 2025-2026, NVIDIA CORPORATION. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| #include <gtest/gtest.h> | ||
|
|
||
| #include <cuvs/neighbors/cagra.hpp> | ||
|
|
||
| #include <raft/core/device_mdarray.hpp> | ||
| #include <raft/core/device_resources.hpp> | ||
| #include <raft/random/rng.cuh> | ||
|
|
||
| #include <cstdint> | ||
| #include <type_traits> | ||
|
|
||
| namespace cuvs::neighbors::cagra { | ||
|
|
||
| template <typename DataT> | ||
| class CagraIterativeBuildBugTest : public ::testing::Test { | ||
| public: | ||
| using data_type = DataT; | ||
|
|
||
| protected: | ||
| void run() | ||
| { | ||
| // Set up iterative CAGRA graph building | ||
| cagra::index_params index_params; | ||
| // The bug manifests when graph_degree is equal to intermediate_graph_degree | ||
| // see issue https://github.com/nvidia/cuvs/issues/1818 | ||
| index_params.graph_degree = 16; | ||
| index_params.intermediate_graph_degree = 16; | ||
|
|
||
| // Use iterative CAGRA search for graph building | ||
| index_params.graph_build_params = graph_build_params::iterative_search_params(); | ||
|
|
||
| // Build the index | ||
| auto cagra_index = cagra::build(res, index_params, raft::make_const_mdspan(dataset->view())); | ||
| raft::resource::sync_stream(res); | ||
|
|
||
| // Verify the index was built successfully | ||
| ASSERT_GT(cagra_index.size(), 0); | ||
| ASSERT_EQ(cagra_index.dim(), n_dim); | ||
| } | ||
|
|
||
| void SetUp() override | ||
| { | ||
| dataset.emplace(raft::make_device_matrix<data_type, int64_t>(res, n_samples, n_dim)); | ||
| raft::random::RngState r(1234ULL); | ||
|
|
||
| // Generate random data based on type | ||
| if constexpr (std::is_same_v<data_type, float>) { | ||
| raft::random::normal( | ||
| res, r, dataset->data_handle(), n_samples * n_dim, data_type(0), data_type(1)); | ||
| } else if constexpr (std::is_same_v<data_type, int8_t>) { | ||
| raft::random::uniformInt( | ||
| res, r, dataset->data_handle(), n_samples * n_dim, int8_t(-128), int8_t(127)); | ||
| } else if constexpr (std::is_same_v<data_type, uint8_t>) { | ||
| raft::random::uniformInt( | ||
| res, r, dataset->data_handle(), n_samples * n_dim, uint8_t(0), uint8_t(255)); | ||
| } | ||
| raft::resource::sync_stream(res); | ||
| } | ||
|
|
||
| void TearDown() override | ||
| { | ||
| dataset.reset(); | ||
| raft::resource::sync_stream(res); | ||
| } | ||
|
|
||
| private: | ||
| raft::resources res; | ||
| std::optional<raft::device_matrix<data_type, int64_t>> dataset = std::nullopt; | ||
|
|
||
| constexpr static int64_t n_samples = 10000; | ||
| constexpr static int64_t n_dim = 1024; | ||
| }; | ||
|
|
||
| // Instantiate test for different data types | ||
| using TestTypes = ::testing::Types<float, int8_t, uint8_t>; | ||
| TYPED_TEST_SUITE(CagraIterativeBuildBugTest, TestTypes); | ||
|
|
||
| TYPED_TEST(CagraIterativeBuildBugTest, IterativeBuildTest) { this->run(); } | ||
|
|
||
| } // namespace cuvs::neighbors::cagra |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
Repository: rapidsai/cuvs
Length of output: 1629
🏁 Script executed:
Repository: rapidsai/cuvs
Length of output: 3874
Align remaining cuVS documentation URLs beyond README
README now links to
docs.nvidia.com/cuvs, but the repo still contains legacydocs.rapids.ai/api/cuvs/...pointers (e.g.,python/cuvs/pyproject.toml,python/libcuvs/pyproject.toml,fern/pages/index.md, and cuVS-related notebooks). This can lead to inconsistent doc navigation depending on entry point—either update these todocs.nvidia.com/cuvsor confirm the legacy links are intentionally kept/redirect.🤖 Prompt for AI Agents