X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=benchmarks%2FREADME.md;h=33b81f4e7018bbf1f2d12620207da113b23357d9;hb=660689f017615c233020793967822c31975e5aa0;hp=66b7abb26a2997cea9977dcdd537da7be4a6e9dd;hpb=bd0e5c4dda309d307e83ddfd8a974df631fc21da;p=poolifier.git diff --git a/benchmarks/README.md b/benchmarks/README.md index 66b7abb2..33b81f4e 100644 --- a/benchmarks/README.md +++ b/benchmarks/README.md @@ -4,40 +4,44 @@ Welcome to poolifier benchmarks and thanks to look into this project. ## Folder Structure -The internal folder contains poolifier internal benchmarks. -The versus-external-pools folder contains benchmarks versus other Node.js pools. +The [internal](./internal) folder contains poolifier internal benchmark. +The [versus-external-pools](./versus-external-pools) folder contains benchmark versus other Node.js pools. ## Poolifier vs other pools benchmark 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. -External pools with which we compared the poolifier results: +We chose to use this tool because it allows to run isolated Node.js processes so each pool does not impact each other. -- [piscina](https://github.com/piscinajs/piscina) -- [SUCHMOKUO/node-worker-threads-pool](https://github.com/SUCHMOKUO/node-worker-threads-pool) -- [threads.js](https://github.com/andywer/threads.js/) -- [workerpool](https://github.com/josdejong/workerpool) -- [threadwork](https://github.com/kevlened/threadwork) -- [microjob](https://github.com/wilk/microjob) - +- External pools with which we compare the poolifier results: -Those are our results: + - [piscina](https://github.com/piscinajs/piscina) + - [tinypool](https://github.com/tinylibs/tinypool) + - [workerpool](https://github.com/josdejong/workerpool) + - [worker-nodes](https://github.com/allegro/node-worker-nodes) + - [node-worker-threads-pool](https://github.com/SUCHMOKUO/node-worker-threads-pool) + - [nanothreads](https://github.com/snuffyDev/nanothreads) -- CPU Intensive task with 100k operations submitted to each pool [BENCH-100000.md](./versus-external-pools/BENCH-100000.md). + Those are our results: -> :warning: **We would need funds to run our benchmarks more often and on Cloud VMs, please consider to sponsor this project** + - CPU Intensive task with 100k operations submitted to each pool: [BENCH-100000.md](./versus-external-pools/BENCH-100000.md). -## How to run benchmarks +- External pools with which we used to compare the poolifier results: -### Internal + -To run the internal benchmark you just need to navigate to the root of poolifier project and run `npm run benchmark` + - [worker-threads-pool](https://github.com/watson/worker-threads-pool): removed because unmaintained since more than 4 years. + - [threadwork](https://github.com/kevlened/threadwork): removed because unmaintained since more than 3 years. + - [microjob](https://github.com/wilk/microjob): removed because unmaintained since more than 5 years. + - [threads.js](https://github.com/andywer/threads.js/): removed because not a threads pool. -## Versus other pools +> :warning: **We would need funds to run our benchmark more often and on Cloud VMs, please consider to sponsor this project** -To run the benchmark versus other pools you will need to: +Read the [README.md](./versus-external-pools/README.md) to know how to run the benchmark. -- [Install hyperfine](https://github.com/sharkdp/hyperfine#installation) -- Run the `./bench.sh` into the `versus-external-pools` folder +## Poolifier internal benchmark -> :warning: **Please be sure to use a quite PC when you run the benchmarks** +### Usage + +To run the internal benchmark, you just need to navigate to the root of poolifier project and run `pnpm benchmark`. + +### [Results](https://poolifier.github.io/benchmark-results/dev/bench)