Skip to content

Fix generated Java source links #23

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

Draft
nvzm123 wants to merge 1 commit into
base: zackm_fern_java_source_links_base
Choose a base branch
from
Draft

Fix generated Java source links #23

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
2 changes: 1 addition & 1 deletion .github/workflows/pr.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -690,7 +690,7 @@ jobs:
build_type: pull-request
matrix_name: docs-build
docs-build:
needs: [docs-build-matrix]
needs: [changed-files, docs-build-matrix]
permissions:
actions: read
contents: read
Expand Down
3 changes: 3 additions & 0 deletions fern/build_docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,10 @@ run_fern() {
}

generate_api_reference() {
pushd "${REPO_DIR}" >/dev/null
python3 -m unittest fern.scripts.test_generate_api_reference
python3 "${SCRIPT_DIR}/scripts/generate_api_reference.py"
popd >/dev/null
}

run_checks() {
Expand Down
2 changes: 1 addition & 1 deletion fern/pages/java_api/java-api-com-nvidia-cuvs-bbqquantizer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ public Builder withCentroidNormSq(float value)
Sets the squared L2 norm of the centroid. Required: there is no meaningful default, and
leaving it at zero skews inner-product and cosine distances without reporting an error.

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BbqQuantizer.java:185`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BbqQuantizer.java:186`_

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BbqQuantizer.java:15`_
20 changes: 10 additions & 10 deletions fern/pages/java_api/java-api-com-nvidia-cuvs-bruteforceindex.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ to interact with it.
Invokes the native destroy_brute_force_index function to de-allocate
BRUTEFORCE index

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:25`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:27`_

### search

Expand All @@ -45,7 +45,7 @@ a BRUTEFORCE index.

an instance of `SearchResults` containing the results

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:36`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:37`_

### serialize

Expand All @@ -62,7 +62,7 @@ A method to persist a BRUTEFORCE index using an instance of
| --- | --- |
| `outputStream` | an instance of `OutputStream` to write the index bytes into |

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:45`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:46`_

### serialize

Expand All @@ -80,7 +80,7 @@ A method to persist a BRUTEFORCE index using an instance of
| `outputStream` | an instance of `OutputStream` to write the index bytes to |
| `tempFile` | an intermediate `Path` where BRUTEFORCE index is written temporarily |

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:56`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:57`_

### newBuilder

Expand All @@ -102,7 +102,7 @@ Creates a new Builder with an instance of `CuVSResources`.
| --- | --- |
| `UnsupportedOperationException` | if the provider does not cuvs |

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:64`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:65`_

### withIndexParams

Expand All @@ -123,7 +123,7 @@ Builder.

An instance of this Builder

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:81`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:82`_

### from

Expand All @@ -144,7 +144,7 @@ needed.

an instance of this Builder

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:90`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:91`_

### withDataset

Expand All @@ -164,7 +164,7 @@ Sets the dataset vectors for building the `BruteForceIndex`.

an instance of this Builder

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:98`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:99`_

### withDataset

Expand All @@ -184,7 +184,7 @@ Sets the dataset for building the `BruteForceIndex`.

an instance of this Builder

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:106`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:107`_

### build

Expand All @@ -198,6 +198,6 @@ Builds and returns an instance of `BruteForceIndex`.

an instance of `BruteForceIndex`

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:113`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:114`_

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java:20`_
6 changes: 3 additions & 3 deletions fern/pages/java_api/java-api-com-nvidia-cuvs-bruteforceindexparams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public int getNumWriterThreads()

Gets the number of threads used to build the index.

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndexParams.java:27`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndexParams.java:28`_

### withNumWriterThreads

Expand All @@ -42,7 +42,7 @@ Sets the number of writer threads to use for indexing.

an instance of Builder

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndexParams.java:44`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndexParams.java:45`_

### build

Expand All @@ -56,6 +56,6 @@ Builds an instance of `BruteForceIndexParams`.

an instance of `BruteForceIndexParams`

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndexParams.java:54`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndexParams.java:55`_

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndexParams.java:12`_
26 changes: 13 additions & 13 deletions fern/pages/java_api/java-api-com-nvidia-cuvs-bruteforcequery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ mapping, and topK.
| `numDocs` | Maximum of bits in each prefilter, representing number of documents in this index. Used only when prefilter(s) is/are passed. |
| `resources` | CuVSResources instance to use for this query |

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:42`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:43`_

### getQueryVectors

Expand All @@ -52,7 +52,7 @@ Gets the query vector 2D float array.

2D float array

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:62`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:63`_

### getMapping

Expand All @@ -62,7 +62,7 @@ public LongToIntFunction getMapping()

Gets the function mapping ordinals (neighbor IDs) to custom user IDs

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:69`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:70`_

### getTopK

Expand All @@ -76,7 +76,7 @@ Gets the topK value.

an integer

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:78`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:79`_

### getPrefilters

Expand All @@ -90,7 +90,7 @@ Gets the prefilter long array

an array of bitsets

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:87`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:88`_

### getNumDocs

Expand All @@ -104,7 +104,7 @@ Gets the number of documents supposed to be in this index, as used for prefilter

number of documents as an integer

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:96`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:97`_

### getResources

Expand All @@ -118,7 +118,7 @@ Gets the CuVSResources instance for this query.

the CuVSResources instance

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:105`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:106`_

### Builder

Expand All @@ -138,7 +138,7 @@ CuVSResources instance to avoid memory allocation conflicts and potential JVM cr
| --- | --- |
| `resources` | the CuVSResources instance to use for this query (must not be shared between threads) |

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:143`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:144`_

### withQueryVectors

Expand All @@ -158,7 +158,7 @@ Registers the query vectors to be passed in the search call.

an instance of this Builder

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:153`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:154`_

### withMapping

Expand All @@ -178,7 +178,7 @@ Sets the function used to map ordinals (neighbor IDs) to custom user IDs

an instance of this Builder

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:164`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:165`_

### withTopK

Expand All @@ -198,7 +198,7 @@ Registers the topK value.

an instance of this Builder

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:175`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:176`_

### withPrefilters

Expand All @@ -218,7 +218,7 @@ Sets the prefilters data for building the `BruteForceQuery`.

an instance of this Builder

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:187`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:188`_

### build

Expand All @@ -232,6 +232,6 @@ Builds an instance of `BruteForceQuery`

an instance of `BruteForceQuery`

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:198`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:199`_

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceQuery.java:21`_
26 changes: 13 additions & 13 deletions fern/pages/java_api/java-api-com-nvidia-cuvs-cagracompressionparams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Gets the bit length of the vector element after compression by PQ.

the bit length of the vector element after compression by PQ.

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:57`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:58`_

### getPqDim

Expand All @@ -40,7 +40,7 @@ Gets the dimensionality of the vector after compression by PQ.

the dimensionality of the vector after compression by PQ.

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:66`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:67`_

### getVqNCenters

Expand All @@ -55,7 +55,7 @@ centers”.

the vector quantization (VQ) codebook size - number of “coarse cluster centers”.

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:77`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:78`_

### getKmeansNIters

Expand All @@ -70,7 +70,7 @@ phases).

the number of iterations searching for kmeans centers (both VQ and PQ phases).

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:88`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:89`_

### getVqKmeansTrainsetFraction

Expand All @@ -84,7 +84,7 @@ Gets the fraction of data to use during iterative kmeans building (VQ phase).

the fraction of data to use during iterative kmeans building (VQ phase).

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:98`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:99`_

### getPqKmeansTrainsetFraction

Expand All @@ -98,7 +98,7 @@ Gets the fraction of data to use during iterative kmeans building (PQ phase).

the fraction of data to use during iterative kmeans building (PQ phase).

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:108`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:109`_

### withPqBits

Expand All @@ -122,7 +122,7 @@ the recall.

an instance of Builder

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:153`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:154`_

### withPqDim

Expand All @@ -144,7 +144,7 @@ When zero, an optimal value is selected using a heuristic.

an instance of Builder

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:166`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:167`_

### withVqNCenters

Expand All @@ -167,7 +167,7 @@ When zero, an optimal value is selected using a heuristic.

an instance of Builder

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:180`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:181`_

### withKmeansNIters

Expand All @@ -188,7 +188,7 @@ phases).

an instance of Builder

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:192`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:193`_

### withVqKmeansTrainsetFraction

Expand All @@ -210,7 +210,7 @@ When zero, an optimal value is selected using a heuristic.

an instance of Builder

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:205`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:206`_

### withPqKmeansTrainsetFraction

Expand All @@ -232,7 +232,7 @@ When zero, an optimal value is selected using a heuristic.

an instance of Builder

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:218`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:219`_

### build

Expand All @@ -246,6 +246,6 @@ Builds an instance of `CagraCompressionParams`.

an instance of `CagraCompressionParams`

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:228`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:229`_

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:12`_
Loading
Loading