From be5848aed8ad3c8bce3a7650c546f884f90bbf5b Mon Sep 17 00:00:00 2001 From: "Corey J. Nolet" Date: Sat, 14 Oct 2023 02:44:44 +0200 Subject: [PATCH] Refactor install/build guide. (#1899) 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 #1895 Authors: - Corey J. Nolet (https://github.com/cjnolet) Approvers: - Bradley Dice (https://github.com/bdice) - Dante Gama Dessavre (https://github.com/dantegd) URL: https://github.com/rapidsai/raft/pull/1899 --- docs/source/raft_ann_benchmarks.md | 35 ++++++++++++++++++------------ 1 file changed, 21 insertions(+), 14 deletions(-) diff --git a/docs/source/raft_ann_benchmarks.md b/docs/source/raft_ann_benchmarks.md index 315e2245d8..83fee0d040 100644 --- a/docs/source/raft_ann_benchmarks.md +++ b/docs/source/raft_ann_benchmarks.md @@ -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