Skip to content

Commit

Permalink
add TOC
Browse files Browse the repository at this point in the history
  • Loading branch information
DelightRun committed Jan 19, 2019
1 parent 1beb2e0 commit 438e2c4
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,34 @@
# NSG : Navigating Spread-out Graph For Approximate Nearest Neighbor Search

Table of Contents
=================
<!--ts-->
* [NSG : Navigating Spread-out Graph For Approximate Nearest Neighbor Search](#nsg--navigating-spread-out-graph-for-approximate-nearest-neighbor-search)
* [Introduction](#introduction)
* [Performance](#performance)
* [Datasets](#datasets)
* [Compared Algorithms](#compared-algorithms)
* [Graph-based ANNS algorithms:](#graph-based-anns-algorithms)
* [Other popular ANNS algorithms:](#other-popular-anns-algorithms)
* [Results](#results)
* [Building Instruction](#building-instruction)
* [Prerequisites](#prerequisites)
* [Compile On Ubuntu/Debian](#compile-on-ubuntudebian)
* [(Optional) Docker Usage](#optional-docker-usage)
* [Usage](#usage)
* [Building NSG Index](#building-nsg-index)
* [Step 1. Build kNN Graph](#step-1-build-knn-graph)
* [Step 2. Convert kNN Graph to NSG](#step-2-convert-knn-graph-to-nsg)
* [Searching via NSG Index](#searching-via-nsg-index)
* [Parameters used in Our Paper](#parameters-used-in-our-paper)
* [NSG Building](#nsg-building)
* [Step 1. Build kNN Graph](#step-1-build-knn-graph-1)
* [Step 2. Convert kNN Graph to NSG](#step-2-convert-knn-graph-to-nsg-1)
* [Pre-built kNN Graph and NSG Index](#pre-built-knn-graph-and-nsg-index)
* [Performance on Taobao's E-commerce Data](#performance-on-taobaos-e-commerce-data)
* [Reference](#reference)
* [TODO](#todo)
* [License](#license)
<!--te-->

## Introduction
Expand Down Expand Up @@ -265,6 +293,7 @@ Reference to cite when you use NSG in a research paper:
[x] Add Docker support
[ ] Improve compatibility of SIMD-related codes
[ ] Python wrapper
[ ] Add travis CI

## License

Expand Down

0 comments on commit 438e2c4

Please sign in to comment.