feat(benchsdk): add optional display manifest to BenchmarkConfig and upload it on upsert - #335
Open
dtice25 wants to merge 2 commits into
Open
feat(benchsdk): add optional display manifest to BenchmarkConfig and upload it on upsert#335dtice25 wants to merge 2 commits into
dtice25 wants to merge 2 commits into
Conversation
…hmark - Add optional BenchmarkConfig.display spec with metrics, steps, and overview defaults. - Validate display manifest in defineBenchmarkConfig. - Upload display config into benchmarks.config JSONB on upsert. - Export display types from @benchsdk/runner. - Add display manifest to browser-lifecycle benchmark. Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor License AgreementAll contributors are covered by a CLA. |
…arks Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
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.
Summary
This is the first end-to-end slice of making a
*.bench.tsfile the single source of truth for both benchmark execution and how the platform displays it.BenchmarkConfignow accepts an optionaldisplaymanifest (BenchmarkDisplayConfig) that declares:metrics: key, label, unit, decimal places, and direction (lower-better|higher-better).steps: human-readable labels and order for lifecycle steps.overview: default ranked metric and default layout (ranking|cards|chart|leaderboard).defineBenchmarkConfigvalidates the manifest (non-empty keys/labels, valid directions, no duplicate metric keys).@benchsdk/runnerso authors get autocomplete.runner.tsnow uploads the manifest into the platform's existingbenchmarks.configJSONB field viaclient.upsertBenchmark(..., { config: { display: ... } }).benchmarks/browser/browser.bench.tsis updated with a concretedisplaymanifest as a reference implementation.The platform counterpart (computesdk/benchmarks-platform#145) consumes this
config.displayto render labels, ranking direction, and default views without hard-coding the benchmark.Link to Devin session: https://app.devin.ai/sessions/a45e3a08012c47e989ccfc4c055275ac
Requested by: @dtice25