{"id":18300434,"url":"https://github.com/comet-ml/cometx","last_synced_at":"2026-01-06T21:20:39.948Z","repository":{"id":97138517,"uuid":"578817502","full_name":"comet-ml/cometx","owner":"comet-ml","description":"Open source contributions for integrations with comet_ml","archived":false,"fork":false,"pushed_at":"2025-03-07T15:25:48.000Z","size":310,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-03T02:54:46.512Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/comet-ml.png","metadata":{"files":{"readme":"README-ADMIN.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-16T00:23:05.000Z","updated_at":"2025-03-07T15:25:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"36f5a02f-73aa-44e4-a859-0d32256d949c","html_url":"https://github.com/comet-ml/cometx","commit_stats":null,"previous_names":["comet-ml/cometx"],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comet-ml%2Fcometx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comet-ml%2Fcometx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comet-ml%2Fcometx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comet-ml%2Fcometx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/comet-ml","download_url":"https://codeload.github.com/comet-ml/cometx/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247342710,"owners_count":20923642,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T15:12:28.784Z","updated_at":"2026-01-06T21:20:39.943Z","avatar_url":"https://github.com/comet-ml.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cometx admin\n\nTo use the `cometx admin` functions, you must be in an environment with Python installed.\n\nFirst, install the `cometx` Python library:\n\n```shell\npip install cometx --upgrade\n```\n\nNext, copy your COMET_API_KEY. Login into your Comet installation, and click on your image in the upper-righthand corner, select **API Key**, and click on key to copy:\n\n![image](https://github.com/user-attachments/assets/25d8f65b-974c-41d3-8709-4a63072d54a6)\n\nFinally run the following:\n\n```shell\nexport COMET_API_KEY=\u003cCOPY YOUR API KEY HERE\u003e\n\ncometx admin chargeback-report 2024-09 # for older Comet installations\ncometx admin chargeback-report         # for newer Comet installations\n```\n\n## Advanced\n\nIf your installation does not support Comet Smart Keys, or your host is at an unusual location, you can also use the `--host` flag as shown:\n\n```shell\ncometx admin chargeback-report --host https://another-url.com\n```\n\n## chargeback-report\n\nThe chargeback report contains the following fields in JSON format:\n\n- **\"numberOfUsers\":** total user entries in the report\n- **\"createdAt\":** date the report was generated,\n- **\"organizationId\":** The Comet org id\n\nEach user entry in the report contains:\n\n- **“username”:** The user’s Comet username.\n- **“email”:** The user’s email address associated with Comet.\n- **“created_at”:** The date the user was created.\n- **“deletedAt”:** The date the user was deleted (for deleted users only).\n- **“suspended”**: boolean flag true/false to indicate if the user has been suspended.\n- **“uiUsageCount”**: Number of UI interactions a user has made.\n- **“uiUsageUpdateTs”**: Timestamp of the last update to uiUsageCount.\n- **\"sdkUsageCount\"**: Number of SDK interactions a user has made.\n- **\"sdkUsageUpdateTs\":** Timestamp of the last update to sdkUsageCount.\n\n## usage-report\n\nGenerate a PDF usage report with experiment counts and statistics for one or more workspaces/projects, or\nstart an interactive web application for dynamically creating charts and statistics.\n\n### PDF Generation Basic Usage\n\n```shell\ncometx admin usage-report WORKSPACE\ncometx admin usage-report WORKSPACE/PROJECT\ncometx admin usage-report WORKSPACE1 WORKSPACE2\ncometx admin usage-report WORKSPACE/PROJECT1 WORKSPACE/PROJECT2\n```\n\n### Interactive Web App\n\nLaunch an interactive Streamlit web app to select workspaces and projects from dropdown menus:\n\n```shell\ncometx admin usage-report --app\n```\n\n\u003cimg width=\"1638\" height=\"839\" alt=\"image\" src=\"https://github.com/user-attachments/assets/abdeab5e-a138-43c9-baab-0a6aa070afb6\" /\u003e\n\n\n### PDF Generation Options\n\n- **`--units {month,week,day,hour}`**: Time unit for grouping experiments (default: `month`)\n  - `month`: Group by month (YYYY-MM format)\n  - `week`: Group by ISO week (YYYY-WW format)\n  - `day`: Group by day (YYYY-MM-DD format)\n  - `hour`: Group by hour (YYYY-MM-DD-HH format)\n\n- **`--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.\n\n- **`--no-open`**: Don't automatically open the generated PDF file after generation.\n\n- **`--app`**: Launch interactive Streamlit web app instead of generating PDF.\n\n### Examples\n\n```shell\n# Generate a report for a single workspace\ncometx admin usage-report my-workspace\n\n# Generate a report for multiple projects\ncometx admin usage-report my-workspace/project1 my-workspace/project2\n\n# Generate a report grouped by week instead of month\ncometx admin usage-report workspace1 workspace2 --units week\n\n# Generate a report grouped by day without auto-opening\ncometx admin usage-report workspace --units day --no-open\n\n# Launch interactive web app\ncometx admin usage-report --app\n```\n\n### Output\n\nThe usage report generates a PDF file containing:\n\n- **Summary statistics**: Total experiments, users, run times, GPU utilization\n- **Experiment count charts**: Grouped by the specified time unit (month, week, day, or hour)\n- **GPU utilization charts**: If GPU data is available for the experiments\n- **GPU memory utilization charts**: If GPU data is available for the experiments\n\nMultiple 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.\n\nWhen using the `--app` flag, an interactive web interface is launched where you can:\n- Select workspace and project from dropdowns\n- View statistics and charts interactively\n- Change time units and regenerate reports\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomet-ml%2Fcometx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcomet-ml%2Fcometx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomet-ml%2Fcometx/lists"}