Skip to content

Generate VM monitor dashboard screenshots for README #8

@abrichr

Description

@abrichr

Overview

The vm monitor command now has comprehensive visibility features (commit afc7053), but the README needs screenshots showing what it looks like.

What Was Added

  • VM status (IP, size, power state)
  • Cost tracking (uptime, hourly rate, current cost)
  • Azure ML job tracking (recent jobs with status)
  • Activity detection (idle, benchmark running, etc.)
  • Evaluation history (--details flag)
  • Enhanced dashboard integration

Screenshots Needed

  1. Basic vm monitor output (6 sections)
  2. vm monitor --details output (with evaluation history)
  3. Example showing active benchmark
  4. Example showing cost calculation

Approach Options

Option A: Manual Screenshots (30 minutes)

  1. Start VM and run vm monitor
  2. Take screenshots with terminal screenshot tools
  3. Add to README.md with descriptions

Option B: Automated ASCII Recording (1-2 hours)

  1. Use asciinema to record terminal session
  2. Generate static PNG from recording with agg
  3. Automate in CI/CD for future updates
  4. Benefits: Always up-to-date, shows real data

Recommendation

Start with Option A (manual), consider Option B for future CI/CD integration.

Related Files

  • Enhanced command: openadapt_ml/benchmarks/cli.py
  • VM monitor utils: openadapt_ml/benchmarks/vm_monitor.py
  • Documentation: CLAUDE.md (vm monitor section)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions