Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add boilerplate for using swift-collection-benchmarks. #158

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

LemonSpike
Copy link
Contributor

@LemonSpike LemonSpike commented Jul 30, 2021

Replace this paragraph with a description of your changes and rationale. Provide links to an existing issue or external references/discussions, if appropriate.

Checklist

  • I've added at least one test that validates that my change is working, if appropriate
  • I've followed the code style of the rest of the project
  • I've read the Contribution Guidelines
  • I've updated the documentation if necessary

Add baseline interspersed-results and interspersed-chart.png.

Update CONTRIBUTING.md for benchmarking instructions.
@LemonSpike
Copy link
Contributor Author

I am open to your feedback on this PR. This PR addresses benchmarking concerns raised in #110.

@LemonSpike LemonSpike marked this pull request as ready for review July 30, 2021 17:22
CONTRIBUTING.md Outdated
Comment on lines 14 to 24
For benchmarking of particular algorithms, please use the

`algorithms-benchmark` executable target. For convenience, this target

already imports `Algorithms`.

Example usage:

`$ swift run -c release algorithms-benchmark run <name-of-results-file> --cycles 5`

`$ swift run -c release algorithms-benchmark render <name-of-results-file> <name-of-chart-file>.png`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what happened here with the extra empty lines, but could you remove those? The markdown file now doesn't render properly because of them

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants