Setting the file. One moment.
Skill 21 · Huggingface Trackio
Subchapter 21.3
references/retrieving_metrics.mdMarkdown9 KBView on GitHub
The trackio CLI provides direct terminal access to query Trackio experiment tracking data locally without needing to start the MCP server.
| Task | Command |
|---|---|
| List projects | trackio list projects |
| List runs | trackio list runs --project <name> |
| List metrics | trackio list metrics --project <name> --run <name> |
| List system metrics | trackio list system-metrics --project <name> --run <name> |
| List alerts | trackio list alerts --project <name> [--run <name>] [--level <level>] [--since <timestamp>] |
| Get project summary | trackio get project --project <name> |
| Get run summary | trackio get run --project <name> --run <name> |
| Get metric values | trackio get metric --project <name> --run <name> --metric <name> |
| Get metric at step | trackio get metric ... --metric <name> --step <N> |
| Get metric around step | trackio get metric ... --metric <name> --around <N> --window <W> |
| Get all metrics snapshot | trackio get snapshot --project <name> --run <name> --step <N> |
| Get system metrics | trackio get system-metric --project <name> --run <name> |
| Show dashboard | trackio show [--project <name>] |
| Sync to Space | trackio sync --project <name> --space-id <space_id> |
trackio list projects # List all projects
trackio list projects --json # JSON output
trackio list runs --project <name> # List runs in project
trackio list runs --project <name> --json # JSON output
trackio list metrics --project <name> --run <name> # List metrics for run
trackio list metrics --project <name> --run <name> --json
trackio list system-metrics --project <name> --run <name> # List system metrics
trackio list system-metrics --project <name> --run <name> --json
trackio list alerts --project <name> # List alerts
trackio list alerts --project <name> --run <name> --json # Filter by run
trackio list alerts --project <name> --level error --json # Filter by level
trackio list alerts --project <name> --json --since <ts> # Poll since timestamptrackio get project --project <name> # Project summary
trackio get project --project <name> --json # JSON output
trackio get run --project <name> --run <name> # Run summary
trackio get run --project <name> --run <name> --json
trackio get metric --project <name> --run <name> --metric <name> # Metric values
trackio get metric --project <name> --run <name> --metric <name> --json
trackio get metric ... --metric <name> --step 200 # At exact step
trackio get metric ... --metric <name> --around 200 --window 10 # ±10 steps
trackio get metric ... --metric <name> --at-time <ts> --window 60 # ±60 seconds
trackio get snapshot --project <name> --run <name> --step 200 --json # All metrics at step
trackio get snapshot --project <name> --run <name> --around 200 --window 5 --json # Window
trackio get snapshot --project <name> --run <name> --at-time <ts> --window 60 --json
trackio get system-metric --project <name> --run <name> # All system metrics
trackio get system-metric --project <name> --run <name> --metric <name> # Specific metric
trackio get system-metric --project <name> --run <name> --jsontrackio show # Launch dashboard
trackio show --project <name> # Load specific project
trackio show --theme <theme> # Custom theme
trackio show --mcp-server # Enable MCP server
trackio show --color-palette "#FF0000,#00FF00" # Custom colorstrackio sync --project <name> --space-id <space_id> # Sync to HF Space
trackio sync --project <name> --space-id <space_id> --private # Private space
trackio sync --project <name> --space-id <space_id> --force # OverwriteAll list and get commands support two output formats:
--json flag): Structured JSON for programmatic use# List all available projects
trackio list projects
# List runs in a project
trackio list runs --project my-project
# Get project overview
trackio get project --project my-project --json# Get run summary with all metrics
trackio get run --project my-project --run my-run --json
# List available metrics
trackio list metrics --project my-project --run my-run
# Get specific metric values
trackio get metric --project my-project --run my-run --metric loss --json# List system metrics (GPU, etc.)
trackio list system-metrics --project my-project --run my-run
# Get all system metric data
trackio get system-metric --project my-project --run my-run --json
# Get specific system metric
trackio get system-metric --project my-project --run my-run --metric gpu_utilization --json# Extract latest metric value
LATEST_LOSS=$(trackio get metric --project my-project --run my-run --metric loss --json | jq -r '.values[-1].value')
# Export run summary to file
trackio get run --project my-project --run my-run --json > run_summary.json
# Filter runs with jq
trackio list runs --project my-project --json | jq '.runs[] | select(startswith("train"))'# 1. Discover available projects
trackio list projects --json
# 2. Explore project structure
trackio get project --project my-project --json
# 3. Inspect specific run
trackio get run --project my-project --run my-run --json
# 4. Query metric values
trackio get metric --project my-project --run my-run --metric accuracy --json
# 5. Poll for alerts (use --since for efficient incremental polling)
trackio list alerts --project my-project --json --since "2025-06-01T00:00:00"
# 6. When an alert fires at step N, get all metrics around that point
trackio get snapshot --project my-project --run my-run --around 200 --window 5 --jsonCommands validate inputs and return clear errors:
Error: Project '<name>' not found.Error: Run '<name>' not found in project '<project>'.Error: Metric '<name>' not found in run '<run>' of project '<project>'.All errors exit with non-zero status code and write to stderr.
--project: Project name (required for most commands)--run: Run name (required for run-specific commands)--metric: Metric name (required for metric-specific commands)--json: Output in JSON format instead of human-readable--step: Exact step filter (for get metric, get snapshot)--around: Center step for window filter (for get metric, get snapshot)--at-time: Center ISO timestamp for window filter (for get metric, get snapshot)--window: Window size: ±steps for --around, ±seconds for --at-time (default: 10)--level: Alert level filter (info, warn, error) (for list alerts)--since: ISO timestamp to filter alerts after (for list alerts)--theme: Dashboard theme (for show command)--mcp-server: Enable MCP server mode (for show command)--color-palette: Comma-separated hex colors (for show command)--private: Create private Space (for sync command)--force: Overwrite existing database (for sync command){"projects": ["project1", "project2"]}{"project": "my-project", "runs": ["run1", "run2"]}{
"project": "my-project",
"num_runs": 3,
"runs": ["run1", "run2", "run3"],
"last_activity": 100
}{
"project": "my-project",
"run": "my-run",
"num_logs": 50,
"metrics": ["loss", "accuracy"],
"config": {"learning_rate": 0.001},
"last_step": 49
}{
"project": "my-project",
"run": "my-run",
"metric": "loss",
"values": [
{"step": 0, "timestamp": "2024-01-01T00:00:00", "value": 0.5},
{"step": 1, "timestamp": "2024-01-01T00:01:00", "value": 0.4}
]
}