Skip to content

Commit 2535730

Browse files
committed
docs(benchmarking): update to document the new queries subfolder and QUERIES var
1 parent 7831fed commit 2535730

1 file changed

Lines changed: 16 additions & 3 deletions

File tree

benchmarking/README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,26 @@ a server on
3939
1. Make sure that you have dataset folders as configured in the evobench config file (`evobench-run.ron`); see [Offer dataset versioning #32](https://github.com/GenSpectrum/evobench/issues/32) for the required folder structure. Each versioned dataset folder needs these files (or symlinks to them):
4040

4141
database_config.yaml
42-
good-api-query-log.csv
43-
ignore_queries_for_checksum_regex.txt
4442
input_file.ndjson.zst
4543
possibly: lineage_definitions.yaml
4644
preprocessing_config.yaml
45+
queries/ignore_queries_for_checksum_regex.txt
46+
queries/queries.ndjson
4747
reference_genomes.json
48-
silo_queries.ndjson
48+
49+
Note that a file `queries/good-api-query-log.csv` is automatically
50+
stored upon the first benchmarking run; it is assumed to contain
51+
the proper checksums. Later runs compare against that file and
52+
flag differences that are not ignored via the regex in
53+
`ignore_queries_for_checksum_regex.txt` (leave empty to not ignore
54+
anything) as errors. If that happens, you are to check which
55+
version is legit, or ignore those queries via the regex. The regex
56+
syntax is the one supported by [Rust's regex
57+
crate](https://docs.rs/regex/1.12.2/regex/).
58+
59+
If you use the `QUERIES` evobench custom variable (i.e. env
60+
variable), which names a subfolder, you need to provide a
61+
corresponding alternative folder to the `queries/` folder.
4962

5063
1. Run an instance of a daemon, `evobench-run --verbose run daemon`
5164
(the `--verbose` allows you to see what's going on, feel free to

0 commit comments

Comments
 (0)