Skip to content
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

cuVS docs updates for release #161

Merged
merged 7 commits into from
May 30, 2024
Merged

cuVS docs updates for release #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d690595
Adding docs for distance and cluster
cjnolet May 28, 2024
bf77f02
Adding more docs for kmeans
cjnolet May 28, 2024
d856e5d
Update notebooks
cjnolet May 28, 2024
31e3365
Adding nn-descent
cjnolet May 28, 2024
4c7c175
For now, removing output of all notebook cells
cjnolet May 29, 2024
88c0d55
Apply suggestions from code review
cjnolet May 30, 2024
c7eeb45
Merge branch 'branch-24.06' into docs_2406_final_cuvs_stuff
cjnolet May 30, 2024
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
16 changes: 16 additions & 0 deletions cpp/include/cuvs/cluster/agglomerative.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ namespace cuvs::cluster::agglomerative {
// constant to indirectly control the number of neighbors. k = sqrt(n) + c. default to 15
constexpr int DEFAULT_CONST_C = 15;

/**
* @defgroup agglomerative_params agglomerative clustering hyperparameters
* @{
*/

/**
* Determines the method for computing the minimum spanning tree (MST)
*/
Expand All @@ -45,6 +50,10 @@ enum Linkage {
KNN_GRAPH = 1
};

/**
* @}
*/

/**
* Simple container object for consolidating linkage results. This closely
* mirrors the trained instance variables populated in
Expand Down Expand Up @@ -75,6 +84,10 @@ class single_linkage_output {
}
};

/**
* @defgroup single_linkage single-linkage clustering APIs
* @{
*/
/**
* Single-linkage clustering, capable of constructing a KNN graph to
* scale the algorithm beyond the n^2 memory consumption of implementations
Expand Down Expand Up @@ -105,4 +118,7 @@ void single_linkage(
cuvs::cluster::agglomerative::Linkage linkage = cuvs::cluster::agglomerative::Linkage::KNN_GRAPH,
std::optional<int> c = std::make_optional<int>(DEFAULT_CONST_C));

/**
* @}
*/
}; // end namespace cuvs::cluster::agglomerative
Loading
Loading