Skip to content

Commit a493de6

Browse files
author
Douglas Blank
committed
Update README
1 parent 77f2a8a commit a493de6

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -508,6 +508,57 @@ cometx admin usage-report workspace --units day --no-open
508508
cometx admin usage-report --app
509509
```
510510

511+
#### gpu-report
512+
513+
Generate a GPU usage report for one or more workspaces/projects with detailed GPU metrics analysis.
514+
515+
```
516+
cometx admin gpu-report WORKSPACE [WORKSPACE ...] --start-date DATE
517+
cometx admin gpu-report WORKSPACE/PROJECT [WORKSPACE/PROJECT ...] --start-date DATE
518+
```
519+
520+
**Arguments:**
521+
* `WORKSPACE_PROJECT` (required, one or more) - One or more `WORKSPACE` or `WORKSPACE/PROJECT` to run GPU report for. If `WORKSPACE` is provided without a project, all projects in that workspace will be included.
522+
523+
**Options:**
524+
* `--start-date DATE` (required) - Start date for the report in YYYY-MM-DD format (e.g., `2024-01-01`)
525+
* `--end-date DATE` (optional) - End date for the report in YYYY-MM-DD format (e.g., `2024-12-31`). If not provided, reports from start-date onwards.
526+
* `--metrics METRIC [METRIC ...]` (optional) - List of metrics to track. If not provided, uses default GPU metrics:
527+
* `sys.gpu.0.gpu_utilization` - GPU utilization percentage
528+
* `sys.gpu.0.memory_utilization` - GPU memory utilization percentage
529+
* `sys.gpu.0.used_memory` - GPU memory used in GB
530+
* `sys.gpu.0.power_usage` - GPU power usage in watts
531+
* `sys.gpu.0.temperature` - GPU temperature in Celsius
532+
* `--open` - Automatically open the generated PDF file after generation.
533+
534+
**Output:**
535+
* Generates a PDF report containing:
536+
* Summary statistics (total experiments, workspaces, metrics tracked)
537+
* Breakdown by workspace (if multiple workspaces)
538+
* Average metrics by workspace charts (bar charts)
539+
* Maximum metrics by month charts (time series line charts with workspace legend)
540+
* Generates individual PNG chart files for each metric:
541+
* `gpu_report_avg_{metric}_by_workspace.png` - Average metric value per workspace
542+
* `gpu_report_max_{metric}_by_month.png` - Maximum metric value per month over time
543+
544+
**Examples:**
545+
```
546+
# Generate report for a single workspace from a start date
547+
cometx admin gpu-report my-workspace --start-date 2024-01-01
548+
549+
# Generate report with date range
550+
cometx admin gpu-report my-workspace --start-date 2024-01-01 --end-date 2024-12-31
551+
552+
# Generate report for multiple projects
553+
cometx admin gpu-report workspace1/project1 workspace2 --start-date 2024-01-01
554+
555+
# Generate report with custom metrics
556+
cometx admin gpu-report my-workspace --start-date 2024-01-01 --metrics sys.gpu.0.gpu_utilization sys.gpu.0.memory_utilization
557+
558+
# Generate report and automatically open PDF
559+
cometx admin gpu-report my-workspace --start-date 2024-01-01 --open
560+
```
561+
511562
### Global Flags
512563

513564
* `--host HOST` - Override the HOST URL

0 commit comments

Comments
 (0)