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

Fixes links in api for community, traversal and sampling #4124

Closed
wants to merge 2 commits into from
Closed

Fixes links in api for community, traversal and sampling #4124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a246a7
quick fix to make the api appear correctly.
acostadon Jan 30, 2024
929daa7
Merge remote-tracking branch 'upstream/branch-24.02' into fix_links_0116
acostadon Jan 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
48 changes: 0 additions & 48 deletions docs/cugraph/source/api_docs/cugraph_c/community.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,55 +7,7 @@ Community

``#include <cugraph_c/community_algorithms.h>``

Triangle Counting
-----------------
.. doxygenfunction:: cugraph_triangle_count
:project: libcugraph

Louvain
-------
.. doxygenfunction:: cugraph_louvain
:project: libcugraph

Leiden
------
.. doxygenfunction:: cugraph_leiden
:project: libcugraph

ECG
---
.. doxygenfunction:: cugraph_ecg
:project: libcugraph

Extract Egonet
--------------
.. doxygenfunction:: cugraph_extract_ego
:project: libcugraph

Balanced Cut
------------
.. doxygenfunction:: cugraph_balanced_cut_clustering
:project: libcugraph

Spectral Clustering - Modularity Maximization
---------------------------------------------
.. doxygenfunction:: cugraph_spectral_modularity_maximization
:project: libcugraph

.. doxygenfunction:: cugraph_analyze_clustering_modularity
:project: libcugraph

Spectral Clusteriong - Edge Cut
-------------------------------
.. doxygenfunction:: cugraph_analyze_clustering_edge_cut
:project: libcugraph

.. doxygenfunction:: cugraph_analyze_clustering_ratio_cut
:project: libcugraph


Community Support Functions
---------------------------
.. doxygengroup:: community
:project: libcugraph
:members:
Expand Down
32 changes: 4 additions & 28 deletions docs/cugraph/source/api_docs/cugraph_c/sampling.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,12 @@
Sampling
========

Uniform Random Walks
--------------------
.. doxygenfunction:: cugraph_uniform_random_walks
:project: libcugraph
.. role:: py(code)
:language: c
:class: highlight

Biased Random Walks
--------------------
.. doxygenfunction:: cugraph_biased_random_walks
:project: libcugraph
``#include <cugraph_c/sampling_algorithms.h>``

Random Walks via Node2Vec
-------------------------
.. doxygenfunction:: cugraph_node2vec_random_walks
:project: libcugraph

Node2Vec
--------
.. doxygenfunction:: cugraph_node2vec
:project: libcugraph

Uniform Neighborhood Sampling
-----------------------------
.. doxygenfunction:: cugraph_uniform_neighbor_sample_with_edge_properties
:project: libcugraph

.. doxygenfunction:: cugraph_uniform_neighbor_sample
:project: libcugraph

Support
-------
.. doxygengroup:: samplingC
:project: libcugraph
:members:
Expand Down
25 changes: 4 additions & 21 deletions docs/cugraph/source/api_docs/cugraph_c/traversal.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,12 @@
Traversal
==========

.. role:: py(code)
:language: c
:class: highlight

Breadth First Search (BFS)
--------------------------
.. doxygenfunction:: cugraph_bfs
:project: libcugraph
``#include <cugraph_c/traversal_algorithms.h>``

Single-Source Shortest-Path (SSSP)
----------------------------------
.. doxygenfunction:: cugraph_sssp
:project: libcugraph

Path Extraction
---------------
.. doxygenfunction:: cugraph_extract_paths
:project: libcugraph

Extract Max Path Length
-----------------------
.. doxygenfunction:: cugraph_extract_paths_result_get_max_path_length
:project: libcugraph

Support
-------
.. doxygengroup:: traversal
:project: libcugraph
:members:
Expand Down
Loading