X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=benchmarks%2FREADME.md;h=b2ee433623eb33ef9beea016b74ea6fd0a5105dc;hb=4be58f3c4495ba79ee81aa32064bebea185a24b5;hp=d368e86121a2d57cfcac3ae825100ff1d0022360;hpb=75876e4c557ce7fcb132929185777e535e244d0d;p=poolifier.git diff --git a/benchmarks/README.md b/benchmarks/README.md index d368e861..b2ee4336 100644 --- a/benchmarks/README.md +++ b/benchmarks/README.md @@ -4,37 +4,40 @@ 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 benchmarks. +The [versus-external-pools](./versus-external-pools) folder contains benchmarks 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/) +- 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). - This benchmark ran on a MacBook Pro 2015, 2,2 GHz Intel Core i7 quad-core, 16 GB 1600 MHz DDR3. + 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 benchmarks 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 these benchmarks. -- [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** +To run the internal benchmarks, you just need to navigate to the root of poolifier project and run `pnpm benchmark`