X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=benchmarks%2FREADME.md;h=27467511aaee25a534213894915b3f31a89038e9;hb=5d5885ee530724024f84e31acca92775a01da082;hp=907d8649075444943d775798920034e00eecc95e;hpb=be0676b3936d75f22ce55b0f71a1fb03d008a01c;p=poolifier.git diff --git a/benchmarks/README.md b/benchmarks/README.md index 907d8649..27467511 100644 --- a/benchmarks/README.md +++ b/benchmarks/README.md @@ -1,32 +1,30 @@ -# Poolifier Benchmarks +# Poolifier benchmarks -Welcome to poolifier benchmarks and thanks to look into this project. +Welcome to poolifier benchmarks. -## Folder Structure - -The internal folder contains poolifier internal benchmarks. -The versus-external-pools folder contains benchmarks versus other Node.js pools. +## Table of contents -## Poolifier vs other pools benchmark +- [Folder Structure](#folder-structure) +- [Poolifier benchmark versus other worker pools](#poolifier-benchmark-versus-other-worker-pools) +- [Poolifier internal benchmark](#poolifier-internal-benchmark) + - [Usage](#usage) + - [Results](#results) -To compare poolifier pools performance vs other pools performance we chose to use [hyperfine](https://github.com/sharkdp/hyperfine). -We chose to use this tool because it allows to run isolated Node.js processes so that each pool does not impact each other. - -We will add more details on each function that we benchmark. +## Folder Structure -Those are our results: +The [internal](./internal) folder contains poolifier internal benchmark code. -- CPU Intensive task with 100k operations submitted to each pool [BENCH-100000.MD](./versus-external-pools/BENCH-100000.MD) +## Poolifier benchmark versus other worker pools -## How to run benchmarks +See the dedicated repository [README.md](https://github.com/poolifier/benchmark#readme). -### Internal +## Poolifier internal benchmark -To run the internal benchmark you just need to navigate to the root of poolifier project and run `npm run benchmark` +### Usage -## Versus other pools +To run the internal benchmark, you just need to navigate to the root of poolifier cloned repository and run: -To run the benchmark versus other pools you will need to: +- `pnpm benchmark:benchmark.js` or +- `pnpm benchmark:tatami-ng` -- [Install hyperfine](https://github.com/sharkdp/hyperfine#installation) -- Run the `./bench.sh` into the `versus-external-pools` folder +### [Results](https://bencher.dev/perf/poolifier)