Skip to content

Commit

Permalink
Adding bfknn and ivf-pq python api to docs (#1507)
Browse files Browse the repository at this point in the history
Closes #1506. The IVF-PQ docs seem to be rendering fine for me locally. I'm still unsure why they aren't rendering in the nightlies.

Authors:
  - Corey J. Nolet (https://github.com/cjnolet)

Approvers:
  - Ben Frederickson (https://github.com/benfred)
  - AJ Schmidt (https://github.com/ajschmidt8)

URL: #1507
  • Loading branch information
cjnolet authored May 12, 2023
1 parent 6b94e4f commit 56815fb
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
1 change: 1 addition & 0 deletions dependencies.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ files:
docs:
output: none
includes:
- test_pylibraft
- cudatoolkit
- docs
- py_version
Expand Down
22 changes: 22 additions & 0 deletions docs/source/pylibraft_api/neighbors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,28 @@ This page provides pylibraft class references for the publicly-exposed elements
:class: highlight


Brute Force
###########

.. autofunction:: pylibraft.neighbors.brute_force.knn


IVF-Flat
########

.. autoclass:: pylibraft.neighbors.ivf_flat.IndexParams
:members:

.. autofunction:: pylibraft.neighbors.ivf_flat.build

.. autofunction:: pylibraft.neighbors.ivf_flat.extend

.. autoclass:: pylibraft.neighbors.ivf_flat.SearchParams
:members:

.. autofunction:: pylibraft.neighbors.ivf_flat.search


IVF-PQ
######

Expand Down

0 comments on commit 56815fb

Please sign in to comment.