Skip to content

Commit 1ff601b

Browse files
author
Douglas Blank
committed
Update README
1 parent 4d77ae7 commit 1ff601b

File tree

1 file changed

+80
-2
lines changed

1 file changed

+80
-2
lines changed

README.md

Lines changed: 80 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -424,18 +424,96 @@ For more information, `cometx update --help`
424424
## cometx admin
425425

426426
```
427-
cometx admin [-h] [--host HOST] [--debug] ACTION [YEAR-MONTH]
427+
cometx admin [-h] [--host HOST] [--debug] ACTION [ARGUMENTS ...]
428428
```
429429

430430
To perform admin functions
431431

432+
### Actions
433+
434+
#### chargeback-report
435+
436+
Generate a chargeback report from the Comet server.
437+
438+
```
439+
cometx admin chargeback-report [YEAR-MONTH]
440+
```
441+
442+
**Arguments:**
443+
* `YEAR-MONTH` (optional, deprecated) - The YEAR-MONTH to run report for, eg 2024-09. If not provided, generates a report for all available periods.
444+
445+
**Output:**
446+
* Saves a JSON file: `comet-chargeback-report.json` (or `comet-chargeback-report-{YEAR-MONTH}.json`)
447+
448+
**Examples:**
449+
```
432450
cometx admin chargeback-report
451+
<<<<<<< Updated upstream
433452
cometx admin usage-report
453+
=======
454+
cometx admin chargeback-report 2024-09
455+
```
456+
>>>>>>> Stashed changes
434457
435-
### Flags
458+
#### usage-report
459+
460+
Generate a usage report with experiment counts and statistics for one or more workspaces/projects.
461+
462+
```
463+
cometx admin usage-report WORKSPACE [WORKSPACE ...]
464+
cometx admin usage-report WORKSPACE/PROJECT [WORKSPACE/PROJECT ...]
465+
cometx admin usage-report --app
466+
```
467+
468+
**Arguments:**
469+
* `WORKSPACE_PROJECT` (required, one or more, unless using `--app`) - One or more `WORKSPACE` or `WORKSPACE/PROJECT` to run usage report for. If `WORKSPACE` is provided without a project, all projects in that workspace will be included.
470+
471+
**Options:**
472+
* `--units {month,week,day,hour}` - Time unit for grouping experiments (default: month)
473+
* `month`: Group by month (YYYY-MM format)
474+
* `week`: Group by ISO week (YYYY-WW format)
475+
* `day`: Group by day (YYYY-MM-DD format)
476+
* `hour`: Group by hour (YYYY-MM-DD-HH format)
477+
* `--max-experiments-per-chart N` - Maximum number of workspaces/projects per chart (default: 5). If more workspaces/projects are provided, multiple charts will be generated.
478+
* `--no-open` - Don't automatically open the generated PDF file after generation.
479+
* `--app` - Launch interactive Streamlit web app instead of generating PDF. When using this option, you don't need to specify workspace/project arguments.
480+
481+
**Output:**
482+
* **PDF Report** (default): Generates a PDF report containing:
483+
* Summary statistics (total experiments, users, run times, GPU utilization)
484+
* Experiment count charts by time unit
485+
* GPU utilization charts (if GPU data is available)
486+
* GPU memory utilization charts (if GPU data is available)
487+
* **Interactive Web App** (with `--app`): Launches a Streamlit web interface where you can:
488+
* Select workspace and project from dropdowns
489+
* View statistics and charts interactively
490+
* Change time units and regenerate reports
491+
* View "All Projects" from a workspace
492+
493+
**Examples:**
494+
```
495+
# Generate report for a single workspace
496+
cometx admin usage-report my-workspace
497+
498+
# Generate report for multiple projects
499+
cometx admin usage-report my-workspace/project1 my-workspace/project2
500+
501+
# Generate report with weekly grouping
502+
cometx admin usage-report workspace1 workspace2 --units week
503+
504+
# Generate report with daily grouping, don't auto-open
505+
cometx admin usage-report workspace --units day --no-open
506+
507+
# Launch interactive web app
508+
cometx admin usage-report --app
509+
```
510+
511+
### Global Flags
436512

437513
* `--host HOST` - Override the HOST URL
438514
* `--debug` - If given, allow debugging
515+
* `--api-key API_KEY` - Set the COMET_API_KEY
516+
* `--url-override URL_OVERRIDE` - Set the COMET_URL_OVERRIDE
439517

440518
For more information, `cometx admin --help`
441519

0 commit comments

Comments
 (0)