X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=benchmarks%2FREADME.md;h=27467511aaee25a534213894915b3f31a89038e9;hb=8258e525b4601510a20b909632f88a3604c7bc63;hp=8ad75e1c4d10c4e0a447026145c1bd473d8a26b8;hpb=3b314e4d3ac8d5023266c0c2e217a98886ea9ac7;p=poolifier.git diff --git a/benchmarks/README.md b/benchmarks/README.md index 8ad75e1c..27467511 100644 --- a/benchmarks/README.md +++ b/benchmarks/README.md @@ -1,39 +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](./internal) folder contains poolifier internal benchmarks. -The [versus-external-pools](./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 each pool does not impact each other. -External pools with which we compared the poolifier results: - -- [piscina](https://github.com/piscinajs/piscina) -- [tinypool](https://github.com/tinylibs/tinypool) -- [node-worker-threads-pool](https://github.com/SUCHMOKUO/node-worker-threads-pool): removed from the benchmark because does not support ESM modules -- [workerpool](https://github.com/josdejong/workerpool) -- [worker-nodes](https://github.com/allegro/node-worker-nodes) -- [threads.js](https://github.com/andywer/threads.js/) -- [threadwork](https://github.com/kevlened/threadwork) -- [microjob](https://github.com/wilk/microjob) +## 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 -> :warning: **We would need funds to run our benchmarks more often and on Cloud VMs, please consider to sponsor this project** +See the dedicated repository [README.md](https://github.com/poolifier/benchmark#readme). -## How to run benchmarks +## Poolifier internal benchmark -### Internal +### Usage -To run the internal benchmarks, you just need to navigate to the root of poolifier project and run `pnpm benchmark` +To run the internal benchmark, you just need to navigate to the root of poolifier cloned repository and run: -## Versus other pools +- `pnpm benchmark:benchmark.js` or +- `pnpm benchmark:tatami-ng` -Read [README.md](./versus-external-pools/README.md) +### [Results](https://bencher.dev/perf/poolifier)