Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions examples/java/cuvs-lucene/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,3 @@ To run the Index and Search on GPU example do:
```sh
mvn clean install && java -Djava.util.logging.config.file=src/main/resources/logging.properties -cp target/examples-26.10.0-jar-with-merged-services.jar com.nvidia.cuvs.lucene.examples.IndexAndSearchonGPUExample
```

To run the optimized CAGRA-HNSW build example (reference pattern for efficiently building an
accelerated HNSW index from a large `.fbin` with every ingest-side knob on — open the file once and
stream sequential prefetched chunks that overlap the disk read with indexing, hold at most two chunks
in memory, reuse a single vector array, size a native flat buffer per segment, auto-select the CAGRA
graph-build algorithm, and optionally partition into K segments built sequentially or overlapped) do:

```sh
mvn clean install && java -Djava.util.logging.config.file=src/main/resources/logging.properties -cp target/examples-26.10.0-jar-with-merged-services.jar com.nvidia.cuvs.lucene.examples.OptimizedCagraHnswBuildExample
```

With no arguments it generates and indexes a small demo `.fbin` as a single segment; pass a real file,
chunk size, segment count, and overlap flag as
`... OptimizedCagraHnswBuildExample <path-to.fbin> <chunkSizeMB> <numSegments> <overlap:true|false>`.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -412,21 +412,14 @@ Switch RMM allocations (used internally by various cuVS algorithms and by the de
`CuVSDeviceMatrix`) to use pooled memory.
This operation has a global effect, and will affect all resources on the current device.

Ownership: this and the other `enableRMM*`/`resetRMMPooledMemory` methods are
not called automatically by any cuVS/cuvs-lucene class. Because the effect is global to the
current device, it is application code's responsibility to call one of them, if desired, once
during startup/initialization — before any GPU resource is created — rather than have an
individual class call it lazily on first use, which cannot be made race-free against
concurrent construction of that class from multiple threads.

**Parameters**

| Name | Description |
| --- | --- |
| `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:250`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:243`_

### enableRMMManagedPooledMemory

Expand All @@ -438,16 +431,14 @@ Switch RMM allocations (used internally by various cuVS algorithms and by the de
`CuVSDeviceMatrix`) to use pooled memory.
This operation has a global effect, and will affect all resources on the current device.

Ownership: see `#enableRMMPooledMemory`.

**Parameters**

| Name | Description |
| --- | --- |
| `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:262`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:253`_

### enableRMMAsyncMemory

Expand All @@ -462,9 +453,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.

Ownership: see `#enableRMMPooledMemory`.

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:274`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:263`_

### resetRMMPooledMemory

Expand All @@ -474,9 +463,7 @@ void resetRMMPooledMemory()

Disables pooled memory on the current device, reverting back to the default setting.

Ownership: see `#enableRMMPooledMemory`.

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:281`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:266`_

### provider

Expand All @@ -486,7 +473,7 @@ static CuVSProvider provider()

Retrieves the system-wide provider.

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:284`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:269`_

### cagraIndexParamsFromHnswParams

Expand Down Expand Up @@ -516,7 +503,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:304`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:289`_

### cagraIndexParamsFromDataset

Expand All @@ -540,6 +527,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:322`_
_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:307`_

_Source: `java/cuvs-java/src/main/java/com/nvidia/cuvs/spi/CuVSProvider.java:18`_
Loading
Loading