CuVSIvfPqSearchParams

View as Markdown

Java package: com.nvidia.cuvs

public class CuVSIvfPqSearchParams

Public Members

getnProbes

public int getnProbes()

Gets the number of clusters to search

Returns

the number of clusters to search

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:71

getLutDtype

public CudaDataType getLutDtype()

Gets the data type of look up table to be created dynamically at search time

Returns

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

getInternalDistanceDtype

public CudaDataType getInternalDistanceDtype()

Gets the storage data type for distance/similarity computed at search time

Returns

the storage data type for distance/similarity computed at search time

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:90

getPreferredShmemCarveout

public double getPreferredShmemCarveout()

Gets the preferred fraction of SM’s unified memory / L1 cache to be used as shared memory

Returns

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

withNProbes

public Builder withNProbes(int nProbes)

Sets the number of clusters to search.

Parameters

NameDescription
nProbesthe number of clusters to search

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:175

withLutDtype

public Builder withLutDtype(CudaDataType lutDtype)

Sets the the data type of look up table to be created dynamically at search time.

Parameters

NameDescription
lutDtypethe data type of look up table to be created dynamically at search time

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:188

withInternalDistanceDtype

public Builder withInternalDistanceDtype(CudaDataType internalDistanceDtype)

Sets the storage data type for distance/similarity computed at search time.

Parameters

NameDescription
internalDistanceDtypestorage data type for distance/similarity computed at search time

Returns

an instance of Builder

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

withPreferredShmemCarveout

public Builder withPreferredShmemCarveout(double preferredShmemCarveout)

Sets the preferred fraction of SM’s unified memory / L1 cache to be used as shared memory.

Parameters

NameDescription
preferredShmemCarveoutpreferred fraction of SM’s unified memory / L1 cache to be used as shared memory

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqSearchParams.java:213

build

public CuVSIvfPqSearchParams build()

Builds an instance of CuVSIvfPqSearchParams.

Returns

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