From 56815fbb1b3079d66785be26e4ab21d5072bb93f Mon Sep 17 00:00:00 2001 From: "Corey J. Nolet" Date: Fri, 12 May 2023 14:17:03 -0400 Subject: [PATCH] Adding bfknn and ivf-pq python api to docs (#1507) 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: https://github.com/rapidsai/raft/pull/1507 --- dependencies.yaml | 1 + docs/source/pylibraft_api/neighbors.rst | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+) diff --git a/dependencies.yaml b/dependencies.yaml index ccaf3fe0d8..c768fe0333 100644 --- a/dependencies.yaml +++ b/dependencies.yaml @@ -46,6 +46,7 @@ files: docs: output: none includes: + - test_pylibraft - cudatoolkit - docs - py_version diff --git a/docs/source/pylibraft_api/neighbors.rst b/docs/source/pylibraft_api/neighbors.rst index 89bb577027..c314f1c84d 100644 --- a/docs/source/pylibraft_api/neighbors.rst +++ b/docs/source/pylibraft_api/neighbors.rst @@ -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 ######