Skip to content

Commit

Permalink
polish README
Browse files Browse the repository at this point in the history
  • Loading branch information
jiacai2050 committed Dec 18, 2024
1 parent 25d87b7 commit d6c7d9b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 13 deletions.
19 changes: 6 additions & 13 deletions src/benchmarks/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,15 @@
# Benchmarks

## Test Data
todo
A config template can be found in [here](config.toml).

## Config
A config template can be found in `config/bench.toml`.

## Run benchmarks
## How to run
```bash
ANALYTIC_BENCH_CONFIG_PATH=/path/to/bench.toml cargo bench -p benchmarks
ANALYTIC_BENCH_CONFIG_PATH=/path/to/config cargo bench -p benchmarks
```

Print logs:
```bash
RUST_LOG=info ANALYTIC_BENCH_CONFIG_PATH=/path/to/bench.toml cargo bench -p benchmarks
```
Set `RUST_LOG=debug` to enable verbose log.

Run specific bench:
## Run specific bench:
```bash
ANALYTIC_BENCH_CONFIG_PATH=/path/to/bench.toml cargo bench --bench bench -p benchmarks -- bench_encoding
ANALYTIC_BENCH_CONFIG_PATH=/path/to/config cargo bench --bench bench -p benchmarks -- bench_encoding
```
File renamed without changes.

0 comments on commit d6c7d9b

Please sign in to comment.