-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a575cee
commit a585d7b
Showing
4 changed files
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,9 @@ | ||
This folder contains code for benchmarking. | ||
|
||
There are three benchmarking directories: | ||
|
||
- ``comparison``: for comparing `whenever` with other datetime libraries. | ||
- ``python``: for benchmarking the library "end-to-end" in Python. | ||
- ``rust``: for benchmarking specific parts of the library in Rust. | ||
|
||
Benchmarking as part of CI is currently incomplete and work-in-progress. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,25 @@ | ||
# Benchmark comparisons | ||
|
||
## Running the benchmarks | ||
|
||
```shell | ||
python benchmarks/comparison/run_whenever.py | ||
python benchmarks/comparison/run_stdlib.py | ||
python benchmarks/comparison/run_pendulum.py | ||
python benchmarks/comparison/run_arrow.py | ||
``` | ||
|
||
Tip: make sure to build `whenever` in release mode before running the benchmarks! | ||
|
||
## Generating the graphs | ||
|
||
- Copy the `graph-vega-config.json` into https://vega.github.io/editor/#/ | ||
- Comment-out parts to get the light and dark versions | ||
- Export as svg | ||
- Add `font-weight="bold"` to the first appearance of "Whenever" | ||
- Set `width="500"` and `height="127"` | ||
|
||
## Setup for the benchmark in the main README | ||
|
||
The benchmarking graph in the main README was generated on | ||
a 2021 M1 Pro Macbook, MacOS 14.5 on Python 3.12.2 |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters