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.

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

important doc updates for core, cluster, and neighbors #933

Merged
merged 9 commits into from
Oct 21, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
7 changes: 4 additions & 3 deletions docs/source/cpp_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ RAFT C++ API Reference
:maxdepth: 4

cpp_api/core.rst
cpp_api/clustering.rst
cpp_api/cluster.rst
cpp_api/distance.rst
cpp_api/linalg.rst
cpp_api/matrix.rst
cpp_api/optimization.rst
cpp_api/neighbors.rst
cpp_api/solver.rst
cpp_api/random.rst
cpp_api/spatial.rst
cpp_api/sparse.rst
cpp_api/stats.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Clustering
==========
Cluster
=======

This page provides C++ class references for the publicly-exposed elements of the clustering package.
This page provides C++ class references for the publicly-exposed elements of the cluster package.

.. doxygennamespace:: raft::cluster
:project: RAFT
Expand Down
10 changes: 10 additions & 0 deletions docs/source/cpp_api/distance.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Distance
========

This page provides C++ class references for the publicly-exposed elements of the distance package.

Distance
########

.. doxygennamespace:: raft::distance
:project: RAFT
43 changes: 43 additions & 0 deletions docs/source/cpp_api/neighbors.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Neighbors
=========

This page provides C++ class references for the publicly-exposed elements of the neighbors package.


Brute-force
-----------

.. doxygennamespace:: raft::neighbors::brute_force
:project: RAFT


IVF-Flat
--------

.. doxygennamespace:: raft::neighbors::ivf_flat
:project: RAFT
:members:


IVF-PQ
--------

.. doxygennamespace:: raft::neighbors::ivf_pq
:project: RAFT
:members:


Epsilon Neighborhood
--------------------

.. doxygennamespace:: raft::neighbors::epsilon_neighborhood
:project: RAFT
:members:


Random Ball Cover
-----------------

.. doxygennamespace:: raft::neighbors::ball_cover
:project: RAFT
:members:
File renamed without changes.
31 changes: 0 additions & 31 deletions docs/source/cpp_api/spatial.rst

This file was deleted.