README.md

Quick reference

diskann | openEuler

DiskANN is a suite of scalable, accurate and cost-effective approximate nearest neighbor search algorithms for large-scale vector search that support real-time changes and simple filters. This code is based on ideas from Microsoft's DiskANN.

Supported tags and respective Dockerfile links

The tag of each diskann docker image is consist of the version of diskann and the version of basic image. The details are as follows

Tags Currently Architectures
0.52.0-oe2403sp3 diskann 0.52.0 on openEuler 24.03-lts-sp3 amd64, arm64

Usage

This image provides the DiskANN command-line tools for building, searching, and benchmarking approximate nearest neighbor indexes.

Running DiskANN benchmark

docker run openeuler/diskann:{Tag} diskann-benchmark --help

Available tools

The following CLI tools are included in the image:

  • diskann-benchmark — Main benchmark and search tool
  • compute_groundtruth — Compute ground truth for accuracy evaluation
  • compute_multivec_groundtruth — Compute ground truth for multi-vector datasets
  • gen_associated_data_from_range — Generate associated data from a range
  • generate_minmax — Generate minmax quantization tables
  • generate_pq — Generate product quantization tables
  • generate_synthetic_labels — Generate synthetic label data
  • random_data_generator — Generate random vector datasets
  • relative_contrast — Compute relative contrast of a dataset
  • subsample_bin — Subsample a binary vector file

Running a specific tool

docker run openeuler/diskann:{Tag} <tool-name> --help

Question and answering

If you have any questions or want to use some special features, please submit an issue or a pull request on openeuler-docker-images.