Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CAGRA docs #4152

Closed
wants to merge 9 commits into from
6 changes: 5 additions & 1 deletion faiss/gpu/GpuIndexCagra.h
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,11 @@ struct GpuIndexCagra : public GpuIndex {
faiss::MetricType metric = faiss::METRIC_L2,
GpuIndexCagraConfig config = GpuIndexCagraConfig());

/// Trains CAGRA based on the given vector data
/// Trains CAGRA based on the given vector data.
/// NB: The use of the train function here is to build the CAGRA graph on
/// the base dataset and is currently the only function to add the full set
/// of vectors (without IDs) to the index. There is no external quantizer to
/// be trained here.
void train(idx_t n, const float* x) override;

/// Initialize ourselves from the given CPU index; will overwrite
Expand Down
7 changes: 5 additions & 2 deletions faiss/gpu/impl/CuvsCagra.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,11 @@ class CuvsCagra {
const int dim_;

/// Controls the underlying cuVS index if it should store the dataset in
/// device memory
bool store_dataset_;
/// device memory. Default set to true for enabling search capabilities on
/// the index.
/// NB: This is also required to be set to true for deserializing
/// an IndexHNSWCagra object.
bool store_dataset_ = true;

/// Metric type of the index
faiss::MetricType metric_;
Expand Down
Loading