Skip to content

Commit

Permalink
Refactor install/build guide. (rapidsai#1899)
Browse files Browse the repository at this point in the history
This PR makes some mcuh needed changes to the installation and builde guide. This PR also fixes a few APIs that were missing from the API docs.

Closes rapidsai#1895

Authors:
  - Corey J. Nolet (https://github.com/cjnolet)

Approvers:
  - Bradley Dice (https://github.com/bdice)
  - Dante Gama Dessavre (https://github.com/dantegd)

URL: rapidsai#1899
  • Loading branch information
cjnolet authored and divyegala committed Oct 19, 2023
1 parent 03dbd24 commit be5848a
Showing 1 changed file with 21 additions and 14 deletions.
35 changes: 21 additions & 14 deletions docs/source/raft_ann_benchmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,27 @@ This project provides a benchmark program for various ANN search implementations

## Table of Contents

- [Installing the benchmarks](#installing-the-benchmarks)
- [Conda](#conda)
- [Docker](#docker)
- [How to run the benchmarks](#how-to-run-the-benchmarks)
- [Step 1: prepare dataset](#step-1-prepare-dataset)
- [Step 2: build and search index](#step-2-build-and-search-index)
- [Step 3: data export](#step-3-data-export)
- [Step 4: plot results](#step-4-plot-results)
- [Running the benchmarks](#running-the-benchmarks)
- [End to end: small-scale (<1M to 10M)](#end-to-end-small-scale-benchmarks-1m-to-10m)
- [End to end: large-scale (>10M)](#end-to-end-large-scale-benchmarks-10m-vectors)
- [Running with Docker containers](#running-with-docker-containers)
- [Creating and customizing dataset configurations](#creating-and-customizing-dataset-configurations)
- [Adding a new ANN algorithm](#adding-a-new-ann-algorithm)
- [RAFT ANN Benchmarks](#raft-ann-benchmarks)
- [Table of Contents](#table-of-contents)
- [Installing the benchmarks](#installing-the-benchmarks)
- [Conda](#conda)
- [Docker](#docker)
- [How to run the benchmarks](#how-to-run-the-benchmarks)
- [Step 1: Prepare Dataset](#step-1-prepare-dataset)
- [Step 2: Build and Search Index](#step-2-build-and-search-index)
- [Step 3: Data Export](#step-3-data-export)
- [Step 4: Plot Results](#step-4-plot-results)
- [Running the benchmarks](#running-the-benchmarks)
- [End to end: small-scale benchmarks (\<1M to 10M)](#end-to-end-small-scale-benchmarks-1m-to-10m)
- [End to end: large-scale benchmarks (\>10M vectors)](#end-to-end-large-scale-benchmarks-10m-vectors)
- [Running with Docker containers](#running-with-docker-containers)
- [End-to-end run on GPU](#end-to-end-run-on-gpu)
- [End-to-end run on CPU](#end-to-end-run-on-cpu)
- [Manually run the scripts inside the container](#manually-run-the-scripts-inside-the-container)
- [Creating and customizing dataset configurations](#creating-and-customizing-dataset-configurations)
- [Adding a new ANN algorithm](#adding-a-new-ann-algorithm)
- [Implementation and Configuration](#implementation-and-configuration)
- [Adding a CMake Target](#adding-a-cmake-target)

## Installing the benchmarks

Expand Down

0 comments on commit be5848a

Please sign in to comment.