Skip to content

Add guide for custom benchmark scripts#96

Merged
gpauloski merged 5 commits intomainfrom
programmatic-guide
Jul 17, 2024
Merged

Add guide for custom benchmark scripts#96
gpauloski merged 5 commits intomainfrom
programmatic-guide

Conversation

@gpauloski
Copy link
Copy Markdown
Contributor

Description

Add guide for custom benchmark scripts. Also made some minor code improvements since this guide will encourage users to use more aspects of the package.

Fixes N/A

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (internal implementation changes)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (no changes to the code)
  • CI change (changes to CI workflows, packages, templates, etc.)
  • Version changes (changes to the package or dependency versions)

Testing

Testing the code examples in the docs.

Pull Request Checklist

Please confirm the PR meets the following requirements.

  • Relevant tags are added (breaking, bug, dependencies, documentation, enhancement, refactor).
  • Code changes pass pre-commit (e.g., ruff, mypy, etc.).
  • Tests have been added to show the fix is effective or that the new feature works.
  • New and existing unit tests pass locally with the changes.
  • Docs have been updated and reviewed if relevant.

@gpauloski gpauloski added documentation Improvements or additions to documentation internal Refactoring, style changes, testing, or code optimizations labels Jul 17, 2024
@gpauloski gpauloski merged commit 7672d16 into main Jul 17, 2024
@gpauloski gpauloski deleted the programmatic-guide branch July 17, 2024 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation internal Refactoring, style changes, testing, or code optimizations

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant