Skip to content

Adds a Lucene API section to the Fern docs, generated from java/cuvs-… #2580

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

Open
imotov wants to merge 1 commit into
base: release/26.10
Choose a base branch
from
Open

Adds a Lucene API section to the Fern docs, generated from java/cuvs-… #2580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@ repos:
^c/include/.*[.](h|hpp)$|
^cpp/include/.*[.](h|hpp|cuh)$|
^python/cuvs/cuvs/.*[.](py|pyx|pxd)$|
^java/cuvs-java/src/main/.*[.]java$|
^java/cuvs-(java|lucene)/src/main/.*[.]java$|
^rust/cuvs/src/.*[.]rs$|
^go/.*[.]go$|
^fern/scripts/generate_api_reference[.]py$|
^fern/pages/(c|cpp|python|java|rust|go)_api/.*[.]md$|
^fern/pages/(c|cpp|python|java|lucene|rust|go)_api/.*[.]md$|
^fern/pages/api_reference[.]md$|
^fern/docs[.]yml$
- id: no-deprecationwarning
Expand Down
55 changes: 55 additions & 0 deletions fern/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,6 +544,61 @@ navigation:
path: "./pages/java_api/java-api-com-nvidia-cuvs-tieredindexparams.md"
- page: "TieredIndexQuery"
path: "./pages/java_api/java-api-com-nvidia-cuvs-tieredindexquery.md"
- section: "Lucene API Documentation"
path: "./pages/lucene_api/index.md"
contents:
- page: "AcceleratedHNSWParams"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-acceleratedhnswparams.md"
- page: "AcceleratedHNSWUtils"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-acceleratedhnswutils.md"
- page: "CagraIndexParamsFactory"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cagraindexparamsfactory.md"
- page: "FilterBitsetCacheConfig"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-filterbitsetcacheconfig.md"
- page: "FilterCuVSServiceProvider"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-filtercuvsserviceprovider.md"
- page: "GPUIndex"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpuindex.md"
- page: "GPUSearchParams"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpusearchparams.md"
- page: "LuceneProvider"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneprovider.md"
- page: "ThreadLocalCuVSResourcesProvider"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-threadlocalcuvsresourcesprovider.md"
- page: "Utils"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-utils.md"
- page: "CuVS2510GPUSearchCodec"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpusearchcodec.md"
- page: "CuVS2510GPUVectorsFormat"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorsformat.md"
- page: "CuVS2510GPUVectorsReader"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorsreader.md"
- page: "CuVS2510GPUVectorsWriter"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorswriter.md"
- page: "FieldWriter"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-fieldwriter.md"
- page: "GPUBuiltHnswGraph"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpubuilthnswgraph.md"
- page: "GPUKnnFloatVectorQuery"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpuknnfloatvectorquery.md"
- page: "Lucene101AcceleratedHNSWCodec"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-lucene101acceleratedhnswcodec.md"
- page: "Lucene99AcceleratedHNSWVectorsFormat"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-lucene99acceleratedhnswvectorsformat.md"
- page: "Lucene99AcceleratedHNSWVectorsWriter"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-lucene99acceleratedhnswvectorswriter.md"
- page: "LuceneAcceleratedHNSWBinaryQuantizedCodec"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswbinaryquantizedcodec.md"
- page: "LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswbinaryquantizedvectorsformat.md"
- page: "LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswbinaryquantizedvectorswriter.md"
- page: "LuceneAcceleratedHNSWScalarQuantizedCodec"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswscalarquantizedcodec.md"
- page: "LuceneAcceleratedHNSWScalarQuantizedVectorsFormat"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswscalarquantizedvectorsformat.md"
- page: "LuceneAcceleratedHNSWScalarQuantizedVectorsWriter"
path: "./pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswscalarquantizedvectorswriter.md"
- section: "Rust API Documentation"
path: "./pages/rust_api/index.md"
contents:
Expand Down
1 change: 1 addition & 0 deletions fern/pages/api_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@ For task-focused examples and usage guidance, see the [API Guide](/user-guide/ap
- [C++ API Documentation](/api-reference/cpp-api-documentation): inspect the core NVIDIA cuVS C++ APIs, including common RAFT types used in public headers.
- [Python API Documentation](/api-reference/python-api-documentation): inspect Python modules, classes, functions, and parameters.
- [Java API Documentation](/api-reference/java-api-documentation): inspect Java classes, resources, matrices, indexes, and query APIs.
- [Lucene API Documentation](/api-reference/lucene-api-documentation): inspect the Apache Lucene codecs that offload vector index build and search to the GPU.
- [Rust API Documentation](/api-reference/rust-api-documentation): inspect Rust modules, structs, and wrappers around NVIDIA cuVS APIs.
- [Go API Documentation](/api-reference/go-api-documentation): inspect Go packages for supported NVIDIA cuVS APIs.
35 changes: 35 additions & 0 deletions fern/pages/lucene_api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Lucene API Documentation

These pages are generated from the Java source files in `java/cuvs-lucene/src/main`.

## Common

- [AcceleratedHNSWParams](/api-reference/lucene-api-com-nvidia-cuvs-lucene-acceleratedhnswparams)
- [AcceleratedHNSWUtils](/api-reference/lucene-api-com-nvidia-cuvs-lucene-acceleratedhnswutils)
- [CagraIndexParamsFactory](/api-reference/lucene-api-com-nvidia-cuvs-lucene-cagraindexparamsfactory)
- [FilterBitsetCacheConfig](/api-reference/lucene-api-com-nvidia-cuvs-lucene-filterbitsetcacheconfig)
- [FilterCuVSServiceProvider](/api-reference/lucene-api-com-nvidia-cuvs-lucene-filtercuvsserviceprovider)
- [GPUIndex](/api-reference/lucene-api-com-nvidia-cuvs-lucene-gpuindex)
- [GPUSearchParams](/api-reference/lucene-api-com-nvidia-cuvs-lucene-gpusearchparams)
- [LuceneProvider](/api-reference/lucene-api-com-nvidia-cuvs-lucene-luceneprovider)
- [ThreadLocalCuVSResourcesProvider](/api-reference/lucene-api-com-nvidia-cuvs-lucene-threadlocalcuvsresourcesprovider)
- [Utils](/api-reference/lucene-api-com-nvidia-cuvs-lucene-utils)

## Codecs and Formats

- [CuVS2510GPUSearchCodec](/api-reference/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpusearchcodec)
- [CuVS2510GPUVectorsFormat](/api-reference/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorsformat)
- [CuVS2510GPUVectorsReader](/api-reference/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorsreader)
- [CuVS2510GPUVectorsWriter](/api-reference/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorswriter)
- [FieldWriter](/api-reference/lucene-api-com-nvidia-cuvs-lucene-fieldwriter)
- [GPUBuiltHnswGraph](/api-reference/lucene-api-com-nvidia-cuvs-lucene-gpubuilthnswgraph)
- [GPUKnnFloatVectorQuery](/api-reference/lucene-api-com-nvidia-cuvs-lucene-gpuknnfloatvectorquery)
- [Lucene101AcceleratedHNSWCodec](/api-reference/lucene-api-com-nvidia-cuvs-lucene-lucene101acceleratedhnswcodec)
- [Lucene99AcceleratedHNSWVectorsFormat](/api-reference/lucene-api-com-nvidia-cuvs-lucene-lucene99acceleratedhnswvectorsformat)
- [Lucene99AcceleratedHNSWVectorsWriter](/api-reference/lucene-api-com-nvidia-cuvs-lucene-lucene99acceleratedhnswvectorswriter)
- [LuceneAcceleratedHNSWBinaryQuantizedCodec](/api-reference/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswbinaryquantizedcodec)
- [LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat](/api-reference/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswbinaryquantizedvectorsformat)
- [LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter](/api-reference/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswbinaryquantizedvectorswriter)
- [LuceneAcceleratedHNSWScalarQuantizedCodec](/api-reference/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswscalarquantizedcodec)
- [LuceneAcceleratedHNSWScalarQuantizedVectorsFormat](/api-reference/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswscalarquantizedvectorsformat)
- [LuceneAcceleratedHNSWScalarQuantizedVectorsWriter](/api-reference/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswscalarquantizedvectorswriter)
Loading
Loading