Skip to content

Commit

Permalink
docs: add benchmark results link to README
Browse files Browse the repository at this point in the history
Add link to online benchmark results viewer (https://mahdi-shojaee.github.io/parlo/)
in both the introduction and "Viewing Benchmark Results" sections for easier access
to performance comparisons.
  • Loading branch information
mahdi-shojaee committed Oct 27, 2024
1 parent 0025b05 commit 6347c1c
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Parlo is a Go library that provides utility functions for efficiently working wi

![ParSort Benchmark](charts/assets/parlo.ParSort.png)

View all benchmark results at: [https://mahdi-shojaee.github.io/parlo/](https://mahdi-shojaee.github.io/parlo/)

### Key Advantages:

* **Parallel Processing:** Parlo leverages Go's concurrency features to provide parallel versions of several functions. This allows you to utilize multiple CPU cores and significantly improve performance for large datasets.
Expand Down Expand Up @@ -67,7 +69,7 @@ cd charts
go run main.go [options] [benchmark names...]
```

Options:
##### Options:
- `-benchtime=<duration>`: Set the benchmark time for each test (default: 1s)

Note: Some benchmarks like `Sort` may require longer benchmark times for accurate results. Adjust the `-benchtime` flag accordingly when running these benchmarks.
Expand All @@ -93,6 +95,8 @@ To view the results:
1. Run `go run main.go -build` to generate the `benchmark-results.js` file.
2. Open `charts/benchmark-results-viewer/index.html` in a web browser.

You can also view the latest benchmark results online at: [https://mahdi-shojaee.github.io/parlo/](https://mahdi-shojaee.github.io/parlo/)

The viewer provides interactive charts comparing the performance of sequential and parallel functions across different input sizes and scenarios.

### Contributing:
Expand Down

0 comments on commit 6347c1c

Please sign in to comment.