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