benchmark-results-publisher

Convert benchmark result JSONs into documentation-ready tables and figures.

95|3|Updated Oct 25, 2024
One-click install
npx skills add https://github.com/albumentations-team/benchmark --skill benchmark-results-publisher
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: benchmark-results-publisher
Source: https://github.com/albumentations-team/benchmark/tree/main/.cursor/skills/benchmark-results-publisher
Command: npx skills add https://github.com/albumentations-team/benchmark --skill benchmark-results-publisher

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Publishes benchmark artifacts into documentation by converting results into safe, readme-friendly formats.

Core Features & Use Cases

  • Automates conversion of result JSONs into documentation-ready tables and figures.
  • Enforces guardrails to prevent leaking raw pyperf data and untenable artifacts.
  • Integrates with existing README/docs workflows to keep benchmarks up-to-date.

Quick Start

Run the update_docs.sh script to refresh documentation with the latest benchmark results.

Frequently Asked Questions about benchmark-results-publisher

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update README tables with benchmark results safely?

You can update README tables safely by publishing benchmark result JSONs through a validated conversion process. This approach integrates with existing docs workflows to prevent raw pyperf data from polluting your documentation.

Why does pyperf raw JSON pollute documentation?

Raw pyperf JSON files pollute documentation because they contain verbose performance data unsuitable for readme tables. Validating summary files as *_results.json prevents this raw data from entering your docs.

How do I convert benchmark JSONs into documentation-ready formats?

Convert benchmark JSONs into documentation-ready formats by running the update_docs.sh script. This automates the conversion of result data into safe, readme-friendly tables and figures while excluding gcp_runs/ and output/ artifacts.

Can I include Pillow benchmark results for public docs?

Yes, you can include Pillow benchmark results for public docs when available. The publishing process ensures Pillow results are preserved specifically for website documentation alongside MacBook RGB results.

What artifacts should be excluded when publishing benchmark results to docs?

Exclude gcp_runs/ and output/ artifacts when publishing benchmark results to docs. Additionally, avoid raw pyperf files (*.pyperf.json) and only validate summary files matching the *_results.json naming convention.

Does benchmark-results-publisher work with existing README workflows?

Yes, benchmark-results-publisher integrates with existing README/docs workflows to keep benchmarks up-to-date. It automates the safe conversion of result JSONs into documentation-ready tables without disrupting your current documentation process.