Skip to content

Commit bf6498e

Browse files
committed
Update READMEs
1 parent 0594dc6 commit bf6498e

File tree

4 files changed

+82
-6
lines changed

4 files changed

+82
-6
lines changed

MIGRATIONS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Migrating Projects/Experiments
22

3-
As described in the [README](README.md), you can instruct `cometx` to
3+
As described in the [README](https://github.com/comet-ml/cometx/blob/main/README.md), you can instruct `cometx` to
44
download data from and copy data to:
55

66
* experiment to experiment

README-ADMIN.md

Lines changed: 76 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ If your installation does not support Comet Smart Keys, or your host is at an un
2828
```shell
2929
cometx admin chargeback-report --host https://another-url.com
3030
```
31-
The usage report contains the following fields in JSON format:
31+
32+
## chargeback-report
33+
34+
The chargeback report contains the following fields in JSON format:
3235

3336
- **"numberOfUsers":** total user entries in the report
3437
- **"createdAt":** date the report was generated,
@@ -43,5 +46,75 @@ Each user entry in the report contains:
4346
- **“suspended”**: boolean flag true/false to indicate if the user has been suspended.
4447
- **“uiUsageCount”**: Number of UI interactions a user has made.
4548
- **“uiUsageUpdateTs”**: Timestamp of the last update to uiUsageCount.
46-
- **“sdkUsageCount”**: Number of SDK interactions a user has made.
47-
- **“sdkUsageUpdateTs”:** Timestamp of the last update to sdkUsageCount.
49+
- **"sdkUsageCount"**: Number of SDK interactions a user has made.
50+
- **"sdkUsageUpdateTs":** Timestamp of the last update to sdkUsageCount.
51+
52+
## usage-report
53+
54+
Generate a usage report with experiment counts and statistics for one or more workspaces/projects.
55+
56+
### Basic Usage
57+
58+
```shell
59+
cometx admin usage-report WORKSPACE
60+
cometx admin usage-report WORKSPACE/PROJECT
61+
cometx admin usage-report WORKSPACE1 WORKSPACE2
62+
cometx admin usage-report WORKSPACE/PROJECT1 WORKSPACE/PROJECT2
63+
```
64+
65+
### Interactive Web App
66+
67+
Launch an interactive Streamlit web app to select workspaces and projects from dropdown menus:
68+
69+
```shell
70+
cometx admin usage-report --app
71+
```
72+
73+
### Options
74+
75+
- **`--units {month,week,day,hour}`**: Time unit for grouping experiments (default: `month`)
76+
- `month`: Group by month (YYYY-MM format)
77+
- `week`: Group by ISO week (YYYY-WW format)
78+
- `day`: Group by day (YYYY-MM-DD format)
79+
- `hour`: Group by hour (YYYY-MM-DD-HH format)
80+
81+
- **`--max-experiments-per-chart N`**: Maximum number of workspaces/projects per chart (default: 100). If more workspaces/projects are provided, multiple charts will be generated.
82+
83+
- **`--no-open`**: Don't automatically open the generated PDF file after generation.
84+
85+
- **`--app`**: Launch interactive Streamlit web app instead of generating PDF.
86+
87+
### Examples
88+
89+
```shell
90+
# Generate a report for a single workspace
91+
cometx admin usage-report my-workspace
92+
93+
# Generate a report for multiple projects
94+
cometx admin usage-report my-workspace/project1 my-workspace/project2
95+
96+
# Generate a report grouped by week instead of month
97+
cometx admin usage-report workspace1 workspace2 --units week
98+
99+
# Generate a report grouped by day without auto-opening
100+
cometx admin usage-report workspace --units day --no-open
101+
102+
# Launch interactive web app
103+
cometx admin usage-report --app
104+
```
105+
106+
### Output
107+
108+
The usage report generates a PDF file containing:
109+
110+
- **Summary statistics**: Total experiments, users, run times, GPU utilization
111+
- **Experiment count charts**: Grouped by the specified time unit (month, week, day, or hour)
112+
- **GPU utilization charts**: If GPU data is available for the experiments
113+
- **GPU memory utilization charts**: If GPU data is available for the experiments
114+
115+
Multiple workspaces/projects are combined into a single chart with a legend. If more workspaces/projects are provided than the `--max-experiments-per-chart` limit, multiple charts will be generated.
116+
117+
When using the `--app` flag, an interactive web interface is launched where you can:
118+
- Select workspace and project from dropdowns
119+
- View statistics and charts interactively
120+
- Change time units and regenerate reports

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -430,6 +430,7 @@ cometx admin [-h] [--host HOST] [--debug] ACTION [YEAR-MONTH]
430430
To perform admin functions
431431

432432
cometx admin chargeback-report
433+
cometx admin usage-report
433434

434435
### Flags
435436

@@ -438,6 +439,8 @@ cometx admin chargeback-report
438439

439440
For more information, `cometx admin --help`
440441

442+
> **Note**: For detailed information on admin commands, see [README-ADMIN.md](https://github.com/comet-ml/cometx/blob/main/README-ADMIN.md).
443+
441444
## cometx smoke-test
442445

443446
```

cometx/cli/admin.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
- hour: Group by hour (YYYY-MM-DD-HH format)
5151
5252
--max-experiments-per-chart N
53-
Maximum number of workspaces/projects per chart (default: 5).
53+
Maximum number of workspaces/projects per chart (default: 100).
5454
If more workspaces/projects are provided, multiple charts will be generated.
5555
5656
--no-open
@@ -221,7 +221,7 @@ def get_parser_arguments(parser):
221221
)
222222
usage_parser.add_argument(
223223
"--max-experiments-per-chart",
224-
help="Maximum number of workspaces/projects per chart (default: 5). If more are provided, multiple charts will be generated.",
224+
help="Maximum number of workspaces/projects per chart (default: 100). If more are provided, multiple charts will be generated.",
225225
type=int,
226226
default=None,
227227
metavar="N",

0 commit comments

Comments
 (0)