https://github.com/comet-ml/mlops-actions
https://github.com/comet-ml/mlops-actions
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/comet-ml/mlops-actions
- Owner: comet-ml
- Created: 2020-10-27T14:58:58.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-10-27T15:01:59.000Z (over 5 years ago)
- Last Synced: 2025-04-03T02:54:46.700Z (about 1 year ago)
- Language: Python
- Size: 87.9 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Comet.ml Github Actions examples
This repository contains Github Actions to interact with the Comet.ml API.
## Chatops
The [chatops Github Action](https://github.com/comet-ml/mlops-actions-test/blob/master/.github/workflows/chatops.yml) support the following commands:
### Get Comet Experiment
If you want to get a summary information about a given experiment in a github PR, you can write a comment in the following format:
```
/get-comet-experiment WORKSPACE/PROJECT_NAME/EXPERIMENT_ID
```
This will retrieve the information from the Comet.ml API and write back a Github comment with a summary of the current value of the experiment metrics and hyper-parameters.
The file implementing this chatops action is located in [actions_files/get_comet_experiment.py](actions_files/get_comet_experiment.py).
This chatops action require to have access to a Github secret named `COMET_API_KEY` that is set to the Comet API Key that have access to the wanted experiments.
Here is an example:

You can try it yourself, first find a public experiment in the [demo workspace](https://www.comet.ml/demo), note its project name and experiment id, then on any pull-request (for example [the first one](../../pull/1)) comment like this:
```
/get-comet-experiment demo/PROJECT_NAME/EXPERIMENT_ID
```