diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml index dd524fc16b..c1aba1c4f9 100644 --- a/.github/workflows/pr.yaml +++ b/.github/workflows/pr.yaml @@ -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 diff --git a/fern/build_docs.sh b/fern/build_docs.sh index 58613e5ae6..983b2a7cf3 100755 --- a/fern/build_docs.sh +++ b/fern/build_docs.sh @@ -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() { diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-bbqquantizer.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-bbqquantizer.md index 5f47befedf..884bc88bc6 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-bbqquantizer.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-bbqquantizer.md @@ -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`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-bruteforceindex.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-bruteforceindex.md index 72f8cbe709..9c08ed784e 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-bruteforceindex.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-bruteforceindex.md @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-bruteforceindexparams.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-bruteforceindexparams.md index 7ee1620cad..78519246c3 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-bruteforceindexparams.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-bruteforceindexparams.md @@ -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 @@ -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 @@ -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`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-bruteforcequery.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-bruteforcequery.md index 1e9302b6d6..352d89247e 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-bruteforcequery.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-bruteforcequery.md @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-cagracompressionparams.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-cagracompressionparams.md index 2b0f1624dd..a6120b4ef3 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-cagracompressionparams.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-cagracompressionparams.md @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-cagraindex.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-cagraindex.md index c89f50b924..3d0b9a3378 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-cagraindex.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-cagraindex.md @@ -29,7 +29,7 @@ public final void setDelegate(AutoCloseable delegate, long handleAddress) Internal wiring hook used by the Java wrapper implementation. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:34`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:35`_ ### isPresent @@ -39,7 +39,7 @@ public final boolean isPresent() Returns true when this view has a native handle. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:42`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:43`_ ### nativeHandleAddress @@ -49,7 +49,7 @@ public final long nativeHandleAddress() Internal accessor for native handle address. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:49`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:50`_ ### setDelegate @@ -59,7 +59,7 @@ public final void setDelegate(AutoCloseable delegate) Internal wiring hook used by the Java wrapper implementation. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:84`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:85`_ ### setDelegate @@ -69,7 +69,7 @@ public final void setDelegate(AutoCloseable delegate, long handleAddress) Internal wiring hook used by the Java wrapper implementation. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:91`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:92`_ ### isPresent @@ -79,7 +79,7 @@ public final boolean isPresent() Returns true when this handle owns native dataset storage. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:99`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:100`_ ### nativeHandleAddress @@ -89,7 +89,7 @@ public final long nativeHandleAddress() Internal accessor for native handle address. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:106`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:107`_ ### close @@ -100,7 +100,7 @@ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:106`_ Invokes the native destroy_cagra_index to de-allocate the CAGRA index. Also attempts to close any dataset whose ownership transferred to this index during construction. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:137`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:139`_ ### search @@ -121,7 +121,7 @@ CAGRA index. an instance of `SearchResults` containing the results -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:148`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:149`_ ### makePaddedDataset @@ -133,7 +133,7 @@ Create an owning padded dataset by allocating padded storage and copying `dataset`. Prefer this when the source matrix is not already padded to CAGRA's required row stride (e.g. unaligned dimensions). -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:155`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:156`_ ### makePaddedDatasetView @@ -145,7 +145,7 @@ Create a caller-owned padded dataset view handle from a matrix that is already padded to CAGRA's required row stride. For unpadded matrices use `#makePaddedDataset(CuVSMatrix)`. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:162`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:163`_ ### makeStandardDatasetView @@ -155,7 +155,7 @@ StandardDatasetView makeStandardDatasetView(CuVSMatrix dataset) throws Throwable Create a caller-owned standard dataset view handle from a matrix. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:165`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:166`_ ### updateDataset @@ -167,7 +167,7 @@ Update this index with a caller-provided padded device dataset view and leave it search-ready in padded-device layout. The caller retains ownership of the underlying padded storage and must keep it alive while this index uses it. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:172`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:173`_ ### updateDataset @@ -178,7 +178,7 @@ void updateDataset(PaddedDataset dataset) throws Throwable Update this index with a caller-owned padded device dataset. The dataset must remain alive while this index uses it. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:178`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:179`_ ### getGraph @@ -192,7 +192,7 @@ Returns the CAGRA graph a `CuVSDeviceMatrix` encapsulating the native int (uint32_t) array used to represent the cagra graph -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:185`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:186`_ ### getGraphDegree @@ -208,7 +208,7 @@ build truncated it. the built graph degree (`graph().extent(1)`) -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:194`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:195`_ ### size @@ -222,7 +222,7 @@ Returns the number of vectors in this index. the number of rows of the indexed dataset -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:201`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:202`_ ### serialize @@ -239,7 +239,7 @@ for writing index bytes. | --- | --- | | `outputStream` | an instance of `OutputStream` to write the index bytes into | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:210`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:211`_ ### serialize @@ -257,7 +257,7 @@ for writing index bytes. | `outputStream` | an instance of `OutputStream` to write the index bytes into | | `bufferLength` | the length of buffer to use for writing bytes. Default value is 1024 | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:221`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:222`_ ### serialize @@ -275,7 +275,7 @@ for writing index bytes. | `outputStream` | an instance of `OutputStream` to write the index bytes into | | `tempFile` | an intermediate `Path` where CAGRA index is written temporarily | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:232`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:233`_ ### serialize @@ -294,7 +294,7 @@ and path to the intermediate temporary file. | `tempFile` | an intermediate `Path` where CAGRA index is written temporarily | | `bufferLength` | the length of buffer to use for writing bytes. Default value is 1024 | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:247`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:248`_ ### serializeToHNSW @@ -311,7 +311,7 @@ of `OutputStream` and path to the intermediate temporary file. | --- | --- | | `outputStream` | an instance of `OutputStream` to write the index bytes to | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:256`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:257`_ ### serializeToHNSW @@ -329,7 +329,7 @@ of `OutputStream` and path to the intermediate temporary file. | `outputStream` | an instance of `OutputStream` to write the index bytes to | | `bufferLength` | the length of buffer to use for writing bytes. Default value is 1024 | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:267`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:268`_ ### serializeToHNSW @@ -347,7 +347,7 @@ of `OutputStream` and path to the intermediate temporary file. | `outputStream` | an instance of `OutputStream` to write the index bytes to | | `tempFile` | an intermediate `Path` where CAGRA index is written temporarily | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:278`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:279`_ ### serializeToHNSW @@ -366,7 +366,7 @@ of `OutputStream` and path to the intermediate temporary file. | `tempFile` | an intermediate `Path` where CAGRA index is written temporarily | | `bufferLength` | the length of buffer to use for writing bytes. Default value is 1024 | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:293`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:294`_ ### getCuVSResources @@ -380,7 +380,7 @@ Gets an instance of `CuVSResources` an instance of `CuVSResources` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:300`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:301`_ ### newBuilder @@ -402,7 +402,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/CagraIndex.java:308`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:309`_ ### merge @@ -428,7 +428,7 @@ A new merged CAGRA index | --- | --- | | `Throwable` | if an error occurs during the merge operation | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:320`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:321`_ ### merge @@ -455,7 +455,7 @@ A new merged CAGRA index | --- | --- | | `Throwable` | if an error occurs during the merge operation | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:332`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:333`_ ### merge @@ -491,7 +491,7 @@ A new merged CAGRA index | `IllegalArgumentException` | if `rowFilter` has a bit set beyond the last row, or if it is non-null but keeps no rows at all | | `Throwable` | if an error occurs during the merge operation | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:356`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:357`_ ### isPaddedDataset @@ -517,7 +517,7 @@ copy it into padded storage it already occupies, and one that is not has to go t true when the rows are already padded the way CAGRA requires -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:384`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:385`_ ### from @@ -538,7 +538,7 @@ needed. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:401`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:402`_ ### from @@ -561,7 +561,7 @@ serialized index. Keep `outDataset` alive while the built index is in use. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:412`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:413`_ ### from @@ -572,7 +572,7 @@ Builder from(CuVSMatrix graph) Sets a CAGRA graph instance to re-create an index from a previously built graph. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:418`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:419`_ ### withDataset @@ -592,7 +592,7 @@ Sets the dataset vectors for building the `CagraIndex`. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:426`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:427`_ ### withDataset @@ -617,7 +617,7 @@ with the caller. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:439`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:440`_ ### withBbqDataset @@ -635,7 +635,7 @@ stay open for as long as the index is in use. A dense dataset passed to `#withDataset(CuVSMatrix)` is owned by the index, as it is for a non-BBQ build, and is closed with it. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:452`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:453`_ ### withIndexParams @@ -656,7 +656,7 @@ Builder. An instance of this Builder. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:461`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:462`_ ### build @@ -670,6 +670,6 @@ Builds and returns an instance of CagraIndex. an instance of CagraIndex -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:468`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:469`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java:26`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-cagraindexparams.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-cagraindexparams.md index d1e8bccfc3..f6a91ec0dd 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-cagraindexparams.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-cagraindexparams.md @@ -22,7 +22,7 @@ AUTO_SELECT(0), /** * Use IVF-PQ to build all-neighbors knn graph */ IVF_PQ(1), Select build algorithm automatically -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:35`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:36`_ ### IVF_PQ @@ -32,7 +32,7 @@ IVF_PQ(1), /** * Experimental, use NN-Descent to build all-neighbors knn graph * Use IVF-PQ to build all-neighbors knn graph -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:39`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:40`_ ### NN_DESCENT @@ -42,7 +42,7 @@ NN_DESCENT(2), /** * Experimental, use ACE (Augmented Core Extraction) to build Experimental, use NN-Descent to build all-neighbors knn graph -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:43`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:44`_ ### ACE @@ -53,7 +53,7 @@ ACE(4) Experimental, use ACE (Augmented Core Extraction) to build graph for large datasets. 4 to be consistent with the other interfaces. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:48`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:49`_ ### SIMILAR_SEARCH_PERFORMANCE @@ -71,7 +71,7 @@ searched by HNSW are close for any search parameter combination. The CAGRA-produ to have a "longer tail" on the low recall side (that is being slightly faster and less precise). -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:84`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:85`_ ### SAME_GRAPH_FOOTPRINT @@ -88,7 +88,7 @@ the same ef, the from-CAGRA index likely has a slightly higher recall and slight However, the Recall-QPS curves should be similar (i.e. the points are just shifted along the curve). -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:95`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:96`_ ### L2Expanded @@ -98,7 +98,7 @@ L2Expanded(0), /** * same as above, but inside the epilogue, perform square root evaluate as dist_ij = sum(x_ik^2) + sum(y_ij)^2 - 2*sum(x_ik * y_jk) -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:123`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:124`_ ### L2SqrtExpanded @@ -108,7 +108,7 @@ L2SqrtExpanded(1), /** * cosine distance */ CosineExpanded(2), /** * L1 distance same as above, but inside the epilogue, perform square root operation -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:127`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:128`_ ### CosineExpanded @@ -118,7 +118,7 @@ CosineExpanded(2), /** * L1 distance * */ L1(3), /** * evaluate as dist_ij += (x cosine distance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:131`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:132`_ ### L1 @@ -128,7 +128,7 @@ L1(3), /** * evaluate as dist_ij += (x_ik - y-jk)^2 * */ L2Unexpanded(4), /** * L1 distance * -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:135`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:136`_ ### L2Unexpanded @@ -138,7 +138,7 @@ L2Unexpanded(4), /** * same as above, but inside the epilogue, perform square ro evaluate as dist_ij += (x_ik - y-jk)^2 * -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:139`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:140`_ ### L2SqrtUnexpanded @@ -148,7 +148,7 @@ L2SqrtUnexpanded(5), /** * basic inner product */ InnerProduct(6), /** * Chebysh same as above, but inside the epilogue, perform square root operation -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:143`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:144`_ ### InnerProduct @@ -158,7 +158,7 @@ InnerProduct(6), /** * Chebyshev (Linf) distance */ Linf(7), /** * Canberra dist basic inner product -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:147`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:148`_ ### Linf @@ -168,7 +168,7 @@ Linf(7), /** * Canberra distance */ Canberra(8), /** * Generalized Minkowski dis Chebyshev (Linf) distance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:151`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:152`_ ### Canberra @@ -178,7 +178,7 @@ Canberra(8), /** * Generalized Minkowski distance */ LpUnexpanded(9), /** * Corr Canberra distance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:155`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:156`_ ### LpUnexpanded @@ -188,7 +188,7 @@ LpUnexpanded(9), /** * Correlation distance */ CorrelationExpanded(10), /** * Ja Generalized Minkowski distance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:159`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:160`_ ### CorrelationExpanded @@ -198,7 +198,7 @@ CorrelationExpanded(10), /** * Jaccard distance */ JaccardExpanded(11), /** * He Correlation distance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:163`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:164`_ ### JaccardExpanded @@ -208,7 +208,7 @@ JaccardExpanded(11), /** * Hellinger distance */ HellingerExpanded(12), /** * Ha Jaccard distance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:167`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:168`_ ### HellingerExpanded @@ -218,7 +218,7 @@ HellingerExpanded(12), /** * Haversine distance */ Haversine(13), /** * Bray-Cur Hellinger distance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:171`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:172`_ ### Haversine @@ -228,7 +228,7 @@ Haversine(13), /** * Bray-Curtis distance */ BrayCurtis(14), /** * Jensen-Shanno Haversine distance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:175`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:176`_ ### BrayCurtis @@ -238,7 +238,7 @@ BrayCurtis(14), /** * Jensen-Shannon distance */ JensenShannon(15), /** * Hammin Bray-Curtis distance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:179`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:180`_ ### JensenShannon @@ -248,7 +248,7 @@ JensenShannon(15), /** * Hamming distance */ HammingUnexpanded(16), /** * KLDive Jensen-Shannon distance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:183`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:184`_ ### HammingUnexpanded @@ -258,7 +258,7 @@ HammingUnexpanded(16), /** * KLDivergence */ KLDivergence(17), /** * RusselRao * Hamming distance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:187`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:188`_ ### KLDivergence @@ -268,7 +268,7 @@ KLDivergence(17), /** * RusselRao */ RusselRaoExpanded(18), /** * Dice-Sorensen KLDivergence -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:191`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:192`_ ### RusselRaoExpanded @@ -278,7 +278,7 @@ RusselRaoExpanded(18), /** * Dice-Sorensen distance */ DiceExpanded(19), /** * P RusselRao -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:195`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:196`_ ### DiceExpanded @@ -288,7 +288,7 @@ DiceExpanded(19), /** * Precomputed (special value) */ Precomputed(100) Dice-Sorensen distance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:199`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:200`_ ### Precomputed @@ -298,7 +298,7 @@ Precomputed(100) Precomputed (special value) -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:203`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:204`_ ### getIntermediateGraphDegree @@ -312,7 +312,7 @@ Gets the degree of input graph for pruning. the degree of input graph -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:369`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:370`_ ### getGraphDegree @@ -326,7 +326,7 @@ Gets the degree of output graph. the degree of output graph -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:378`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:379`_ ### getCagraGraphBuildAlgo @@ -336,7 +336,7 @@ public CagraGraphBuildAlgo getCagraGraphBuildAlgo() Gets the `CagraGraphBuildAlgo` used to build the index. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:385`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:386`_ ### getNNDescentNumIterations @@ -347,7 +347,7 @@ public long getNNDescentNumIterations() Gets the number of iterations to run if building with `CagraGraphBuildAlgo#NN_DESCENT` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:393`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:394`_ ### getCuvsDistanceType @@ -357,7 +357,7 @@ public CuvsDistanceType getCuvsDistanceType() Gets the `CuvsDistanceType` used to build the index. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:400`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:401`_ ### getNumWriterThreads @@ -367,7 +367,7 @@ public int getNumWriterThreads() Gets the number of threads used to build the index. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:407`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:408`_ ### getCuVSIvfPqParams @@ -377,7 +377,7 @@ public CuVSIvfPqParams getCuVSIvfPqParams() Gets the IVF_PQ parameters. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:414`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:415`_ ### getCuVSAceParams @@ -387,7 +387,7 @@ public CuVSAceParams getCuVSAceParams() Gets the ACE parameters. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:421`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:422`_ ### getCuvsCagraGraphBuildAlgo @@ -397,7 +397,7 @@ public CagraGraphBuildAlgo getCuvsCagraGraphBuildAlgo() Gets the CAGRA build algorithm. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:428`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:429`_ ### withIntermediateGraphDegree @@ -417,7 +417,7 @@ Sets the degree of input graph for pruning. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:475`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:476`_ ### withGraphDegree @@ -437,7 +437,7 @@ Sets the degree of output graph. an instance to Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:486`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:487`_ ### withCagraGraphBuildAlgo @@ -457,7 +457,7 @@ Sets the CuvsCagraGraphBuildAlgo to use. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:497`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:498`_ ### withMetric @@ -477,7 +477,7 @@ Sets the metric to use. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:508`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:509`_ ### withNNDescentNumIterations @@ -498,7 +498,7 @@ Sets the Number of Iterations to run if building with an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:521`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:522`_ ### withNumWriterThreads @@ -518,7 +518,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/CagraIndexParams.java:532`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:533`_ ### withCuVSIvfPqParams @@ -538,7 +538,7 @@ Sets the IVF_PQ index parameters. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:543`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:544`_ ### withCuVSAceParams @@ -558,7 +558,7 @@ Sets the ACE index parameters. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:554`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:555`_ ### build @@ -572,6 +572,6 @@ Builds an instance of `CagraIndexParams`. an instance of `CagraIndexParams` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:564`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:565`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:18`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-cagramergeparams.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-cagramergeparams.md index 5cbac56994..bda4998fb6 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-cagramergeparams.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-cagramergeparams.md @@ -24,7 +24,7 @@ Gets the index parameters for the output index. Index parameters to use for the output index -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraMergeParams.java:27`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraMergeParams.java:28`_ ### getStrategy @@ -38,7 +38,7 @@ Gets the merge strategy to use. The merge strategy -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraMergeParams.java:36`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraMergeParams.java:37`_ ### withOutputIndexParams @@ -58,7 +58,7 @@ Sets the index parameters for the output index. This builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraMergeParams.java:68`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraMergeParams.java:69`_ ### withStrategy @@ -78,7 +78,7 @@ Sets the merge strategy. This builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraMergeParams.java:79`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraMergeParams.java:80`_ ### build @@ -92,6 +92,6 @@ Builds the `CagraMergeParams` object. The built parameters -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraMergeParams.java:89`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraMergeParams.java:90`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraMergeParams.java:7`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-cagraquery.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-cagraquery.md index c5ae5c4d2c..99ab83a8f8 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-cagraquery.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-cagraquery.md @@ -31,7 +31,7 @@ Gets the instance of CagraSearchParams initially set. an instance CagraSearchParams -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:66`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:67`_ ### getQueryVectors @@ -41,7 +41,7 @@ public CuVSMatrix getQueryVectors() Gets the query vector matrix. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:73`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:74`_ ### getMapping @@ -51,7 +51,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/CagraQuery.java:80`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:81`_ ### getTopK @@ -65,7 +65,7 @@ Gets the topK value. the topK value -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:89`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:90`_ ### getPrefilter @@ -79,7 +79,7 @@ Gets the prefilter BitSet. a BitSet object representing the prefilter -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:98`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:99`_ ### getNumDocs @@ -93,7 +93,7 @@ Gets the number of documents in this index, as used for prefilter number of documents as an integer -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:107`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:108`_ ### getResources @@ -107,7 +107,7 @@ Gets the CuVSResources instance for this query. the CuVSResources instance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:116`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:117`_ ### Builder @@ -127,7 +127,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/CagraQuery.java:155`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:156`_ ### withSearchParams @@ -147,7 +147,7 @@ Sets the instance of configured CagraSearchParams to be passed for search. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:166`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:167`_ ### withQueryVectors @@ -167,7 +167,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/CagraQuery.java:177`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:178`_ ### withMapping @@ -187,7 +187,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/CagraQuery.java:188`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:189`_ ### withTopK @@ -207,7 +207,7 @@ Registers the topK value. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:199`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:200`_ ### withPrefilter @@ -231,7 +231,7 @@ corresponding dataset vector; `0` excludes it. this `Builder` instance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:214`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:215`_ ### build @@ -245,6 +245,6 @@ Builds an instance of CuVSQuery. an instance of CuVSQuery -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:225`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:226`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:21`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-cagrasearchparams.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-cagrasearchparams.md index 59565786a6..ef1bcbb002 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-cagrasearchparams.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-cagrasearchparams.md @@ -23,7 +23,7 @@ SINGLE_CTA(0), /** * for small batch sizes */ MULTI_CTA(1), /** * MULTI_KERNEL * for large batch sizes -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:35`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:36`_ ### MULTI_CTA @@ -33,7 +33,7 @@ MULTI_CTA(1), /** * MULTI_KERNEL */ MULTI_KERNEL(2), /** * AUTO */ AUTO(100) for small batch sizes -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:39`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:40`_ ### MULTI_KERNEL @@ -43,7 +43,7 @@ MULTI_KERNEL(2), /** * AUTO */ AUTO(100) MULTI_KERNEL -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:43`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:44`_ ### AUTO @@ -53,7 +53,7 @@ AUTO(100) AUTO -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:47`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:48`_ ### HASH @@ -63,7 +63,7 @@ HASH(0), /** * SMALL */ SMALL(1), /** * AUTO_HASH */ AUTO_HASH(100) HASH -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:66`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:67`_ ### SMALL @@ -73,7 +73,7 @@ SMALL(1), /** * AUTO_HASH */ AUTO_HASH(100) SMALL -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:70`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:71`_ ### AUTO_HASH @@ -83,7 +83,7 @@ AUTO_HASH(100) AUTO_HASH -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:74`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:75`_ ### getMaxQueries @@ -97,7 +97,7 @@ Gets the maximum number of queries to search at the same time (batch size). the maximum number of queries -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:143`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:144`_ ### getITopKSize @@ -111,7 +111,7 @@ Gets the number of intermediate search results retained during the search. the number of intermediate search results -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:152`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:153`_ ### getMaxIterations @@ -125,7 +125,7 @@ Gets the upper limit of search iterations. the upper limit value -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:161`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:162`_ ### getTeamSize @@ -139,7 +139,7 @@ Gets the number of threads used to calculate a single distance. the number of threads configured -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:170`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:171`_ ### getSearchWidth @@ -154,7 +154,7 @@ in each iteration. the number of graph nodes -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:180`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:181`_ ### getMinIterations @@ -168,7 +168,7 @@ Gets the lower limit of search iterations. the lower limit value -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:189`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:190`_ ### getThreadBlockSize @@ -182,7 +182,7 @@ Gets the thread block size. the thread block size -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:198`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:199`_ ### getHashmapMinBitlen @@ -196,7 +196,7 @@ Gets the lower limit of hash map bit length. the lower limit value -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:207`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:208`_ ### getNumRandomSamplings @@ -210,7 +210,7 @@ Gets the number of iterations of initial random seed node selection. the number of iterations -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:216`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:217`_ ### getHashMapMaxFillRate @@ -224,7 +224,7 @@ Gets the upper limit of hash map fill rate. the upper limit of hash map fill rate -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:225`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:226`_ ### getRandXORMask @@ -238,7 +238,7 @@ Gets the bit mask used for initial random seed node selection. the bit mask value -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:234`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:235`_ ### getCagraSearchAlgo @@ -252,7 +252,7 @@ Gets which search implementation is configured. the configured `SearchAlgo` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:243`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:244`_ ### getHashMapMode @@ -266,7 +266,7 @@ Gets the hash map mode configured. the configured `HashMapMode` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:252`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:253`_ ### Builder @@ -276,7 +276,7 @@ public Builder() Default constructor. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:309`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:310`_ ### withMaxQueries @@ -297,7 +297,7 @@ Auto select when 0. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:318`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:319`_ ### withItopkSize @@ -319,7 +319,7 @@ Higher values improve the search accuracy. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:331`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:332`_ ### withMaxIterations @@ -339,7 +339,7 @@ Sets the upper limit of search iterations. Auto select when 0. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:342`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:343`_ ### withAlgo @@ -359,7 +359,7 @@ Sets which search implementation to use. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:353`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:354`_ ### withTeamSize @@ -380,7 +380,7 @@ Sets the number of threads used to calculate a single distance. 4, 8, 16, or an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:365`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:366`_ ### withSearchWidth @@ -401,7 +401,7 @@ in each iteration. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:377`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:378`_ ### withMinIterations @@ -421,7 +421,7 @@ Sets the lower limit of search iterations. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:388`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:389`_ ### withThreadBlockSize @@ -442,7 +442,7 @@ Sets the thread block size. 0, 64, 128, 256, 512, 1024. Auto selection when an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:400`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:401`_ ### withHashMapMode @@ -462,7 +462,7 @@ Sets the hash map type. Auto selection when AUTO. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:411`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:412`_ ### withHashMapMinBitlen @@ -482,7 +482,7 @@ Sets the lower limit of hash map bit length. More than 8. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:422`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:423`_ ### withHashMapMaxFillRate @@ -502,7 +502,7 @@ Sets the upper limit of hash map fill rate. More than 0.1, less than 0.9. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:433`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:434`_ ### withNumRandomSamplings @@ -523,7 +523,7 @@ more. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:446`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:447`_ ### withRandXorMask @@ -543,7 +543,7 @@ Sets the bit mask used for initial random seed node selection. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:457`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:458`_ ### build @@ -558,6 +558,6 @@ parameters. an instance of CagraSearchParams -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:468`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:469`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraSearchParams.java:13`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsaceparams.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsaceparams.md index a3dccaefab..9783974160 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsaceparams.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsaceparams.md @@ -31,7 +31,7 @@ Gets the number of partitions. the number of partitions -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:97`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:98`_ ### getEfConstruction @@ -45,7 +45,7 @@ Gets the `ef_construction` parameter. the `ef_construction` parameter -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:106`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:107`_ ### getBuildDir @@ -59,7 +59,7 @@ Gets the build directory path. the build directory path -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:115`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:116`_ ### isUseDisk @@ -73,7 +73,7 @@ Gets whether disk-based mode is enabled. true if disk-based mode is enabled -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:124`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:125`_ ### getMaxHostMemoryGb @@ -87,7 +87,7 @@ Gets the maximum host memory limit in GiB. the max host memory limit (0 means use available memory) -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:133`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:134`_ ### getMaxGpuMemoryGb @@ -101,7 +101,7 @@ Gets the maximum GPU memory limit in GiB. the max GPU memory limit (0 means use available memory) -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:142`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:143`_ ### withNpartitions @@ -121,7 +121,7 @@ Sets the number of partitions. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:194`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:195`_ ### withEfConstruction @@ -141,7 +141,7 @@ Sets the ef_construction parameter. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:205`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:206`_ ### withBuildDir @@ -161,7 +161,7 @@ Sets the build directory path. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:216`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:217`_ ### withUseDisk @@ -181,7 +181,7 @@ Sets whether to use disk-based mode. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:227`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:228`_ ### withMaxHostMemoryGb @@ -204,7 +204,7 @@ Useful for testing or when running alongside other memory-intensive processes. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:241`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:242`_ ### withMaxGpuMemoryGb @@ -227,7 +227,7 @@ Useful for testing or when running alongside other memory-intensive processes. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:255`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:256`_ ### build @@ -241,6 +241,6 @@ Builds an instance of `CuVSAceParams`. an instance of `CuVSAceParams` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:265`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:266`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:17`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsdevicematrix.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsdevicematrix.md index 73ed360d77..48e8e00e13 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsdevicematrix.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsdevicematrix.md @@ -24,6 +24,6 @@ Returns a new host matrix with data from this device matrix. The returned host matrix will need to be managed by the caller, which will be responsible to call `CuVSMatrix#close()` to free its resources when done. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSDeviceMatrix.java:16`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSDeviceMatrix.java:17`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSDeviceMatrix.java:10`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsivfpqindexparams.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsivfpqindexparams.md index 9b9d37a42c..6e4a840cd3 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsivfpqindexparams.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsivfpqindexparams.md @@ -24,7 +24,7 @@ Gets the distance type. the distance type -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:143`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:144`_ ### getCodebookKind @@ -38,7 +38,7 @@ Gets how PQ codebooks are created how PQ codebooks are created -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:152`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:153`_ ### getMetricArg @@ -52,7 +52,7 @@ Gets the argument used by some distance metrics the argument used by some distance metrics -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:161`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:162`_ ### getKmeansTrainsetFraction @@ -66,7 +66,7 @@ Gets the fraction of data to use during iterative kmeans building the fraction of data to use during iterative kmeans building -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:170`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:171`_ ### getnLists @@ -80,7 +80,7 @@ Gets the number of inverted lists (clusters) the number of inverted lists (clusters) -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:179`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:180`_ ### getKmeansNIters @@ -94,7 +94,7 @@ Gets the number of iterations searching for kmeans centers the number of iterations searching for kmeans centers -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:188`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:189`_ ### getPqBits @@ -108,7 +108,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/CuVSIvfPqIndexParams.java:197`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:198`_ ### getPqDim @@ -122,7 +122,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/CuVSIvfPqIndexParams.java:206`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:207`_ ### isAddDataOnBuild @@ -136,7 +136,7 @@ Gets whether the dataset content is added to the index whether the dataset content is added to the index -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:215`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:216`_ ### isForceRandomRotation @@ -150,7 +150,7 @@ Gets the random rotation matrix on the input data and queries the random rotation matrix on the input data and queries -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:224`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:225`_ ### isConservativeMemoryAllocation @@ -164,7 +164,7 @@ Gets if conservative allocation behavior is set if conservative allocation behavior is set -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:233`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:234`_ ### getMaxTrainPointsPerPqCode @@ -179,7 +179,7 @@ training is set whether max number of data points to use per PQ code during PQ codebook training is set -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:244`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:245`_ ### withMetric @@ -199,7 +199,7 @@ Sets the distance type. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:389`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:390`_ ### withMetricArg @@ -219,7 +219,7 @@ Sets the argument used by some distance metrics. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:400`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:401`_ ### withAddDataOnBuild @@ -239,7 +239,7 @@ Sets whether to add the dataset content to the index. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:411`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:412`_ ### withNLists @@ -259,7 +259,7 @@ Sets the number of inverted lists (clusters) an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:422`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:423`_ ### withKmeansNIters @@ -279,7 +279,7 @@ Sets the number of iterations searching for kmeans centers an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:433`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:434`_ ### withKmeansTrainsetFraction @@ -299,7 +299,7 @@ Sets the fraction of data to use during iterative kmeans building. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:445`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:446`_ ### withPqBits @@ -319,7 +319,7 @@ Sets the bit length of the vector element after compression by PQ. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:456`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:457`_ ### withPqDim @@ -339,7 +339,7 @@ Sets the dimensionality of the vector after compression by PQ. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:467`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:468`_ ### withCodebookKind @@ -359,7 +359,7 @@ Sets how PQ codebooks are created. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:478`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:479`_ ### withForceRandomRotation @@ -379,7 +379,7 @@ Sets the random rotation matrix on the input data and queries. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:490`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:491`_ ### withConservativeMemoryAllocation @@ -399,7 +399,7 @@ Sets the conservative allocation behavior an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:501`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:502`_ ### withMaxTrainPointsPerPqCode @@ -420,7 +420,7 @@ training an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:514`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:515`_ ### build @@ -434,6 +434,6 @@ Builds an instance of `CuVSIvfPqIndexParams`. an instance of `CuVSIvfPqIndexParams` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:524`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:525`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:10`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsivfpqparams.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsivfpqparams.md index e9dc585c99..2d4657a051 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsivfpqparams.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsivfpqparams.md @@ -18,7 +18,7 @@ public class CuVSIvfPqParams public CuVSIvfPqIndexParams getIndexParams() ``` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:29`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:30`_ ### getSearchParams @@ -26,7 +26,7 @@ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:29`_ public CuVSIvfPqSearchParams getSearchParams() ``` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:37`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:38`_ ### getRefinementRate @@ -34,7 +34,7 @@ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:37`_ public float getRefinementRate() ``` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:45`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:46`_ ### withCuVSIvfPqIndexParams @@ -54,7 +54,7 @@ Sets the CuVS IVF_PQ index parameters. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:83`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:84`_ ### withCuVSIvfPqSearchParams @@ -74,7 +74,7 @@ Sets the CuVS IVF_PQ search parameters. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:94`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:95`_ ### withRefinementRate @@ -94,7 +94,7 @@ Sets the refinement rate, default 2.0. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:105`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:106`_ ### build @@ -108,6 +108,6 @@ Builds an instance of `CuVSIvfPqParams`. an instance of `CuVSIvfPqParams` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:115`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:116`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqParams.java:7`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsivfpqsearchparams.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsivfpqsearchparams.md index 71d600d983..af4a899050 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsivfpqsearchparams.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsivfpqsearchparams.md @@ -24,7 +24,7 @@ Gets the number of clusters to search the number of clusters to search -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:71`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:72`_ ### getLutDtype @@ -38,7 +38,7 @@ Gets the data type of look up table to be created dynamically at search time the data type of look up table to be created dynamically at search time -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:81`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:82`_ ### getInternalDistanceDtype @@ -52,7 +52,7 @@ Gets the storage data type for distance/similarity computed at search time the storage data type for distance/similarity computed at search time -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:90`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:91`_ ### getPreferredShmemCarveout @@ -67,7 +67,7 @@ shared memory the preferred fraction of SM's unified memory / L1 cache to be used as shared memory -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:101`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:102`_ ### withNProbes @@ -87,7 +87,7 @@ Sets the number of clusters to search. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:175`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:176`_ ### withLutDtype @@ -108,7 +108,7 @@ time. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:188`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:189`_ ### withInternalDistanceDtype @@ -128,7 +128,7 @@ Sets the storage data type for distance/similarity computed at search time. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:200`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:201`_ ### withPreferredShmemCarveout @@ -149,7 +149,7 @@ shared memory. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:213`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:214`_ ### build @@ -163,6 +163,6 @@ Builds an instance of `CuVSIvfPqSearchParams`. an instance of `CuVSIvfPqSearchParams` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:223`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:224`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:9`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsmatrix.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsmatrix.md index f07a620ffd..98619cad38 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsmatrix.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsmatrix.md @@ -26,7 +26,7 @@ static CuVSMatrix ofArray(float[][] vectors) Creates a dataset from an on-heap array of vectors. This method will allocate an additional MemorySegment to hold the graph data. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:47`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:48`_ ### ofArray @@ -37,7 +37,7 @@ static CuVSMatrix ofArray(int[][] vectors) Creates a dataset from an on-heap array of vectors. This method will allocate an additional MemorySegment to hold the graph data. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:57`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:58`_ ### ofArray @@ -48,7 +48,7 @@ static CuVSMatrix ofArray(byte[][] vectors) Creates a dataset from an on-heap array of vectors. This method will allocate an additional MemorySegment to hold the graph data. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:67`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:68`_ ### addVector @@ -64,7 +64,7 @@ Adds a single vector to the matrix. | --- | --- | | `vector` | A float array of as many elements as the dimensions | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:81`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:82`_ ### addVector @@ -80,7 +80,7 @@ Adds a single vector to the matrix. | --- | --- | | `vector` | A byte array of as many elements as the dimensions | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:88`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:89`_ ### addVector @@ -96,7 +96,7 @@ Adds a single vector to the matrix. | --- | --- | | `vector` | An int array of as many elements as the dimensions | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:95`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:96`_ ### addVector @@ -112,7 +112,7 @@ Adds a single vector to the matrix. Each element is a raw float16 bit pattern st | --- | --- | | `vector` | A short array of as many elements as the dimensions | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:102`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:103`_ ### build @@ -126,7 +126,7 @@ If this method fails, callers should close the builder. Built-in builders then r matrix storage allocated during builder construction; providers that inherit the default no-op `#close()` implementation do not. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:111`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:112`_ ### close @@ -141,7 +141,7 @@ The default implementation preserves compatibility with providers compiled befor builders became closeable. Builders that allocate storage before `#build()` should override this method. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:121`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:123`_ ### hostBuilder @@ -163,7 +163,7 @@ Returns a builder to create a new instance of a host-memory matrix a builder for creating a `CuVSHostMatrix` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:133`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:134`_ ### hostBuilder @@ -187,7 +187,7 @@ Returns a builder to create a new instance of a host-memory matrix a builder for creating a `CuVSDeviceMatrix` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:147`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:148`_ ### deviceBuilder @@ -210,7 +210,7 @@ Returns a builder to create a new instance of a dataset a builder for creating a `CuVSDeviceMatrix` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:162`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:163`_ ### deviceBuilder @@ -235,7 +235,7 @@ Returns a builder to create a new instance of a dataset a builder for creating a `CuVSDeviceMatrix` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:178`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:179`_ ### size @@ -249,7 +249,7 @@ Gets the size of the dataset Size of the dataset -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:194`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:195`_ ### columns @@ -264,7 +264,7 @@ or the graph degree for the graph represented as a list of neighbours Dimensions of the vectors in the dataset -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:202`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:203`_ ### dataType @@ -278,7 +278,7 @@ Gets the element type a `DataType` describing the matrix element type -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:209`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:210`_ ### getRow @@ -294,7 +294,7 @@ Get a view (0-copy) of the row data, as a list of integers (32 bit) | --- | --- | | `row` | the row for which to return the data | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:216`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:217`_ ### toArray @@ -310,7 +310,7 @@ Copies the content of this dataset to an on-heap Java matrix (array of arrays). | --- | --- | | `array` | the destination array. Must be of length `CuVSMatrix#size()` or bigger, and each element must be of length `CuVSMatrix#columns()` or bigger. | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:224`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:225`_ ### toArray @@ -326,7 +326,7 @@ Copies the content of this dataset to an on-heap Java matrix (array of arrays). | --- | --- | | `array` | the destination array. Must be of length `CuVSMatrix#size()` or bigger, and each element must be of length `CuVSMatrix#columns()` or bigger. | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:232`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:233`_ ### toArray @@ -342,7 +342,7 @@ Copies the content of this dataset to an on-heap Java matrix (array of arrays). | --- | --- | | `array` | the destination array. Must be of length `CuVSMatrix#size()` or bigger, and each element must be of length `CuVSMatrix#columns()` or bigger. | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:240`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:241`_ ### toHost @@ -360,7 +360,7 @@ same element type and dimension. | --- | --- | | `hostMatrix` | the host-memory-backed matrix to fill. | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:249`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:250`_ ### toHost @@ -374,7 +374,7 @@ the device matrix. The returned host matrix will need to be managed by the caller, which will be responsible to call `CuVSMatrix#close()` to free its resources when done. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:258`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:259`_ ### toDevice @@ -392,7 +392,7 @@ same element type and dimension. | --- | --- | | `deviceMatrix` | the device-memory-backed matrix to fill. | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:267`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:268`_ ### toDevice @@ -406,6 +406,6 @@ the host matrix. The returned device matrix will need to be managed by the caller, which will be responsible to call `CuVSMatrix#close()` to free its resources when done. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:276`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:277`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSMatrix.java:17`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsresources.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsresources.md index e9fcdb3a29..385f6e71f8 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsresources.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-cuvsresources.md @@ -26,7 +26,7 @@ Gets the opaque CuVSResources handle, to be used whenever we need to pass a cuvs the CuVSResources handle -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:26`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:27`_ ### access @@ -40,7 +40,7 @@ concurrently the same native resources. Calling this method from multiple thread returned `ScopedAccess` object must be closed before calling `access()` again from a different thread. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:39`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:40`_ ### deviceId @@ -52,7 +52,7 @@ Get the logical id of the device associated with this resources object. Information about the device id is immutable, so it is safe to expose it without getting `ScopedAccess` to the enclosing resources. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:46`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:47`_ ### close @@ -62,7 +62,7 @@ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:46`_ Closes this CuVSResources object and releases any resources associated with it. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:51`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:53`_ ### tempDirectory @@ -73,7 +73,7 @@ Path tempDirectory() The temporary directory to use for intermediate operations. Defaults to \{@systemProperty java.io.tmpdir\}. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:58`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:59`_ ### setWorkspacePool @@ -105,7 +105,7 @@ object; calling it again replaces the pool. | --- | --- | | `IllegalArgumentException` | if `initialSizeBytes` is not greater than 0 | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:78`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:79`_ ### create @@ -119,7 +119,7 @@ Equivalent to create(CuVSProvider.tempDirectory()) \} -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:87`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:88`_ ### create @@ -142,7 +142,7 @@ Creates a new resources. | `UnsupportedOperationException` | if the provider does not cuvs | | `LibraryException` | if the native library cannot be loaded | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:98`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:99`_ ### create @@ -176,6 +176,6 @@ global memory resources are restored when the handle is closed. | `UnsupportedOperationException` | if the provider does not support cuvs | | `LibraryException` | if the native library cannot be loaded | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:123`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:124`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSResources.java:16`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-filterbitsethandle.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-filterbitsethandle.md index 329f16085a..79315c4f9e 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-filterbitsethandle.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-filterbitsethandle.md @@ -51,7 +51,7 @@ otherwise touch its device allocation) must hold a reference for the duration of `true` if a reference was acquired; `false` if the handle has already been fully released, in which case no reference is acquired and it must not be used -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/FilterBitsetHandle.java:46`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/FilterBitsetHandle.java:47`_ ### decRef @@ -68,7 +68,7 @@ reference is released, the shared device allocation is freed. | --- | --- | | `IllegalStateException` | if called without a matching `#tryIncRef()` | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/FilterBitsetHandle.java:54`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/FilterBitsetHandle.java:55`_ ### create @@ -85,7 +85,7 @@ In a multi-partition search each partition supplies its own handle. | --- | --- | | `combinedLongs` | packed bitset words for a single partition | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/FilterBitsetHandle.java:62`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/FilterBitsetHandle.java:63`_ ### close @@ -98,6 +98,6 @@ of the owner's reference; the device allocation is freed once this and every ref via `#tryIncRef()` has been released. Idempotent — releasing the initial reference more than once has no effect. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/FilterBitsetHandle.java:72`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/FilterBitsetHandle.java:74`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/FilterBitsetHandle.java:37`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-gpuinfoprovider.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-gpuinfoprovider.md index 4a77bc3404..a4363262ec 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-gpuinfoprovider.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-gpuinfoprovider.md @@ -24,7 +24,7 @@ Gets all the available GPUs a list of `GPUInfo` objects with GPU details -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/GPUInfoProvider.java:20`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/GPUInfoProvider.java:21`_ ### compatibleGPUs @@ -39,7 +39,7 @@ memory >= 8GB a list of compatible GPUs. See `GPUInfo` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/GPUInfoProvider.java:28`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/GPUInfoProvider.java:29`_ ### getCurrentInfo @@ -59,6 +59,6 @@ Gets memory information relative to a `CuVSResources` a `CuVSResourcesInfo` record containing the memory information -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/GPUInfoProvider.java:35`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/GPUInfoProvider.java:36`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/GPUInfoProvider.java:9`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswaceparams.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswaceparams.md index a7c002e06d..ac178bf1ba 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswaceparams.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswaceparams.md @@ -30,7 +30,7 @@ Gets the number of partitions for ACE partitioned build. the number of partitions -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:41`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:42`_ ### getBuildDir @@ -44,7 +44,7 @@ Gets the directory to store ACE build artifacts. the build directory path -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:50`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:51`_ ### isUseDisk @@ -58,7 +58,7 @@ Gets whether disk-based storage is enabled for ACE build. true if disk mode is enabled -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:59`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:60`_ ### getMaxHostMemoryGb @@ -72,7 +72,7 @@ Gets the maximum host memory limit in GiB. the max host memory limit (0 means use available memory) -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:68`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:69`_ ### getMaxGpuMemoryGb @@ -86,7 +86,7 @@ Gets the maximum GPU memory limit in GiB. the max GPU memory limit (0 means use available memory) -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:77`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:78`_ ### Builder @@ -96,7 +96,7 @@ public Builder() Constructs this Builder. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:110`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:111`_ ### withNpartitions @@ -129,7 +129,7 @@ constraints and a warning will be issued. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:131`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:132`_ ### withBuildDir @@ -150,7 +150,7 @@ Used when useDisk is true or when the graph does not fit in memory. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:143`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:144`_ ### withUseDisk @@ -171,7 +171,7 @@ When true, enables disk-based operations for memory-efficient graph construction an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:155`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:156`_ ### withMaxHostMemoryGb @@ -194,7 +194,7 @@ Useful for testing or when running alongside other memory-intensive processes. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:169`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:170`_ ### withMaxGpuMemoryGb @@ -217,7 +217,7 @@ Useful for testing or when running alongside other memory-intensive processes. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:183`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:184`_ ### build @@ -231,6 +231,6 @@ Builds an instance of `HnswAceParams`. an instance of `HnswAceParams` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:193`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:194`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswAceParams.java:16`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswindex.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswindex.md index 338dfdb0b3..34f47baa6e 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswindex.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswindex.md @@ -23,7 +23,7 @@ with it. Invokes the native destroy_hnsw_index to de-allocate the HNSW index -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:21`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:23`_ ### search @@ -44,7 +44,7 @@ index. an instance of `SearchResults` containing the results -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:32`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:33`_ ### newBuilder @@ -66,7 +66,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/HnswIndex.java:40`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:41`_ ### fromCagra @@ -93,7 +93,7 @@ A new HNSW index | --- | --- | | `Throwable` | if an error occurs during conversion | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:53`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:54`_ ### build @@ -123,7 +123,7 @@ A new HNSW index ready for search | --- | --- | | `Throwable` | if an error occurs during building | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:70`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:71`_ ### from @@ -144,7 +144,7 @@ needed. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:90`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:91`_ ### withIndexParams @@ -165,7 +165,7 @@ Builder. An instance of this Builder. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:99`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:100`_ ### build @@ -179,6 +179,6 @@ Builds and returns an instance of CagraIndex. an instance of CagraIndex -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:106`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:107`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java:17`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswindexparams.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswindexparams.md index 7f0504b010..bbd5fc5d48 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswindexparams.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswindexparams.md @@ -22,7 +22,7 @@ NONE(0), /** * Full hierarchy is built using the CPU */ CPU(1), /** * Full hiera Flat hierarchy, search is base-layer only -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:38`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:39`_ ### CPU @@ -32,7 +32,7 @@ CPU(1), /** * Full hierarchy is built using the GPU */ GPU(2) Full hierarchy is built using the CPU -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:43`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:44`_ ### GPU @@ -42,7 +42,7 @@ GPU(2) Full hierarchy is built using the GPU -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:48`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:49`_ ### getHierarchy @@ -50,7 +50,7 @@ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:48`_ public CuvsHnswHierarchy getHierarchy() ``` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:98`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:99`_ ### getEfConstruction @@ -58,7 +58,7 @@ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:98`_ public int getEfConstruction() ``` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:106`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:107`_ ### getNumThreads @@ -66,7 +66,7 @@ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:106` public int getNumThreads() ``` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:114`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:115`_ ### getVectorDimension @@ -74,7 +74,7 @@ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:114` public int getVectorDimension() ``` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:122`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:123`_ ### getM @@ -89,7 +89,7 @@ used to derive the internal graph build parameters for GPU construction. the M parameter -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:132`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:133`_ ### getMetric @@ -103,7 +103,7 @@ Gets the distance metric type. the metric type -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:141`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:142`_ ### getAceParams @@ -118,7 +118,7 @@ graph build algorithm is selected automatically. the ACE parameters, or null if not set -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:151`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:152`_ ### Builder @@ -128,7 +128,7 @@ public Builder() Constructs this Builder with an instance of Arena. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:190`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:191`_ ### withHierarchy @@ -151,7 +151,7 @@ index. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:202`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:203`_ ### withEfConstruction @@ -171,7 +171,7 @@ Sets the maximum candidate list size used during index construction. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:213`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:214`_ ### withNumThreads @@ -192,7 +192,7 @@ is `CPU`. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:225`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:226`_ ### withVectorDimension @@ -212,7 +212,7 @@ Sets the vector dimension an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:236`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:237`_ ### withM @@ -233,7 +233,7 @@ graph build parameters for GPU construction. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:248`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:249`_ ### withMetric @@ -253,7 +253,7 @@ Sets the distance metric type. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:259`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:260`_ ### withAceParams @@ -274,7 +274,7 @@ graph build algorithm is selected automatically. an instance of Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:271`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:272`_ ### build @@ -288,6 +288,6 @@ Builds an instance of `HnswIndexParams`. an instance of `HnswIndexParams` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:281`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:282`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:12`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswquery.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswquery.md index dd9f545b26..883eb8f09d 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswquery.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswquery.md @@ -31,7 +31,7 @@ Gets the instance of HnswSearchParams. the instance of `HnswSearchParams` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:56`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:57`_ ### getQueryVectors @@ -45,7 +45,7 @@ Gets the query vector 2D float array. 2D float array -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:65`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:66`_ ### getMapping @@ -55,7 +55,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/HnswQuery.java:72`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:73`_ ### getTopK @@ -69,7 +69,7 @@ Gets the topK value. an integer -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:81`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:82`_ ### getResources @@ -83,7 +83,7 @@ Gets the CuVSResources instance for this query. the CuVSResources instance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:90`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:91`_ ### Builder @@ -103,7 +103,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/HnswQuery.java:125`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:126`_ ### withSearchParams @@ -123,7 +123,7 @@ Sets the instance of configured HnswSearchParams to be passed for search. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:136`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:137`_ ### withQueryVectors @@ -143,7 +143,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/HnswQuery.java:147`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:148`_ ### withMapping @@ -163,7 +163,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/HnswQuery.java:158`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:159`_ ### withTopK @@ -183,7 +183,7 @@ Registers the topK value. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:169`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:170`_ ### build @@ -197,6 +197,6 @@ Builds an instance of `HnswQuery` an instance of `HnswQuery` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:179`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:180`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswQuery.java:21`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswsearchparams.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswsearchparams.md index 5fea6b1277..f281d56aa0 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswsearchparams.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-hnswsearchparams.md @@ -30,7 +30,7 @@ public Builder() Constructs this Builder with an instance of Arena. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswSearchParams.java:39`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswSearchParams.java:40`_ ### withEF @@ -50,7 +50,7 @@ Sets the ef value an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswSearchParams.java:47`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswSearchParams.java:48`_ ### withNumThreads @@ -70,7 +70,7 @@ Sets the number of threads an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswSearchParams.java:58`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswSearchParams.java:59`_ ### build @@ -84,6 +84,6 @@ Builds an instance of `HnswSearchParams` with passed search parameters. an instance of HnswSearchParams -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswSearchParams.java:68`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswSearchParams.java:69`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswSearchParams.java:15`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-multipartitioncagrasearch.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-multipartitioncagrasearch.md index 237103b35a..0ee7e130d3 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-multipartitioncagrasearch.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-multipartitioncagrasearch.md @@ -37,7 +37,7 @@ Searches multiple CAGRA index partitions for the global top-k nearest neighbors. | `query` | a single `CagraQuery` whose query matrix is searched against every partition; its search parameters are shared across all partitions | | `k` | number of global nearest neighbors to return per query | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/MultiPartitionCagraSearch.java:33`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/MultiPartitionCagraSearch.java:34`_ ### search @@ -57,6 +57,6 @@ Searches multiple CAGRA index partitions with optional per-partition device-side | `k` | number of global nearest neighbors to return per query | | `filters` | one filter per partition, in the same order as `indices`, or `null`/empty for a fully unfiltered search. When non-null, its size must equal `indices.size()`; a `null` entry means no filter for that partition. Each handle must be obtained from `FilterBitsetHandle#create(long[])` for that partition's packed bitset; handles from other sources are not supported. | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/MultiPartitionCagraSearch.java:53`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/MultiPartitionCagraSearch.java:54`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/MultiPartitionCagraSearch.java:21`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-multipartitionsearchresults.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-multipartitionsearchresults.md index 5f16df9a02..0156d82985 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-multipartitionsearchresults.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-multipartitionsearchresults.md @@ -31,7 +31,7 @@ public int count() Number of valid results (may be less than k if fewer candidates exist). -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/MultiPartitionSearchResults.java:36`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/MultiPartitionSearchResults.java:37`_ ### getPartitionIndex @@ -41,7 +41,7 @@ public int getPartitionIndex(int i) Index into the original partition list for result `i`. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/MultiPartitionSearchResults.java:41`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/MultiPartitionSearchResults.java:42`_ ### getOrdinal @@ -51,7 +51,7 @@ public int getOrdinal(int i) Local vector ordinal within the partition for result `i`. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/MultiPartitionSearchResults.java:46`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/MultiPartitionSearchResults.java:47`_ ### getDistance @@ -61,6 +61,6 @@ public float getDistance(int i) Post-processed distance for result `i` (scaled + metric-transformed). -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/MultiPartitionSearchResults.java:51`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/MultiPartitionSearchResults.java:52`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/MultiPartitionSearchResults.java:21`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-rowview.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-rowview.md index b75ef47922..0febba984e 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-rowview.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-rowview.md @@ -30,7 +30,7 @@ data type of the dataset on top of which this view is instantiates is | --- | --- | | `index` | the element index | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/RowView.java:22`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/RowView.java:23`_ ### getAsFloat @@ -48,7 +48,7 @@ data type of the dataset on top of which this view is instantiates is | --- | --- | | `index` | the element index | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/RowView.java:31`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/RowView.java:32`_ ### getAsByte @@ -66,7 +66,7 @@ data type of the dataset on top of which this view is instantiates is | --- | --- | | `index` | the element index | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/RowView.java:40`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/RowView.java:41`_ ### toArray @@ -82,7 +82,7 @@ Copies the content of this row to an on-heap Java array. | --- | --- | | `array` | the destination array. Must be of length `RowView#size()` or bigger. | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/RowView.java:47`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/RowView.java:48`_ ### toArray @@ -98,7 +98,7 @@ Copies the content of this row to an on-heap Java array. | --- | --- | | `array` | the destination array. Must be of length `RowView#size()` or bigger. | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/RowView.java:54`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/RowView.java:55`_ ### toArray @@ -114,6 +114,6 @@ Copies the content of this row to an on-heap Java array. | --- | --- | | `array` | the destination array. Must be of length `RowView#size()` or bigger. | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/RowView.java:61`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/RowView.java:62`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/RowView.java:12`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-searchresults.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-searchresults.md index 41a323e123..6897b25f4b 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-searchresults.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-searchresults.md @@ -30,7 +30,7 @@ Creates a mapping function from a list lookup of custom user IDs a function that maps the input ordinal to a custom user IDs, using the input as an index in the list -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/SearchResults.java:22`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/SearchResults.java:23`_ ### getResults @@ -44,6 +44,6 @@ Gets a list results as a map of neighbor IDs to distances. a list of results for each query as a map of neighbor IDs to distance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/SearchResults.java:31`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/SearchResults.java:32`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/SearchResults.java:11`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-spi-cuvsprovider.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-spi-cuvsprovider.md index 6230de4ee7..32a4396e7c 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-spi-cuvsprovider.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-spi-cuvsprovider.md @@ -23,7 +23,7 @@ static Path tempDirectory() The temporary directory to use for intermediate operations. Defaults to \{@systemProperty java.io.tmpdir\}. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:25`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:26`_ ### nativeLibraryPath @@ -34,7 +34,7 @@ default Path nativeLibraryPath() The directory where to extract and install the native library. Defaults to \{@systemProperty java.io.tmpdir\}. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:33`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:34`_ ### newCuVSResources @@ -44,7 +44,7 @@ CuVSResources newCuVSResources(Path tempDirectory) throws Throwable Creates a new CuVSResources. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:38`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:39`_ ### newCuVSResources @@ -69,7 +69,7 @@ opt in. | `memoryTrackingCsvPath` | path to the output CSV file (created/truncated) | | `memoryTrackingSampleInterval` | minimum interval between successive CSV samples | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:57`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:58`_ ### newHostMatrixBuilder @@ -79,7 +79,7 @@ CuVSMatrix.Builder newHostMatrixBuilder( long size, long dimensi Create a `CuVSMatrix.Builder` instance for a host memory matrix * -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:65`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:66`_ ### newHostMatrixBuilder @@ -89,7 +89,7 @@ CuVSMatrix.Builder newHostMatrixBuilder( long size, long columns Create a `CuVSMatrix.Builder` instance for a host memory matrix * -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:69`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:70`_ ### newDeviceMatrixBuilder @@ -99,7 +99,7 @@ CuVSMatrix.Builder newDeviceMatrixBuilder( CuVSResources cuVSR Create a `CuVSMatrix.Builder` instance for a device memory matrix * -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:73`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:74`_ ### newDeviceMatrixBuilder @@ -109,7 +109,7 @@ CuVSMatrix.Builder newDeviceMatrixBuilder( CuVSResources cuVSR Create a `CuVSMatrix.Builder` instance for a device memory matrix * -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:77`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:78`_ ### newNativeMatrixBuilder @@ -133,7 +133,7 @@ The caller will need to invoke the factory via the `MethodHandle#invokeExact` me a MethodHandle which can be invoked to build a CuVSMatrix from an external `MemorySegment` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:100`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:101`_ ### newNativeMatrixBuilderWithStrides @@ -159,7 +159,7 @@ The caller will need to invoke the factory via the `MethodHandle#invokeExact` me a MethodHandle which can be invoked to build a CuVSMatrix from an external `MemorySegment` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:119`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:120`_ ### newMatrixFromArray @@ -169,7 +169,7 @@ CuVSMatrix newMatrixFromArray(float[][] vectors) Create a `CuVSMatrix` from an on-heap array * -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:122`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:123`_ ### newMatrixFromArray @@ -179,7 +179,7 @@ CuVSMatrix newMatrixFromArray(int[][] vectors) Create a `CuVSMatrix` from an on-heap array * -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:125`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:126`_ ### newMatrixFromArray @@ -189,7 +189,7 @@ CuVSMatrix newMatrixFromArray(byte[][] vectors) Create a `CuVSMatrix` from an on-heap array * -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:128`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:129`_ ### newBruteForceIndexBuilder @@ -199,7 +199,7 @@ BruteForceIndex.Builder newBruteForceIndexBuilder(CuVSResources cuVSResources) t Creates a new BruteForceIndex Builder. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:131`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:132`_ ### newCagraIndexBuilder @@ -209,7 +209,7 @@ CagraIndex.Builder newCagraIndexBuilder(CuVSResources cuVSResources) throws Unsu Creates a new CagraIndex Builder. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:135`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:136`_ ### newVamanaIndexBuilder @@ -219,7 +219,7 @@ VamanaIndex.Builder newVamanaIndexBuilder(CuVSResources cuVSResources) throws Un Creates a new VamanaIndex Builder. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:139`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:140`_ ### newHnswIndexBuilder @@ -229,7 +229,7 @@ HnswIndex.Builder newHnswIndexBuilder(CuVSResources cuVSResources) throws Unsupp Creates a new HnswIndex Builder. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:143`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:144`_ ### hnswIndexFromCagra @@ -256,7 +256,7 @@ A new HNSW index | --- | --- | | `Throwable` | if an error occurs during conversion | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:154`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:155`_ ### hnswIndexBuild @@ -284,7 +284,7 @@ A new HNSW index ready for search | --- | --- | | `Throwable` | if an error occurs during building | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:165`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:166`_ ### newTieredIndexBuilder @@ -294,7 +294,7 @@ TieredIndex.Builder newTieredIndexBuilder(CuVSResources cuVSResources) throws Un Creates a new TieredIndex Builder. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:169`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:170`_ ### isCagraPaddedDataset @@ -327,7 +327,7 @@ true when the rows are already padded the way CAGRA requires | --- | --- | | `UnsupportedOperationException` | if this provider cannot answer | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:186`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:187`_ ### mergeCagraIndexes @@ -357,7 +357,7 @@ A new merged CAGRA index | --- | --- | | `Throwable` | if an error occurs during the merge operation | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:202`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:203`_ ### newFilterBitsetHandle @@ -374,7 +374,7 @@ Per-partition bit offsets are recomputed inside cuVS from the index sizes. | --- | --- | | `combinedLongs` | packed bitset words for a single partition | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:211`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:212`_ ### searchCagraMultiPartition @@ -400,7 +400,7 @@ Searches multiple CAGRA index partitions for the global top-k nearest neighbors | --- | --- | | `Throwable` | if an error occurs during the search | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:224`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:225`_ ### gpuInfoProvider @@ -410,7 +410,7 @@ GPUInfoProvider gpuInfoProvider() Returns a `GPUInfoProvider` to query the system for GPU related information -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:233`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:234`_ ### enableRMMPooledMemory @@ -429,7 +429,7 @@ This operation has a global effect, and will affect all resources on the current | `initialPoolSizePercent` | The initial pool size, in percentage of the total GPU memory | | `maxPoolSizePercent` | The maximum pool size, in percentage of the total GPU memory | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:247`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:248`_ ### enableRMMManagedPooledMemory @@ -448,7 +448,7 @@ This operation has a global effect, and will affect all resources on the current | `initialPoolSizePercent` | The initial pool size, in percentage of the total GPU memory | | `maxPoolSizePercent` | The maximum pool size, in percentage of the total GPU memory | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:257`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:258`_ ### enableRMMAsyncMemory @@ -463,7 +463,7 @@ on deallocation. This is especially beneficial when multiple CAGRA searches run on separate CUDA streams, because internal workspace allocations no longer serialize kernel launches. This operation has a global effect and will affect all resources on the current device. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:267`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:268`_ ### resetRMMPooledMemory @@ -473,7 +473,7 @@ void resetRMMPooledMemory() Disables pooled memory on the current device, reverting back to the default setting. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:270`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:271`_ ### provider @@ -483,7 +483,7 @@ static CuVSProvider provider() Retrieves the system-wide provider. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:273`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:274`_ ### cagraIndexParamsFromHnswParams @@ -513,7 +513,7 @@ may be shifted along the curve right or left. See the heuristics descriptions fo A new CAGRA index parameters object -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:293`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:294`_ ### cagraIndexParamsFromDataset @@ -537,6 +537,6 @@ Create CAGRA index parameters heuristically tuned for a dataset. A new CAGRA index parameters object -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:311`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:312`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:18`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-spi-cuvsserviceprovider.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-spi-cuvsserviceprovider.md index ac032739d0..52adbab242 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-spi-cuvsserviceprovider.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-spi-cuvsserviceprovider.md @@ -32,6 +32,6 @@ Initialize and return an `CuVSProvider` provided by this provider. the CuVSProvider provided by this provider -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSServiceProvider.java:22`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSServiceProvider.java:23`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSServiceProvider.java:16`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-tieredindex.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-tieredindex.md index ae36870257..c2873b1e05 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-tieredindex.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-tieredindex.md @@ -30,7 +30,7 @@ resources. | --- | --- | | `Exception` | if an error occurs during index destruction | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:22`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:24`_ ### search @@ -56,7 +56,7 @@ An instance of `SearchResults` containing the k-nearest neighbors and their dist | --- | --- | | `Throwable` | if an error occurs during the search operation | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:34`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:35`_ ### getIndexType @@ -70,7 +70,7 @@ Returns the algorithm type backing this TieredIndex. The `TieredIndexType` indicating the underlying algorithm (e.g., CAGRA) -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:42`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:43`_ ### getCuVSResources @@ -84,7 +84,7 @@ Returns the resources handle associated with this TieredIndex. The `CuVSResources` instance used by this index -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:49`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:50`_ ### newBuilder @@ -110,7 +110,7 @@ A new `Builder` instance for constructing a TieredIndex | --- | --- | | `NullPointerException` | if cuvsResources is null | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:58`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:59`_ ### extend @@ -124,7 +124,7 @@ Returns an ExtendBuilder to add new data to the existing index. An `ExtendBuilder` instance for extending the index -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:68`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:69`_ ### from @@ -148,7 +148,7 @@ This Builder instance for method chaining | --- | --- | | `UnsupportedOperationException` | as deserialization is not yet supported | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:82`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:83`_ ### withDataset @@ -168,7 +168,7 @@ Sets the dataset vectors for building the TieredIndex. This Builder instance for method chaining -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:91`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:92`_ ### withDataset @@ -188,7 +188,7 @@ Sets the dataset for building the TieredIndex. This Builder instance for method chaining -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:99`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:100`_ ### withIndexParams @@ -208,7 +208,7 @@ Registers TieredIndex parameters with this Builder. This Builder instance for method chaining -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:108`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:109`_ ### withIndexType @@ -228,7 +228,7 @@ Sets the index type for the TieredIndex. This Builder instance for method chaining -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:117`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:118`_ ### build @@ -250,7 +250,7 @@ A new `TieredIndex` instance | `Throwable` | if an error occurs during index construction | | `IllegalArgumentException` | if both vectors and dataset are provided, or if required parameters are missing | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:129`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:130`_ ### withDataset @@ -270,7 +270,7 @@ Sets the vectors to add to the existing index. This ExtendBuilder instance for method chaining -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:152`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:153`_ ### withDataset @@ -290,7 +290,7 @@ Sets the dataset to add to the existing index. This ExtendBuilder instance for method chaining -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:161`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:162`_ ### execute @@ -307,6 +307,6 @@ Executes the extend operation, adding the specified data to the index. | `Throwable` | if an error occurs during the extend operation | | `IllegalArgumentException` | if both vectors and dataset are provided, or if no data is provided | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:171`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:172`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:15`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-tieredindexparams.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-tieredindexparams.md index 2ac397acc4..4d371de35e 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-tieredindexparams.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-tieredindexparams.md @@ -23,7 +23,7 @@ L2, /** Inner product (cosine similarity) distance metric */ INNER_PRODUCT } pri L2 (Euclidean) distance metric -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:20`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:21`_ ### getMetric @@ -37,7 +37,7 @@ Returns the distance metric used for similarity computation. The `Metric` (L2 or Inner Product) -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:47`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:48`_ ### getMinAnnRows @@ -51,7 +51,7 @@ Returns the minimum number of rows required to use the ANN algorithm. The minimum row count threshold for ANN algorithm usage -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:56`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:57`_ ### isCreateAnnIndexOnExtend @@ -65,7 +65,7 @@ Returns whether to create an ANN index when extending the dataset. true if ANN index should be created on extend, false otherwise -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:65`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:66`_ ### getCagraParams @@ -79,7 +79,7 @@ Returns the CAGRA-specific parameters for the ANN algorithm. The `CagraIndexParams` configuration, or null if not using CAGRA -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:75`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:76`_ ### newBuilder @@ -93,7 +93,7 @@ Creates a new Builder for constructing TieredIndexParams. A new Builder instance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:84`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:85`_ ### metric @@ -119,7 +119,7 @@ This Builder instance for method chaining | --- | --- | | `NullPointerException` | if metric is null | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:104`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:105`_ ### minAnnRows @@ -145,7 +145,7 @@ This Builder instance for method chaining | --- | --- | | `IllegalArgumentException` | if minAnnRows is not positive | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:116`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:117`_ ### createAnnIndexOnExtend @@ -165,7 +165,7 @@ Sets whether to create an ANN index when extending the dataset. This Builder instance for method chaining -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:130`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:131`_ ### withCagraParams @@ -191,7 +191,7 @@ This Builder instance for method chaining | --- | --- | | `NullPointerException` | if params is null | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:143`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:144`_ ### build @@ -212,6 +212,6 @@ A new TieredIndexParams instance | --- | --- | | `IllegalStateException` | if CAGRA params are required but not provided | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:156`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:157`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:14`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-tieredindexquery.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-tieredindexquery.md index 42be99ccda..1f5d7787cb 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-tieredindexquery.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-tieredindexquery.md @@ -31,7 +31,7 @@ Gets the index type for this query. the TieredIndexType -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:57`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:58`_ ### getCagraSearchParameters @@ -45,7 +45,7 @@ Gets the instance of CagraSearchParams initially set. an instance CagraSearchParams -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:66`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:67`_ ### getQueryVectors @@ -59,7 +59,7 @@ Gets the query vector 2D float array. 2D float array -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:75`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:76`_ ### getMapping @@ -73,7 +73,7 @@ Gets the passed map instance. a map of ID mappings -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:84`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:85`_ ### getTopK @@ -87,7 +87,7 @@ Gets the topK value. the topK value -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:93`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:94`_ ### getPrefilter @@ -101,7 +101,7 @@ Gets the prefilter BitSet. a BitSet object representing the prefilter -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:102`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:103`_ ### getNumDocs @@ -115,7 +115,7 @@ Gets the number of documents in this index, as used for prefilter. number of documents as an integer -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:111`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:112`_ ### getResources @@ -129,7 +129,7 @@ Gets the CuVSResources instance for this query. the CuVSResources instance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:120`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:121`_ ### newBuilder @@ -149,7 +149,7 @@ Creates a new Builder instance. a new Builder instance -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:145`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:146`_ ### Builder @@ -169,7 +169,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/TieredIndexQuery.java:171`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:172`_ ### withIndexType @@ -189,7 +189,7 @@ Sets the index type for this query. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:181`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:182`_ ### withSearchParams @@ -209,7 +209,7 @@ Sets the instance of configured CagraSearchParams to be passed for search. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:193`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:194`_ ### withQueryVectors @@ -229,7 +229,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/TieredIndexQuery.java:204`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:205`_ ### withMapping @@ -249,7 +249,7 @@ Sets the instance of mapping to be used for ID mapping. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:215`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:216`_ ### withTopK @@ -269,7 +269,7 @@ Registers the topK value. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:226`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:227`_ ### withPrefilter @@ -290,7 +290,7 @@ Sets a BitSet to use as prefilter while searching. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:239`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:240`_ ### build @@ -310,6 +310,6 @@ an instance of TieredIndexQuery | --- | --- | | `IllegalStateException` | if required parameters are missing | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:251`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:252`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexQuery.java:23`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-vamanaindex.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-vamanaindex.md index 22fa850fe4..2299ad1664 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-vamanaindex.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-vamanaindex.md @@ -31,7 +31,7 @@ Gets the dimensionality of the vectors in this index. the number of dimensions -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:30`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:31`_ ### serialize @@ -50,7 +50,7 @@ This writes two files, `filePrefix` holding the graph and | --- | --- | | `filePrefix` | the prefix that output file names are derived from | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:40`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:41`_ ### serialize @@ -74,7 +74,7 @@ The argument is a prefix and not a complete file name, matching the native | `filePrefix` | the prefix that output file names are derived from | | `includeDataset` | whether to write the dataset alongside the graph | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:57`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:58`_ ### getCuVSResources @@ -88,7 +88,7 @@ Gets an instance of `CuVSResources` an instance of `CuVSResources` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:64`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:65`_ ### newBuilder @@ -110,7 +110,7 @@ Creates a new Builder with an instance of `CuVSResources`. | --- | --- | | `UnsupportedOperationException` | if the provider does not support cuvs | -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:72`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:73`_ ### withDataset @@ -130,7 +130,7 @@ Sets the dataset for building the `VamanaIndex`. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:88`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:89`_ ### withDataset @@ -161,7 +161,7 @@ a `float[][]` is created and closed by the index instead. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:107`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:108`_ ### withIndexParams @@ -182,7 +182,7 @@ Builder. An instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:116`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:117`_ ### build @@ -196,6 +196,6 @@ Builds and returns an instance of `VamanaIndex`. an instance of `VamanaIndex` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:123`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:124`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndex.java:21`_ diff --git a/fern/pages/java_api/java-api-com-nvidia-cuvs-vamanaindexparams.md b/fern/pages/java_api/java-api-com-nvidia-cuvs-vamanaindexparams.md index c3e7d8a9f5..edd34a8d82 100644 --- a/fern/pages/java_api/java-api-com-nvidia-cuvs-vamanaindexparams.md +++ b/fern/pages/java_api/java-api-com-nvidia-cuvs-vamanaindexparams.md @@ -29,7 +29,7 @@ Returns the graph degrees the native Vamana builder supports. a copy of the supported graph degrees, in ascending order -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:30`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:31`_ ### L2Expanded @@ -39,7 +39,7 @@ L2Expanded(0), /** * Euclidean, the square root of Squared L2. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:45`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:46`_ ### L2SqrtExpanded @@ -49,7 +49,7 @@ L2SqrtExpanded(1) Euclidean, the square root of `#L2Expanded`. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:50`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:51`_ ### getGraphDegree @@ -60,7 +60,7 @@ public int getGraphDegree() Gets the maximum degree of the output graph, the R parameter in the Vamana literature. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:97`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:98`_ ### getVisitedSize @@ -71,7 +71,7 @@ public int getVisitedSize() Gets the maximum number of visited nodes per search, the L parameter in the Vamana literature. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:105`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:106`_ ### getVamanaIters @@ -81,7 +81,7 @@ public float getVamanaIters() Gets the number of Vamana vector insertion iterations. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:112`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:113`_ ### getAlpha @@ -91,7 +91,7 @@ public float getAlpha() Gets the alpha pruning parameter. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:119`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:120`_ ### getMaxFraction @@ -101,7 +101,7 @@ public float getMaxFraction() Gets the maximum fraction of the dataset inserted per batch. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:126`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:127`_ ### getBatchBase @@ -111,7 +111,7 @@ public float getBatchBase() Gets the growth rate base for batch sizes. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:133`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:134`_ ### getQueueSize @@ -121,7 +121,7 @@ public int getQueueSize() Gets the candidate queue size. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:140`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:141`_ ### getReverseBatchSize @@ -131,7 +131,7 @@ public int getReverseBatchSize() Gets the maximum batch size of reverse edge processing. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:147`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:148`_ ### getMetric @@ -141,7 +141,7 @@ public CuvsDistanceType getMetric() Gets the distance metric. -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:154`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:155`_ ### withGraphDegree @@ -161,7 +161,7 @@ Sets the maximum degree of the output graph. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:205`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:206`_ ### withVisitedSize @@ -183,7 +183,7 @@ The native builder requires this to be greater than the graph degree. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:218`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:219`_ ### withVamanaIters @@ -203,7 +203,7 @@ Sets the number of Vamana vector insertion iterations. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:229`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:230`_ ### withAlpha @@ -223,7 +223,7 @@ Sets the alpha pruning parameter. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:240`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:241`_ ### withMaxFraction @@ -244,7 +244,7 @@ batch decreases graph quality but improves build speed. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:252`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:253`_ ### withBatchBase @@ -264,7 +264,7 @@ Sets the growth rate base for batch sizes. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:263`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:264`_ ### withQueueSize @@ -285,7 +285,7 @@ form `(2^x) - 1`. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:275`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:276`_ ### withReverseBatchSize @@ -306,7 +306,7 @@ memory footprint of that stage. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:287`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:288`_ ### withMetric @@ -326,7 +326,7 @@ Sets the distance metric. an instance of this Builder -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:298`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:299`_ ### build @@ -340,6 +340,6 @@ Builds an instance of `VamanaIndexParams`. an instance of `VamanaIndexParams` -_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:308`_ +_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:309`_ _Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/VamanaIndexParams.java:18`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-acceleratedhnswparams.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-acceleratedhnswparams.md index c37fbca409..ea722e6eda 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-acceleratedhnswparams.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-acceleratedhnswparams.md @@ -24,7 +24,7 @@ Get the cuVS writer threads parameter cuVS writer threads parameter -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:146`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:147`_ ### getIntermediateGraphDegree @@ -38,7 +38,7 @@ Get the intermediate graph degree the graph degree parameter -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:155`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:156`_ ### getGraphdegree @@ -52,7 +52,7 @@ Get the graph degree the graph degree parameter -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:164`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:165`_ ### getHnswLayers @@ -66,7 +66,7 @@ Get the number of HNSW layers the number of HNSW layers -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:173`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:174`_ ### getMaxConn @@ -80,7 +80,7 @@ Get the max connection parameter the max connection parameter -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:182`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:183`_ ### getBeamWidth @@ -94,7 +94,7 @@ Get the beam width parameter the beam width parameter -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:191`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:192`_ ### getCagraGraphBuildAlgo @@ -108,7 +108,7 @@ Get the CAGRA graph build algorithm the CAGRA graph build algorithm -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:200`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:201`_ ### getCuVSIvfPqParams @@ -122,7 +122,7 @@ Get the instance of `CuVSIvfPqParams` the instance of `CuVSIvfPqParams` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:209`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:210`_ ### getNumMergeWorkers @@ -136,7 +136,7 @@ Get the number of merge workers set to be used in the fallback mechanism the number of merge workers -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:218`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:219`_ ### getMergeExec @@ -150,7 +150,7 @@ Get the instance of the `ExecutorService` to be used in the fallback mechanism the instance of the `ExecutorService` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:227`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:228`_ ### getStrategy @@ -167,7 +167,7 @@ When CUSTOM is chosen, the build algorithm and its parameters (either defaults o get the chosen `Strategy` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:239`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:240`_ ### getCuvsDistanceType @@ -181,7 +181,7 @@ Get the cuvs distance type the distance type -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:248`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:249`_ ### getNNDescentNumIterations @@ -195,7 +195,7 @@ get the number of Iterations to run if building with NN_DESCENT the number of iterations for NN_DESCENT -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:257`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:258`_ ### getHnswHeuristicType @@ -210,7 +210,7 @@ beamWidth. Only consulted under the `Strategy#HEURISTIC` strategy. the `HnswHeuristicType` to hand to cuVS -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:267`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:268`_ ### withWriterThreads @@ -232,7 +232,7 @@ Default value - \{@value DEFAULT_WRITER_THREADS\} instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:332`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:333`_ ### withIntermediateGraphDegree @@ -254,7 +254,7 @@ Default value - \{@value DEFAULT_INT_GRAPH_DEGREE\} instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:345`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:346`_ ### withGraphDegree @@ -276,7 +276,7 @@ Default value - \{@value DEFAULT_GRAPH_DEGREE\} instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:358`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:359`_ ### withHNSWLayer @@ -298,7 +298,7 @@ Default value - \{@value DEFAULT_HNSW_LAYERS\} instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:371`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:372`_ ### withMaxConn @@ -320,7 +320,7 @@ Default value - \{@value DEFAULT_MAX_CONN\} instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:384`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:385`_ ### withBeamWidth @@ -342,7 +342,7 @@ Default value - \{@value DEFAULT_BEAM_WIDTH\} instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:397`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:398`_ ### withCagraGraphBuildAlgo @@ -363,7 +363,7 @@ Default value - NN_DESCENT instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:409`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:410`_ ### withCuVSIvfPqParams @@ -383,7 +383,7 @@ Set the instance of `CuVSIvfPqParams` instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:420`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:421`_ ### withNumMergeWorkers @@ -404,7 +404,7 @@ Default value - \{@value DEFAULT_NUM_MERGE_WORKERS\} instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:432`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:433`_ ### withMergeExecutorService @@ -425,7 +425,7 @@ Default value an instance with one thread instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:444`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:445`_ ### withStrategy @@ -451,7 +451,7 @@ Default value - HEURISTIC instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:461`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:462`_ ### withCuvsDistanceType @@ -471,7 +471,7 @@ Set the CuvsDistanceType instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:472`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:473`_ ### withNNDescentNumIterations @@ -494,7 +494,7 @@ Default value - \{@value DEFAULT_NN_DESCENT_NUM_ITERATIONS\} instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:486`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:487`_ ### withHnswHeuristicType @@ -518,7 +518,7 @@ the equivalent HNSW graph (graph degree = 2 * maxConn). instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:501`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:502`_ ### build @@ -532,6 +532,6 @@ Create an instance of `AcceleratedHNSWParams` instance of `AcceleratedHNSWParams` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:546`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:547`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWParams.java:17`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-acceleratedhnswutils.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-acceleratedhnswutils.md index aa65c2cf30..bcb0ad0430 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-acceleratedhnswutils.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-acceleratedhnswutils.md @@ -21,7 +21,7 @@ public static GPUBuiltHnswGraph createSingleVectorHnswGraph(int size, int dimens Creates a dummy HNSW graph for a single vector. The graph will have 1 level with 1 node and no neighbors. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:55`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:56`_ ### createMultiLayerHnswGraph @@ -33,7 +33,7 @@ Creates up to `hnswLayers` total layers. Layer 0 uses the full CAGRA graph. Each layer samples `max(2, floor(previousLayerSize / M))` nodes. The value `M` is the ceiling of half the layer-0 graph degree. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:73`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:74`_ ### createMultiLayerHnswGraph @@ -44,7 +44,7 @@ static GPUBuiltHnswGraph createMultiLayerHnswGraph( int dimensions, CuVSMatrix a Creates a multi-layer HNSW graph from a native matrix without copying the complete dataset to the Java heap. The list view copies only rows selected for an upper layer. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:204`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:205`_ ### writeGraph @@ -71,7 +71,7 @@ a 2D array of offsets | --- | --- | | `IOException` | I/O Exceptions | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:333`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:334`_ ### writeMeta @@ -100,7 +100,7 @@ Writes the meta information for the index. | --- | --- | | `IOException` | I/O Exceptions | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:398`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:399`_ ### printInfoStream @@ -116,7 +116,7 @@ A utility method to print info/debugging messages using InfoStream. | --- | --- | | `msg` | the debugging message to print | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:480`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:481`_ ### writeEmpty @@ -138,7 +138,7 @@ Writes an empty meta information for the field. | --- | --- | | `IOException` | I/O Exceptions | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:492`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:493`_ ### quantizeFloatVectorsToBinary @@ -161,7 +161,7 @@ Bits are packed: 8 dimensions per byte. A list of byte binary representation for the input vectors -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:505`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:506`_ ### quantizeFloatVectorsToScalar @@ -181,6 +181,6 @@ Scalar quantization. A list of byte scalar representation for the input vectors -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:547`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:548`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/AcceleratedHNSWUtils.java:32`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cagraindexparamsfactory.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cagraindexparamsfactory.md index e6b3445de6..cc932d20b4 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cagraindexparamsfactory.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cagraindexparamsfactory.md @@ -38,7 +38,7 @@ chosen strategy in the `GPUSearchParams`. an instance of `CagraIndexParams` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CagraIndexParamsFactory.java:29`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CagraIndexParamsFactory.java:30`_ ### create @@ -61,6 +61,6 @@ chosen strategy in the `AcceleratedHNSWParams`. an instance of `CagraIndexParams` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CagraIndexParamsFactory.java:73`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CagraIndexParamsFactory.java:74`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CagraIndexParamsFactory.java:17`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpusearchcodec.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpusearchcodec.md index c7120dc9d4..7e00904702 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpusearchcodec.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpusearchcodec.md @@ -29,7 +29,7 @@ Default constructor for `CuVS2510GPUSearchCodec`. | --- | --- | | `Exception` | | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUSearchCodec.java:30`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUSearchCodec.java:31`_ ### CuVS2510GPUSearchCodec @@ -47,7 +47,7 @@ having default parameter values. | `name` | the name of the codec | | `delegate` | the delegate codec | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUSearchCodec.java:45`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUSearchCodec.java:46`_ ### CuVS2510GPUSearchCodec @@ -70,7 +70,7 @@ or overridden parameter values. | --- | --- | | `Exception` | Exception raised when initializing the codec | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUSearchCodec.java:56`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUSearchCodec.java:57`_ ### CuVS2510GPUSearchCodec @@ -93,7 +93,7 @@ Initialize the codec with GPU search and filter-bitset-cache parameters. | --- | --- | | `Exception` | Exception raised when initializing the codec | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUSearchCodec.java:67`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUSearchCodec.java:68`_ ### CuVS2510GPUSearchCodec @@ -112,7 +112,7 @@ Initialize a named codec with explicit delegate, GPU search, and filter-cache pa | `params` | GPU index and search parameters | | `filterCacheConfig` | filter-bitset-cache configuration | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUSearchCodec.java:80`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUSearchCodec.java:81`_ ### knnVectorsFormat @@ -126,7 +126,7 @@ Get the configured `KnnVectorsFormat`. the instance of the `KnnVectorsFormat` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUSearchCodec.java:111`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUSearchCodec.java:113`_ ### setKnnFormat @@ -142,6 +142,6 @@ Set the `KnnVectorsFormat`. | --- | --- | | `format` | the `KnnVectorsFormat` to set | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUSearchCodec.java:121`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUSearchCodec.java:122`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUSearchCodec.java:20`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorsformat.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorsformat.md index b747d12460..3d066fa9a4 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorsformat.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorsformat.md @@ -29,7 +29,7 @@ Initializes the `CuVS2510GPUVectorsFormat` with default parameter values. | --- | --- | | `LibraryException` | if the native library fails to load | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsFormat.java:55`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsFormat.java:56`_ ### CuVS2510GPUVectorsFormat @@ -51,7 +51,7 @@ Initializes the `CuVS2510GPUVectorsFormat` with an instance of `GPUSearchParams` | --- | --- | | `LibraryException` | if the native library fails to load | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsFormat.java:65`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsFormat.java:66`_ ### CuVS2510GPUVectorsFormat @@ -74,7 +74,7 @@ Initializes the format with GPU search and filter-bitset-cache parameters. | --- | --- | | `LibraryException` | if the native library fails to load | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsFormat.java:76`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsFormat.java:77`_ ### fieldsWriter @@ -84,7 +84,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVecto Returns a KnnVectorsReader instance to write the vectors to the index. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsFormat.java:86`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsFormat.java:88`_ ### fieldsReader @@ -94,7 +94,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVecto Returns a KnnVectorsReader instance to read the vectors from the index. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsFormat.java:96`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsFormat.java:98`_ ### getMaxDimensions @@ -104,6 +104,6 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVecto Returns the maximum number of vector dimensions supported by this codec for the given field name. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsFormat.java:106`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsFormat.java:108`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsFormat.java:25`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorsreader.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorsreader.md index 5f3ff89fe9..93515b0e2b 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorsreader.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorsreader.md @@ -35,7 +35,7 @@ Initializes the `CuVS2510GPUVectorsReader`, checks and loads the index. | --- | --- | | `IOException` | I/O exception | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:87`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:88`_ ### CuVS2510GPUVectorsReader @@ -59,7 +59,7 @@ Initializes the reader with the cache owned by its vectors format. | --- | --- | | `IOException` | I/O exception | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:100`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:101`_ ### readSimilarityFunction @@ -85,7 +85,7 @@ an instance of VectorSimilarityFunction | --- | --- | | `IOException` | | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:228`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:229`_ ### readVectorEncoding @@ -111,7 +111,7 @@ the vector encoding | --- | --- | | `IOException` | | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:243`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:244`_ ### getFieldEntry @@ -132,7 +132,7 @@ cuVS index for it. the meta information for the field, or `null` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:306`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:307`_ ### openCagraIndexForMerge @@ -165,7 +165,7 @@ a freshly loaded CAGRA index, or `null` if this segment has none for the field | --- | --- | | `IOException` | I/O exception | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:325`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:326`_ ### close @@ -175,7 +175,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVecto Closes the resources. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:394`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:396`_ ### checkIntegrity @@ -185,7 +185,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVecto Checks consistency of this reader. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:412`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:414`_ ### getFloatVectorValues @@ -195,7 +195,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVecto Returns the FloatVectorValues for the given field. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:421`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:423`_ ### getByteVectorValues @@ -207,7 +207,7 @@ Returns the ByteVectorValues for the given field. This is not supported. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:431`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:433`_ ### search @@ -217,7 +217,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVecto Returns the k nearest neighbor documents using cuVS's CAGRA or brute force algorithm for this field, to the given vector. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:455`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:457`_ ### search @@ -229,7 +229,7 @@ Return the k nearest neighbor documents as determined by comparison of their vec This is not supported. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:615`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:617`_ ### readEntry @@ -257,7 +257,7 @@ an instance of FieldEntry | --- | --- | | `IOException` | I/O Exceptions | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:643`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:644`_ ### getCagraIndexForField @@ -278,7 +278,7 @@ Returns the `CagraIndex` for the given field, or `null` if unavailable the CAGRA index, or `null` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:695`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:696`_ ### getFilterBitsetCache @@ -288,7 +288,7 @@ FilterBitsetCache getFilterBitsetCache() Returns the filter cache owned by the vectors format that created this reader. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:705`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:706`_ ### getFieldInfos @@ -302,7 +302,7 @@ Gets the instance of FieldInfos. the instance of FieldInfos -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:714`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:715`_ ### getCuvsIndexes @@ -316,7 +316,7 @@ Gets the map of `GPUIndex` objects. the map of GPU index objects -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:723`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:724`_ ### getFieldEntries @@ -330,6 +330,6 @@ Gets the map of FieldEntry objects that hold the meta information for the field. the map of FieldEntry objects -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:732`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:733`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsReader.java:59`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorswriter.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorswriter.md index df1abbbdc7..f52c0df273 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorswriter.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-cuvs2510gpuvectorswriter.md @@ -22,7 +22,7 @@ CAGRA(true, false), /** Builds a Brute Force index. */ BRUTE_FORCE(false, true), Builds a CAGRA index. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:89`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:90`_ ### BRUTE_FORCE @@ -32,7 +32,7 @@ BRUTE_FORCE(false, true), /** Builds both - CAGRA and Brute Force indexes. */ CA Builds a Brute Force index. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:92`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:93`_ ### CAGRA_AND_BRUTE_FORCE @@ -42,7 +42,7 @@ CAGRA_AND_BRUTE_FORCE(true, true) Builds both - CAGRA and Brute Force indexes. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:95`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:96`_ ### CuVS2510GPUVectorsWriter @@ -66,7 +66,7 @@ Initializes `CuVS2510GPUVectorsWriter`. | --- | --- | | `IOException` | I/O exceptions | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:121`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:122`_ ### addField @@ -76,7 +76,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVecto Add new field for indexing. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:160`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:162`_ ### flush @@ -86,7 +86,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVecto Creates the CAGRA and/or brute force indexes and writes them to the disk. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:303`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:305`_ ### mergeOneField @@ -96,7 +96,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVecto Write field for merging. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:685`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:687`_ ### ramBytesUsed @@ -106,7 +106,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVecto Returns the memory usage of this object in bytes. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:696`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:698`_ ### finish @@ -116,7 +116,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVecto Called once at the end before close. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:708`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:710`_ ### close @@ -126,6 +126,6 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVecto Close the applicable resources. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:728`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:730`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/CuVS2510GPUVectorsWriter.java:59`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-filterbitsetcacheconfig.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-filterbitsetcacheconfig.md index 3f215f360c..d6d873201e 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-filterbitsetcacheconfig.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-filterbitsetcacheconfig.md @@ -37,6 +37,6 @@ public static final FilterBitsetCacheConfig DEFAULT = new FilterBitsetCacheConfi Default configuration used by SPI-created codecs and vector formats. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/FilterBitsetCacheConfig.java:27`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/FilterBitsetCacheConfig.java:28`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/FilterBitsetCacheConfig.java:22`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-filtercuvsserviceprovider.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-filtercuvsserviceprovider.md index 9d6701b88e..5b9b49b45f 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-filtercuvsserviceprovider.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-filtercuvsserviceprovider.md @@ -22,6 +22,6 @@ A provider that creates instances of FilterCuVSProvider. Initialize and return an CuVSProvider provided by this provider. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/FilterCuVSServiceProvider.java:19`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/FilterCuVSServiceProvider.java:21`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/FilterCuVSServiceProvider.java:15`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpubuilthnswgraph.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpubuilthnswgraph.md index fddfb07773..4e58e01c43 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpubuilthnswgraph.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpubuilthnswgraph.md @@ -31,7 +31,7 @@ Multi-layer constructor that supports arbitrary number of layers. | `layerNodes` | the nodes on the layer | | `layerAdjacencies` | adjacency list | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:41`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:42`_ ### getNodesOnLevel @@ -41,7 +41,7 @@ public NodesIterator getNodesOnLevel(int level) Get all nodes on a given level as node 0th ordinals. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:92`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:93`_ ### getNeighbors @@ -62,7 +62,7 @@ Get the neighbors for the node and the level it resides. an instance of NeighborArray -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:110`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:111`_ ### seek @@ -72,7 +72,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGrap Move the pointer to exactly the given level's target. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:135`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:137`_ ### nextNeighbor @@ -82,7 +82,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGrap Iterates over the neighbor list. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:145`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:147`_ ### entryNode @@ -92,7 +92,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGrap Returns graph's entry point on the top level. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:176`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:178`_ ### maxConn @@ -102,7 +102,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGrap returns M, the maximum number of connections for a node. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:195`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:197`_ ### neighborCount @@ -112,7 +112,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGrap Returns the neighbor count. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:210`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:212`_ ### size @@ -122,7 +122,7 @@ public int size() Returns the number of nodes in the graph. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:285`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:286`_ ### numLevels @@ -136,7 +136,7 @@ Returns the number of levels in the HNSW graph. the number of levels -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:294`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:295`_ ### dimensions @@ -150,6 +150,6 @@ Gets the vector dimension. the vector dimension -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:303`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:304`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUBuiltHnswGraph.java:21`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpuindex.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpuindex.md index af188e002f..3879bbdf4d 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpuindex.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpuindex.md @@ -32,7 +32,7 @@ Initializes an instance of `GPUIndex` | `maxDocs` | the maximum documents | | `bruteforceIndex` | reference to the BruteForceIndex | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:35`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:36`_ ### GPUIndex @@ -49,7 +49,7 @@ Initializes an instance of `GPUIndex` | `cagraIndex` | reference to the CagraIndex instance | | `bruteforceIndex` | reference to the BruteForceIndex instance | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:57`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:58`_ ### getCagraIndex @@ -63,7 +63,7 @@ Gets the reference to the CAGRA index an instance of CagraIndex -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:67`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:68`_ ### getBruteforceIndex @@ -77,7 +77,7 @@ Gets the reference to the Bruteforce index an instance of BruteForceIndex -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:77`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:78`_ ### getFieldName @@ -91,7 +91,7 @@ Gets the field name field name -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:87`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:88`_ ### getSegmentName @@ -105,7 +105,7 @@ Gets the segment name segment name -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:96`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:97`_ ### getMaxDocs @@ -119,7 +119,7 @@ Gets the max docs the max docs -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:105`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:106`_ ### close @@ -129,6 +129,6 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:10 Closes this stream and releases any resources associated with it. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:121`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:123`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUIndex.java:18`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpuknnfloatvectorquery.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpuknnfloatvectorquery.md index f8909e5f77..468b5b8545 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpuknnfloatvectorquery.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpuknnfloatvectorquery.md @@ -62,7 +62,7 @@ and max_iterations auto-selected (0). | `iTopK` | CAGRA itopk_size parameter | | `searchWidth` | CAGRA search_width parameter | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUKnnFloatVectorQuery.java:141`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUKnnFloatVectorQuery.java:142`_ ### GPUKnnFloatVectorQuery @@ -86,6 +86,6 @@ Initializes `GPUKnnFloatVectorQuery`. | `maxIterations` | nonnegative CAGRA max_iterations (0 = auto) | | `searchAlgo` | CAGRA search algorithm | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUKnnFloatVectorQuery.java:159`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUKnnFloatVectorQuery.java:160`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUKnnFloatVectorQuery.java:82`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpusearchparams.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpusearchparams.md index 8b9608337d..18cdc03ca6 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpusearchparams.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-gpusearchparams.md @@ -24,7 +24,7 @@ Get the cuVS writer threads parameter cuVS writer threads parameter -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:115`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:116`_ ### getIntermediateGraphDegree @@ -38,7 +38,7 @@ Get the intermediate graph degree the graph degree parameter -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:124`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:125`_ ### getGraphdegree @@ -52,7 +52,7 @@ Get the graph degree the graph degree parameter -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:133`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:134`_ ### getCagraGraphBuildAlgo @@ -66,7 +66,7 @@ Get the CAGRA build algorithm parameter value the CAGRA build algorithm parameter value -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:142`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:143`_ ### getIndexType @@ -80,7 +80,7 @@ Get the index type parameter the index type parameter -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:151`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:152`_ ### getCuVSIvfPqParams @@ -94,7 +94,7 @@ Get the instance of CuVSIvfPqParams an instance of CuVSIvfPqParams -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:160`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:161`_ ### getStrategy @@ -111,7 +111,7 @@ When CUSTOM is chosen, the build algorithm and its parameters (either defaults o get the chosen `Strategy` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:173`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:174`_ ### getCuvsDistanceType @@ -125,7 +125,7 @@ Get the cuvs distance type the distance type -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:182`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:183`_ ### getnNDescentNumIterations @@ -139,7 +139,7 @@ get the number of Iterations to run if building with NN_DESCENT the number of iterations for NN_DESCENT -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:191`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:192`_ ### getBuildQuality @@ -154,7 +154,7 @@ Strategy#HEURISTIC\} strategy. the build quality -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:201`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:202`_ ### withWriterThreads @@ -176,7 +176,7 @@ Default value - \{@value DEFAULT_WRITER_THREADS\} instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:254`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:255`_ ### withIntermediateGraphDegree @@ -198,7 +198,7 @@ Default value - \{@value DEFAULT_INT_GRAPH_DEGREE\} instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:267`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:268`_ ### withGraphDegree @@ -220,7 +220,7 @@ Default value - \{@value DEFAULT_GRAPH_DEGREE\} instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:280`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:281`_ ### withCagraGraphBuildAlgo @@ -241,7 +241,7 @@ Cannot be null, defaults to NN_DESCENT instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:292`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:293`_ ### withIndexType @@ -262,7 +262,7 @@ Cannot be null, defaults to CAGRA instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:304`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:305`_ ### withCuVSIvfPqParams @@ -282,7 +282,7 @@ Set the instance of `CuVSIvfPqParams` instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:315`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:316`_ ### withStrategy @@ -308,7 +308,7 @@ Default value - HEURISTIC instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:332`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:333`_ ### withCuvsDistanceType @@ -328,7 +328,7 @@ Set the CuvsDistanceType instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:343`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:344`_ ### withNNDescentNumIterations @@ -351,7 +351,7 @@ Default value - \{@value DEFAULT_NN_DESCENT_NUM_ITERATIONS\} instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:357`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:358`_ ### withBuildQuality @@ -378,7 +378,7 @@ Default value - \{@value DEFAULT_BUILD_QUALITY\} instance of `Builder` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:375`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:376`_ ### build @@ -392,6 +392,6 @@ Creates and returns an instance of `GPUSearchParams` instance of `GPUSearchParams` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:419`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:420`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/GPUSearchParams.java:15`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-lucene101acceleratedhnswcodec.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-lucene101acceleratedhnswcodec.md index 7f7dde5bbf..a6dcbc852e 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-lucene101acceleratedhnswcodec.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-lucene101acceleratedhnswcodec.md @@ -30,7 +30,7 @@ Default constructor for `Lucene101AcceleratedHNSWCodec`. | --- | --- | | `Exception` | | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:31`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:32`_ ### Lucene101AcceleratedHNSWCodec @@ -47,7 +47,7 @@ Constructor for `Lucene101AcceleratedHNSWCodec`. | `name` | the codec's name | | `delegate` | the delegate codec to filter | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:41`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:42`_ ### Lucene101AcceleratedHNSWCodec @@ -69,7 +69,7 @@ Constructor for `Lucene101AcceleratedHNSWCodec`. | --- | --- | | `Exception` | exception | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:52`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:53`_ ### knnVectorsFormat @@ -83,7 +83,7 @@ Get the configured `KnnVectorsFormat`. the instance of the `KnnVectorsFormat` -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:87`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:89`_ ### setKnnFormat @@ -99,6 +99,6 @@ Set the `KnnVectorsFormat`. | --- | --- | | `format` | the `KnnVectorsFormat` to set | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:97`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:98`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:21`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-lucene99acceleratedhnswvectorsformat.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-lucene99acceleratedhnswvectorsformat.md index e84e99efc6..058f149663 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-lucene99acceleratedhnswvectorsformat.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-lucene99acceleratedhnswvectorsformat.md @@ -29,7 +29,7 @@ of `AcceleratedHNSWParams` with default parameter values. | --- | --- | | `LibraryException` | if the native library fails to load | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsFormat.java:56`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsFormat.java:57`_ ### Lucene99AcceleratedHNSWVectorsFormat @@ -46,7 +46,7 @@ of `AcceleratedHNSWParams`. | --- | --- | | `acceleratedHNSWParams` | An instance of `AcceleratedHNSWParams` | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsFormat.java:66`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsFormat.java:67`_ ### fieldsWriter @@ -56,7 +56,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99Accelera Returns a KnnVectorsWriter to write the vectors to the index. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsFormat.java:74`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsFormat.java:76`_ ### fieldsReader @@ -66,7 +66,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99Accelera Returns a KnnVectorsReader to read the vectors from the index. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsFormat.java:101`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsFormat.java:103`_ ### getMaxDimensions @@ -76,6 +76,6 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99Accelera Returns the maximum number of vector dimensions supported by this codec for the given field name. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsFormat.java:114`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsFormat.java:116`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsFormat.java:27`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-lucene99acceleratedhnswvectorswriter.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-lucene99acceleratedhnswvectorswriter.md index fd485b6671..3519be116a 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-lucene99acceleratedhnswvectorswriter.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-lucene99acceleratedhnswvectorswriter.md @@ -37,7 +37,7 @@ Initializes `Lucene99AcceleratedHNSWVectorsWriter` | --- | --- | | `IOException` | IOException | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsWriter.java:90`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsWriter.java:91`_ ### addField @@ -47,7 +47,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99Accelera Add new field for indexing. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsWriter.java:133`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsWriter.java:135`_ ### flush @@ -57,7 +57,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99Accelera Build the indexes and writes it to the disk. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsWriter.java:232`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsWriter.java:234`_ ### mergeOneField @@ -67,7 +67,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99Accelera Write field for merging. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsWriter.java:390`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsWriter.java:392`_ ### finish @@ -77,7 +77,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99Accelera Called once at the end before close. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsWriter.java:399`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsWriter.java:401`_ ### close @@ -87,7 +87,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99Accelera Closes the resources. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsWriter.java:419`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsWriter.java:421`_ ### ramBytesUsed @@ -97,6 +97,6 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99Accelera Returns the memory usage of this object in bytes. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsWriter.java:429`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsWriter.java:431`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene99AcceleratedHNSWVectorsWriter.java:55`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswbinaryquantizedvectorsformat.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswbinaryquantizedvectorsformat.md index b574aff9b1..5bdd5ce0af 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswbinaryquantizedvectorsformat.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswbinaryquantizedvectorsformat.md @@ -28,7 +28,7 @@ Initializes `LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat` with default val | --- | --- | | `LibraryException` | if the native library fails to load | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat.java:52`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat.java:53`_ ### LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat @@ -44,7 +44,7 @@ Initializes `LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat` with the given t | --- | --- | | `acceleratedHNSWParams` | An instance of `AcceleratedHNSWParams` | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat.java:61`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat.java:62`_ ### fieldsWriter @@ -54,7 +54,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Returns a KnnVectorsWriter to write the binary quantized vectors to the index. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat.java:70`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat.java:72`_ ### fieldsReader @@ -64,7 +64,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Returns a KnnVectorsReader to read the binary quantized vectors from the index. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat.java:99`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat.java:101`_ ### getMaxDimensions @@ -74,6 +74,6 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Returns the maximum number of vector dimensions supported by this codec for the given field name. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat.java:112`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat.java:114`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsFormat.java:26`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswbinaryquantizedvectorswriter.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswbinaryquantizedvectorswriter.md index 4c566ca2c6..493fd8c28c 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswbinaryquantizedvectorswriter.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswbinaryquantizedvectorswriter.md @@ -37,7 +37,7 @@ Initializes `LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter` | --- | --- | | `IOException` | IOException | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter.java:80`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter.java:81`_ ### addField @@ -47,7 +47,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Add new field for indexing. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter.java:129`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter.java:131`_ ### flush @@ -57,7 +57,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Build the indexes and writes it to the disk. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter.java:231`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter.java:233`_ ### mergeOneField @@ -67,7 +67,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Write field for merging. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter.java:316`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter.java:318`_ ### finish @@ -77,7 +77,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Called once at the end before close. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter.java:347`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter.java:349`_ ### close @@ -87,7 +87,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Closes the resources. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter.java:367`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter.java:369`_ ### ramBytesUsed @@ -97,6 +97,6 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Returns the memory usage of this object in bytes. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter.java:376`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter.java:378`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWBinaryQuantizedVectorsWriter.java:57`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswscalarquantizedvectorsformat.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswscalarquantizedvectorsformat.md index 1d249bc2df..4cda1a2f2c 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswscalarquantizedvectorsformat.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswscalarquantizedvectorsformat.md @@ -28,7 +28,7 @@ Initializes `LuceneAcceleratedHNSWScalarQuantizedVectorsFormat` with default val | --- | --- | | `LibraryException` | if the native library fails to load | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsFormat.java:47`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsFormat.java:48`_ ### LuceneAcceleratedHNSWScalarQuantizedVectorsFormat @@ -44,7 +44,7 @@ Initializes `LuceneAcceleratedHNSWScalarQuantizedVectorsFormat` with the given t | --- | --- | | `acceleratedHNSWParams` | An instance of `AcceleratedHNSWParams` | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsFormat.java:56`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsFormat.java:57`_ ### fieldsWriter @@ -54,7 +54,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Returns a KnnVectorsWriter to write the scalar quantized vectors to the index. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsFormat.java:65`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsFormat.java:67`_ ### fieldsReader @@ -64,7 +64,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Returns a KnnVectorsReader to read the scalar quantized vectors from the index. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsFormat.java:91`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsFormat.java:93`_ ### getMaxDimensions @@ -74,6 +74,6 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Returns the maximum number of vector dimensions supported by this Codec for the given field name. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsFormat.java:104`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsFormat.java:106`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsFormat.java:24`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswscalarquantizedvectorswriter.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswscalarquantizedvectorswriter.md index a4db8258cd..69866ac91c 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswscalarquantizedvectorswriter.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-luceneacceleratedhnswscalarquantizedvectorswriter.md @@ -37,7 +37,7 @@ Initializes `LuceneAcceleratedHNSWScalarQuantizedVectorsWriter` | --- | --- | | `IOException` | IOException | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsWriter.java:90`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsWriter.java:91`_ ### addField @@ -47,7 +47,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Add new field for indexing. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsWriter.java:138`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsWriter.java:140`_ ### flush @@ -57,7 +57,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Build the indexes and writes it to the disk. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsWriter.java:258`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsWriter.java:260`_ ### mergeOneField @@ -67,7 +67,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Write field for merging. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsWriter.java:341`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsWriter.java:343`_ ### finish @@ -77,7 +77,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Called once at the end before close. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsWriter.java:372`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsWriter.java:374`_ ### close @@ -87,7 +87,7 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Closes the resources. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsWriter.java:392`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsWriter.java:394`_ ### ramBytesUsed @@ -97,6 +97,6 @@ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAccelerate Returns the memory usage of this object in bytes. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsWriter.java:401`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsWriter.java:403`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/LuceneAcceleratedHNSWScalarQuantizedVectorsWriter.java:56`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-threadlocalcuvsresourcesprovider.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-threadlocalcuvsresourcesprovider.md index f416e55816..114a530e9d 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-threadlocalcuvsresourcesprovider.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-threadlocalcuvsresourcesprovider.md @@ -26,7 +26,7 @@ Gets an instance of CuVSResources for the accessing thread. an instance of CuVSResources -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/ThreadLocalCuVSResourcesProvider.java:30`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/ThreadLocalCuVSResourcesProvider.java:31`_ ### setCuVSResourcesInstance @@ -42,7 +42,7 @@ Sets the instance of CuVSResources | --- | --- | | `resources` | the instance of CuVSResources to set | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/ThreadLocalCuVSResourcesProvider.java:39`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/ThreadLocalCuVSResourcesProvider.java:40`_ ### resolveWorkspacePoolBytes @@ -54,7 +54,7 @@ Resolves a raw workspace-pool property value to a 256-byte-aligned size. Zero or value disables the per-resources pool. Invalid, negative, or unalignable values warn and also disable it. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/ThreadLocalCuVSResourcesProvider.java:80`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/ThreadLocalCuVSResourcesProvider.java:81`_ ### closeCuVSResourcesInstance @@ -64,7 +64,7 @@ public static void closeCuVSResourcesInstance() Attempts to close the thread's `CuVSResources` instance. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/ThreadLocalCuVSResourcesProvider.java:122`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/ThreadLocalCuVSResourcesProvider.java:123`_ ### assertIsSupported @@ -80,7 +80,7 @@ Checks if cuVS is supported and throws `UnsupportedOperationException` otherwise | --- | --- | | `UnsupportedOperationException` | | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/ThreadLocalCuVSResourcesProvider.java:135`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/ThreadLocalCuVSResourcesProvider.java:136`_ ### isSupported @@ -94,6 +94,6 @@ Checks if cuVS is supported. true if cuVS is supported else false -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/ThreadLocalCuVSResourcesProvider.java:146`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/ThreadLocalCuVSResourcesProvider.java:147`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/ThreadLocalCuVSResourcesProvider.java:16`_ diff --git a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-utils.md b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-utils.md index b992bee630..17cbdbb239 100644 --- a/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-utils.md +++ b/fern/pages/lucene_api/lucene-api-com-nvidia-cuvs-lucene-utils.md @@ -45,7 +45,7 @@ never returns; always throws | --- | --- | | `IOException` | | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Utils.java:40`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Utils.java:41`_ ### createFloatMatrix @@ -70,7 +70,7 @@ without creating intermediate heap arrays. an instance of CuVSMatrix -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Utils.java:60`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Utils.java:61`_ ### createHostByteMatrixFromArray @@ -80,7 +80,7 @@ static CuVSHostMatrix createHostByteMatrixFromArray(byte[][] data, int bytesPerV Builds a host-memory CuVSMatrix from a 2D byte array. -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Utils.java:79`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Utils.java:80`_ ### nanosToMillis @@ -100,7 +100,7 @@ A utility method to convert nanoseconds to milliseconds. milliseconds -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Utils.java:160`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Utils.java:161`_ ### cuVSResourcesOrNull @@ -114,7 +114,7 @@ Creates an instance of CuVSResources. an instance of CuVSResources -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Utils.java:169`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Utils.java:170`_ ### handleThrowableWithIgnore @@ -137,7 +137,7 @@ A utility method that conditionally ignores certain throwable objects | --- | --- | | `IOException` | | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Utils.java:197`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Utils.java:198`_ ### info @@ -155,6 +155,6 @@ Utility to print info/debug messages via InfoStream. | `component` | the name of the index writer | | `msg` | the log message to push via the InfoStream | -_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Utils.java:211`_ +_Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Utils.java:212`_ _Source: `java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Utils.java:23`_ diff --git a/fern/scripts/generate_api_reference.py b/fern/scripts/generate_api_reference.py index 3cf916d868..b9b10d0c62 100755 --- a/fern/scripts/generate_api_reference.py +++ b/fern/scripts/generate_api_reference.py @@ -4711,7 +4711,8 @@ def python_slug(module: str) -> str: def java_signature_at(text: str, start: int) -> tuple[str, int]: - line = text.count("\n", 0, start) + 1 + declaration_start = java_declaration_start(text, start) + line = text.count("\n", 0, declaration_start) + 1 idx = start depth = {"(": 0, "[": 0, "{": 0, "<": 0} while idx < len(text): @@ -4726,6 +4727,76 @@ def java_signature_at(text: str, start: int) -> tuple[str, int]: return re.sub(r"\s+", " ", signature), line +def java_declaration_start(text: str, start: int) -> int: + """Locate a declaration after supported leading Java annotations.""" + idx = java_trivia_end(text, start) + while idx < len(text): + if idx >= len(text) or text[idx] != "@": + return idx + + idx = java_trivia_end(text, idx + 1) + while idx < len(text): + name_start = idx + while idx < len(text) and ( + text[idx].isalnum() or text[idx] in "_$" + ): + idx += 1 + if idx == name_start: + break + idx = java_trivia_end(text, idx) + if idx >= len(text) or text[idx] != ".": + break + idx = java_trivia_end(text, idx + 1) + if idx >= len(text) or text[idx] != "(": + continue + + depth = 0 + quote = "" + escaped = False + while idx < len(text): + if not quote: + trivia_end = java_trivia_end(text, idx) + if trivia_end != idx: + idx = trivia_end + continue + char = text[idx] + idx += 1 + if quote: + if escaped: + escaped = False + elif char == "\\": + escaped = True + elif char == quote: + quote = "" + elif char in "\"'": + quote = char + elif char == "(": + depth += 1 + elif char == ")": + depth -= 1 + if depth == 0: + break + idx = java_trivia_end(text, idx) + return idx + + +def java_trivia_end(text: str, start: int) -> int: + """Return the first offset after Java whitespace and comments.""" + idx = start + while idx < len(text): + if text[idx].isspace(): + idx += 1 + elif text.startswith("//", idx): + newline = text.find("\n", idx + 2) + idx = len(text) if newline < 0 else newline + 1 + elif text.startswith("/*", idx): + close = text.find("*/", idx + 2) + idx = len(text) if close < 0 else close + 2 + else: + return idx + return idx + + def comment_before(text: str, start: int) -> str: prefix = text[:start].rstrip() match = re.search( diff --git a/fern/scripts/test_generate_api_reference.py b/fern/scripts/test_generate_api_reference.py new file mode 100644 index 0000000000..d47fc8bf05 --- /dev/null +++ b/fern/scripts/test_generate_api_reference.py @@ -0,0 +1,61 @@ +# SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. +# SPDX-License-Identifier: Apache-2.0 + +import unittest + +from fern.scripts.generate_api_reference import ( + java_signature_at, + parse_java_members, +) + + +class GenerateApiReferenceTest(unittest.TestCase): + def test_java_member_source_line_points_to_declaration(self): + source = """public class Example { + /** Plain member. */ + public void plain() {} + + /** Annotated member. */ + @ /* after at-sign */ java /* before dot */ . lang /* before dot */ . Override // The source link should skip this comment. + /* It should also skip a comment between the annotation and declaration. */ + public String toString() { return "example"; } +} +""" + + members = parse_java_members(source, "Example") + + self.assertEqual( + [(member.name, member.line) for member in members], + [("plain", 3), ("toString", 8)], + ) + self.assertEqual( + members[1].signature, + "@ /* after at-sign */ java /* before dot */ . lang " + "/* before dot */ . Override // The source link should skip this " + "comment. " + "/* It should also skip a comment between the annotation and " + "declaration. */ public String toString()", + ) + + def test_java_source_line_ignores_comments_in_annotation_arguments(self): + source = """@First( + value = @Nested(text = "https://example.test/)") /* comment containing ) */, + other = @Nested( // line comment containing ) + text = "/* not a comment */")) + public void annotated() {} +""" + + signature, line = java_signature_at(source, 0) + + self.assertEqual(line, 5) + self.assertEqual( + signature, + '@First( value = @Nested(text = "https://example.test/)") ' + "/* comment containing ) */, other = @Nested( // line comment " + 'containing ) text = "/* not a comment */")) ' + "public void annotated()", + ) + + +if __name__ == "__main__": + unittest.main()