Skip to content

Latest commit

 

History

History
83 lines (50 loc) · 2.74 KB

README.md

File metadata and controls

83 lines (50 loc) · 2.74 KB
Raw

TOGG: Two-Stage Routing with Optimized Guided Search and Greedy Algorithm On Proximity Graph

This repository is for TOGG evaluation on NSG/NSSG/VAMANA.

Please refer to original readme.

Building Instruction

Prerequisites

  • OpenMP
  • CMake
  • Boost

Compile on Ubuntu:

  1. Install Dependencies:
$ sudo apt-get install g++ cmake libboost-dev libgoogle-perftools-dev
  1. Compile TOGG-KDT/TOGG-KMC:
$ git clone https://github.com/SNU-ARC/TOGG
$ cd TOGG/
$ git checkout ADA-NNS
$ cd algorithms/
$ cd TOGG-KDT/nsg or TOGG-KDT/nssg or TOGG-KDT/vamana or TOGG-KMC/nsg or TOGG-KMC/nssg or TOGG-KMC/vamana
$ cd build
$ ./build.sh

Usage

We provide the script which can build and search for in memory-resident indices. The scripts locate under directory tests/.

Building NSG / NSSG / VAMANA Index

To evaluate TOGG-KDT/TOGG-KMC, an NSG/NSSG/VAMANA index must be built first. Here are the instructions for building index.

Step 1. Build kNN graph

Firstly, we need to prepare a kNN graph.

NSG/NSSG/VAMANA suggests to use efanna_graph to build this kNN graph.

We provide the script to build kNN graphs for various datasets. Please refer to efanna_graph and checkout ADA-NNS branch.

You can also use any alternatives, such as Faiss.

The built graphs should be located in the directory TOGG/algorithms/GA/efanna_graph/build/tests/. as the following format.

e.g., sift1M_knn.graph, deep1M_knn.graph

Step 2. Build NSG/NSSG/VAMANA index and search via NSG/NSSG/VAMANA index

Secondly, we will convert the kNN graph to NSG/NSSG/VAMANA index and perform search.

The parameters used to build each index are the same as those used in ADA-NNS.

Please refer to each readme (NSG, SSG, VAMANA)

And we set the parameter P to 1 and CN to 4.

Searching with NSG/NSSG/VAMANA Index

Dataset should be located in the directory TOGG/routing_evaluation/dataset/. as the following format.

e.g., sift1M, deep1M

To use the greedy search, use the evaluate.sh script:

$ cd tests/
$ ./evaluate.sh [dataset] (e.g., `./evaluate.sh sift1M`, `./evaluate.sh all`)

The argument is as follows:

(i) dataset: Name of the dataset. The script supports various real datasets (e.g., SIFT1M, GIST1M, CRAWL, DEEP1M, DEEP100M, MSONG, GLOVE-100).

To change parameter for search (e.g., K, L, number of threads), open evaluate.sh and modify the parameter K, L_SIZE, THREAD.