TieredIndexParams

Java package: com.nvidia.cuvs

1
public final class TieredIndexParams

Configuration parameters for building a TieredIndex. Only CAGRA is currently supported as the underlying ANN algorithm.

Public Members

product

1
L2, /** Inner product (cosine similarity) distance metric */ INNER_PRODUCT } private final Metric metric

L2 (Euclidean) distance metric

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:20

TieredIndexParams

1
private TieredIndexParams(Builder builder)

Private constructor used by the Builder.

Parameters

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:35

getMetric

1
public Metric getMetric()

Returns the distance metric used for similarity computation.

Returns

The Metric (L2 or Inner Product)

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:47

getMinAnnRows

1
public int getMinAnnRows()

Returns the minimum number of rows required to use the ANN algorithm.

Returns

The minimum row count threshold for ANN algorithm usage

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:56

isCreateAnnIndexOnExtend

1
public boolean isCreateAnnIndexOnExtend()

Returns whether to create an ANN index when extending the dataset.

Returns

true if ANN index should be created on extend, false otherwise

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:65

getCagraParams

1
public CagraIndexParams getCagraParams()

Returns the CAGRA-specific parameters for the ANN algorithm.

Returns

The CagraIndexParams configuration, or null if not using CAGRA

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:75

newBuilder

1
public static Builder newBuilder()

Creates a new Builder for constructing TieredIndexParams.

Returns

A new Builder instance

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:84

metric

1
public Builder metric(Metric metric)

Sets the distance metric for similarity computation.

Parameters

Returns

This Builder instance for method chaining

Throws

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:104

minAnnRows

1
public Builder minAnnRows(int minAnnRows)

Sets the minimum number of rows required to use the ANN algorithm.

Parameters

Returns

This Builder instance for method chaining

Throws

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:116

createAnnIndexOnExtend

1
public Builder createAnnIndexOnExtend(boolean val)

Sets whether to create an ANN index when extending the dataset.

Parameters

Returns

This Builder instance for method chaining

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:130

withCagraParams

1
public Builder withCagraParams(CagraIndexParams params)

Sets the CAGRA-specific parameters for the ANN algorithm.

Parameters

Returns

This Builder instance for method chaining

Throws

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndexParams.java:143

build

1
public TieredIndexParams build()

Builds and returns a TieredIndexParams instance with the configured parameters.

Returns

A new TieredIndexParams instance

Throws

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:14