CuVSAceParams

Java package: com.nvidia.cuvs

1
public class CuVSAceParams

Parameters for ACE (Augmented Core Extraction) graph build algorithm. ACE enables building indexes for datasets too large to fit in GPU memory by:

1. Partitioning the dataset in core (closest) and augmented (second-closest) partitions using balanced k-means.
2. Building sub-indexes for each partition independently
3. Concatenating sub-graphs into a final unified index

Public Members

getNpartitions

1
public long getNpartitions()

Gets the number of partitions.

Returns

the number of partitions

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:92

getEfConstruction

1
public long getEfConstruction()

Gets the ef_construction parameter.

Returns

the ef_construction parameter

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:101

getBuildDir

1
public String getBuildDir()

Gets the build directory path.

Returns

the build directory path

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:110

isUseDisk

1
public boolean isUseDisk()

Gets whether disk-based mode is enabled.

Returns

true if disk-based mode is enabled

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:119

getMaxHostMemoryGb

1
public double getMaxHostMemoryGb()

Gets the maximum host memory limit in GiB.

Returns

the max host memory limit (0 means use available memory)

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:128

getMaxGpuMemoryGb

1
public double getMaxGpuMemoryGb()

Gets the maximum GPU memory limit in GiB.

Returns

the max GPU memory limit (0 means use available memory)

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:137

withNpartitions

1
public Builder withNpartitions(long npartitions)

Sets the number of partitions.

Parameters

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:189

withEfConstruction

1
public Builder withEfConstruction(long efConstruction)

Sets the ef_construction parameter.

Parameters

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:200

withBuildDir

1
public Builder withBuildDir(String buildDir)

Sets the build directory path.

Parameters

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:211

withUseDisk

1
public Builder withUseDisk(boolean useDisk)

Sets whether to use disk-based mode.

Parameters

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:222

withMaxHostMemoryGb

1
public Builder withMaxHostMemoryGb(double maxHostMemoryGb)

Sets the maximum host memory to use for ACE build in GiB.

When set to 0 (default), uses available host memory. Useful for testing or when running alongside other memory-intensive processes.

Parameters

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:236

withMaxGpuMemoryGb

1
public Builder withMaxGpuMemoryGb(double maxGpuMemoryGb)

Sets the maximum GPU memory to use for ACE build in GiB.

When set to 0 (default), uses available GPU memory. Useful for testing or when running alongside other memory-intensive processes.

Parameters

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:250

build

1
public CuVSAceParams build()

Builds an instance of CuVSAceParams.

Returns

an instance of CuVSAceParams

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:260

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSAceParams.java:17