Skip to content

Updating the benchmark README to use diskann-benchmark #709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bryantower wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Updating the benchmark README to use diskann-benchmark #709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fde624d
Updating the benchmark README to use diskann-benchmark
bryantower Jan 28, 2026
606a81f
Updates to file paths, suggested by copilot.
bryantower Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions diskann-benchmark/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ easier by providing a "one click" runner for benchmarks with machine readable ou

To get started, run
```sh
cargo run --release --package benchmark -- skeleton
cargo run --release --package diskann-benchmark -- skeleton
```
which will print to `stdout` the following JSON schema:
```json
Expand Down Expand Up @@ -88,7 +88,7 @@ In the case of loading an already constructed index rather than building, the "s

Registered inputs are queried using
```sh
cargo run --release --package benchmark -- inputs
cargo run --release --package diskann-benchmark -- inputs
```
which will list something like
```
Expand All @@ -98,7 +98,7 @@ Available input kinds are listed below:
```
To obtain the JSON schema for an input, add its name to the query like
```sh
cargo run --release --package benchmark -- inputs async-index-build
cargo run --release --package diskann-benchmark -- inputs async-index-build
```
which will generate something like
```json
Expand Down Expand Up @@ -181,7 +181,7 @@ Any number of inputs can be used.

Registered benchmarks are queries using the following.
```sh
cargo run --release --package benchmark -- benchmarks
cargo run --release --package diskann-benchmark -- benchmarks
```
Example output is shown below:
```
Expand All @@ -196,7 +196,7 @@ The keyword after "tag" corresponds to the type of input that the benchmark acce

Benchmarks are run with
```sh
cargo run --release --package benchmark -- run --input-file ./benchmark/example/async.json --output-file output.json
cargo run --release --package diskann-benchmark -- run --input-file ./diskann-benchmark/example/async.json --output-file output.json
```

A benchmark run happens in several phases.
Expand Down Expand Up @@ -237,7 +237,7 @@ First, set up the runbook and ground truth for the desired workload. Refer to th

Benchmarks are run with
```sh
cargo run --release --package benchmark -- run --input-file ./benchmark/example/async-dynamic.json --output-file dynamic-output.json
cargo run --release --package diskann-benchmark -- run --input-file ./diskann-benchmark/example/async-dynamic.json --output-file dynamic-output.json
```
Note in the example json that the benchmark is registered under `async-dynamic-index-run`,
instead of `async-index-build` etc..
Expand Down Expand Up @@ -378,11 +378,11 @@ Note that registration can fail if multiple inputs have the same`tag`.

When these steps are completed, our new input will be available using
```sh
cargo run --release --package benchmark -- inputs
cargo run --release --package diskann-benchmark -- inputs
```
and
```sh
cargo run --release --package benchmark -- inputs compute-groundtruth
cargo run --release --package diskann-benchmark -- inputs compute-groundtruth
```
will display an example JSON input for our type.

Expand Down
2 changes: 1 addition & 1 deletion diskann-benchmark/example/disk-index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"source": {
"disk-index-source": "Load",
"data_type": "float32",
"load_path": "disk-index/tests/data/disk_index_search/disk_index_sift_learn_R4_L50_A1.2_truth_search"
"load_path": "test_data/disk_index_search/disk_index_sift_learn_R4_L50_A1.2_truth_search"
},
"search_phase": {
"queries": "disk_index_sample_query_10pts.fbin",
Expand Down