documentation-generator

Automate benchmark README table, speedup plot, and metadata updates.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Benchmark documentation often lags behind results; this skill automates updating README tables, speedup plots, and library metadata to ensure fresh, accurate reports.

Core Features & Use Cases

  • Automates updating benchmark READMEs with current results and tables.
  • Generates speedup plots and per-library metadata for quick comparisons.
  • Use Case: when new results are available, run the tool to refresh all docs in one step.

Quick Start

Run the update_docs.sh script to refresh all benchmark documentation.

Frequently Asked Questions about documentation-generator

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

FAQPage Schema
How do I automate updating benchmark README tables and speedup plots?

You can automate benchmark documentation updates by running the update_docs.sh script, which ingests current results and refreshes README tables, speedup plots, and library metadata in one step. This ensures your benchmark reports stay accurate without manual editing.

What is the best way to refresh image and video benchmark documentation in CI?

The best way to refresh benchmark documentation in CI is coordinating scripts under tools/ via update_docs.sh, which renders consistent docs for both image and video sections. It consolidates tables and generates plots automatically during your pipeline.

Can I generate per-library metadata comparisons for benchmark results?

Yes, you can generate per-library metadata for quick comparisons by running the documentation automation script. It renders library metadata alongside updated benchmark tables and speedup plots to provide consistent performance comparisons.

Does the documentation generator work without external dependencies?

Yes, the documentation generator works without external dependencies, requiring only your local environment or CI runner. It coordinates internal scripts under tools/ to ingest results and render documentation via update_docs.sh.

When do I need to run update_docs.sh for benchmark documentation?

You need to run update_docs.sh when new benchmark results are available and your README tables or speedup plots are lagging behind. It refreshes all image and video benchmark documentation, including table consolidation and plot generation, in a single step.