feat: update benchmark results schema and enhance documentation#116
Merged
Conversation
- 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
ScanResistanceStatsandAdaptationStatsstructs to include new fields for better metrics tracking.OpModeltrait documentation to clarify its purpose and usage.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
How Has This Been Tested?
Test environment:
Checklist
cargo fmtandcargo clippycargo test)Screenshots (if applicable)
Additional Notes