Skip to content

feat: update benchmark results schema and enhance documentation#116

Merged
TKorr merged 1 commit into
mainfrom
refactor/bench-support
Apr 27, 2026
Merged

feat: update benchmark results schema and enhance documentation#116
TKorr merged 1 commit into
mainfrom
refactor/bench-support

Conversation

@TKorr

@TKorr TKorr commented Apr 27, 2026

Copy link
Copy Markdown
Contributor
  • Bumped the benchmark results schema version to 1.2.0, allowing for new optional fields.
  • Introduced stable identifiers for benchmark cases to improve compile-time safety.
  • Updated ScanResistanceStats and AdaptationStats structs to include new fields for better metrics tracking.
  • Enhanced the OpModel trait documentation to clarify its purpose and usage.
  • Added a policy selection guide in Markdown format to assist users in choosing appropriate cache policies based on use cases.

These changes improve the clarity and usability of benchmark results, while also enhancing the observability of cache performance metrics.

Description

Related Issue

Fixes #

Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 📝 Documentation update
  • 🔧 Refactoring (no functional changes)
  • ⚡ Performance improvement
  • 🧪 Test addition or modification

How Has This Been Tested?

  • Unit tests
  • Integration tests
  • Manual testing

Test environment:

  • OS:
  • Rust version:

Checklist

  • My code follows the project's coding standards
  • I have run cargo fmt and cargo clippy
  • I have added tests for my changes
  • All new and existing tests pass (cargo test)
  • I have updated the documentation as needed
  • I have added an entry to CHANGELOG.md (if applicable)

Screenshots (if applicable)

Additional Notes

- Bumped the benchmark results schema version to 1.2.0, allowing for new optional fields.
- Introduced stable identifiers for benchmark cases to improve compile-time safety.
- Updated `ScanResistanceStats` and `AdaptationStats` structs to include new fields for better metrics tracking.
- Enhanced the `OpModel` trait documentation to clarify its purpose and usage.
- Added a policy selection guide in Markdown format to assist users in choosing appropriate cache policies based on use cases.

These changes improve the clarity and usability of benchmark results, while also enhancing the observability of cache performance metrics.
@TKorr TKorr merged commit 68251c7 into main Apr 27, 2026
17 checks passed
@TKorr TKorr deleted the refactor/bench-support branch April 27, 2026 12:52
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.

1 participant