X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=benchmarks%2FREADME.md;h=b2ee433623eb33ef9beea016b74ea6fd0a5105dc;hb=8cc4ea811611b8ad77c7b0379911afe497f2e7e4;hp=907d8649075444943d775798920034e00eecc95e;hpb=be0676b3936d75f22ce55b0f71a1fb03d008a01c;p=poolifier.git diff --git a/benchmarks/README.md b/benchmarks/README.md index 907d8649..b2ee4336 100644 --- a/benchmarks/README.md +++ b/benchmarks/README.md @@ -4,29 +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. +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. -We will add more details on each function that we benchmark. +- 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: -## How to run benchmarks + - CPU Intensive task with 100k operations submitted to each pool: [BENCH-100000.md](./versus-external-pools/BENCH-100000.md). -### Internal +- External pools with which we used to compare the poolifier results: -To run the internal benchmark you just need to navigate to the root of poolifier project and run `npm run benchmark` + -## Versus other pools + - [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. -To run the benchmark versus other pools you will need to: +> :warning: **We would need funds to run our benchmarks more often and on Cloud VMs, please consider to sponsor this project** -- [Install hyperfine](https://github.com/sharkdp/hyperfine#installation) -- Run the `./bench.sh` into the `versus-external-pools` folder +Read the [README.md](./versus-external-pools/README.md) to know how to run these benchmarks. + +## Poolifier internal benchmark + +To run the internal benchmarks, you just need to navigate to the root of poolifier project and run `pnpm benchmark`