Com Nvidia cuVS Cuvsivfpqindexparams

Java package: com.nvidia.cuvs

public class CuVSIvfPqIndexParams

Public Members

getMetric

public CuvsDistanceType getMetric()

Gets the distance type.

Returns

the distance type

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

getCodebookKind

public CodebookGen getCodebookKind()

Gets how PQ codebooks are created

Returns

how PQ codebooks are created

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:152

getMetricArg

public float getMetricArg()

Gets the argument used by some distance metrics

Returns

the argument used by some distance metrics

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:161

getKmeansTrainsetFraction

public double getKmeansTrainsetFraction()

Gets the fraction of data to use during iterative kmeans building

Returns

the fraction of data to use during iterative kmeans building

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:170

getnLists

public int getnLists()

Gets the number of inverted lists (clusters)

Returns

the number of inverted lists (clusters)

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:179

getKmeansNIters

public int getKmeansNIters()

Gets the number of iterations searching for kmeans centers

Returns

the number of iterations searching for kmeans centers

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

getPqBits

public int getPqBits()

Gets the bit length of the vector element after compression by PQ

Returns

the bit length of the vector element after compression by PQ

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:197

getPqDim

public int getPqDim()

Gets the dimensionality of the vector after compression by PQ

Returns

the dimensionality of the vector after compression by PQ

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:206

isAddDataOnBuild

public boolean isAddDataOnBuild()

Gets whether the dataset content is added to the index

Returns

whether the dataset content is added to the index

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:215

isForceRandomRotation

public boolean isForceRandomRotation()

Gets the random rotation matrix on the input data and queries

Returns

the random rotation matrix on the input data and queries

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:224

isConservativeMemoryAllocation

public boolean isConservativeMemoryAllocation()

Gets if conservative allocation behavior is set

Returns

if conservative allocation behavior is set

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:233

getMaxTrainPointsPerPqCode

public int getMaxTrainPointsPerPqCode()

Gets whether max number of data points to use per PQ code during PQ codebook training is set

Returns

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

withMetric

public Builder withMetric(CuvsDistanceType metric)

Sets the distance type.

Parameters

Name	Description
`metric`	distance type

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:389

withMetricArg

public Builder withMetricArg(float metricArg)

Sets the argument used by some distance metrics.

Parameters

Name	Description
`metricArg`	argument used by some distance metrics

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:400

withAddDataOnBuild

public Builder withAddDataOnBuild(boolean addDataOnBuild)

Sets whether to add the dataset content to the index.

Parameters

Name	Description
`addDataOnBuild`	whether to add the dataset content to the index

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:411

withNLists

public Builder withNLists(int nLists)

Sets the number of inverted lists (clusters)

Parameters

Name	Description
`nLists`	number of inverted lists (clusters)

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:422

withKmeansNIters

public Builder withKmeansNIters(int kmeansNIters)

Sets the number of iterations searching for kmeans centers

Parameters

Name	Description
`kmeansNIters`	number of iterations searching for kmeans centers

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:433

withKmeansTrainsetFraction

public Builder withKmeansTrainsetFraction(double kmeansTrainsetFraction)

Sets the fraction of data to use during iterative kmeans building.

Parameters

Name	Description
`kmeansTrainsetFraction`	fraction of data to use during iterative kmeans building

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:445

withPqBits

public Builder withPqBits(int pqBits)

Sets the bit length of the vector element after compression by PQ.

Parameters

Name	Description
`pqBits`	bit length of the vector element after compression by PQ

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:456

withPqDim

public Builder withPqDim(int pqDim)

Sets the dimensionality of the vector after compression by PQ.

Parameters

Name	Description
`pqDim`	dimensionality of the vector after compression by PQ

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:467

withCodebookKind

public Builder withCodebookKind(CodebookGen codebookKind)

Sets how PQ codebooks are created.

Parameters

Name	Description
`codebookKind`	how PQ codebooks are created

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:478

withForceRandomRotation

public Builder withForceRandomRotation(boolean forceRandomRotation)

Sets the random rotation matrix on the input data and queries.

Parameters

Name	Description
`forceRandomRotation`	random rotation matrix on the input data and queries

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:490

withConservativeMemoryAllocation

public Builder withConservativeMemoryAllocation(boolean conservativeMemoryAllocation)

Sets the conservative allocation behavior

Parameters

Name	Description
`conservativeMemoryAllocation`	conservative allocation behavior

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:501

withMaxTrainPointsPerPqCode

public Builder withMaxTrainPointsPerPqCode(int maxTrainPointsPerPqCode)

Sets the max number of data points to use per PQ code during PQ codebook training

Parameters

Name	Description
`maxTrainPointsPerPqCode`	max number of data points to use per PQ code during PQ codebook training

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CuVSIvfPqIndexParams.java:514

build

public CuVSIvfPqIndexParams build()

Builds an instance of CuVSIvfPqIndexParams.

Returns

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