https://github.com/iterative/cml_tensorboard_case
https://github.com/iterative/cml_tensorboard_case
example
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/iterative/cml_tensorboard_case
- Owner: iterative
- Created: 2020-06-08T22:21:44.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-30T15:11:24.000Z (almost 3 years ago)
- Last Synced: 2025-10-21T17:53:10.765Z (3 months ago)
- Topics: example
- Language: Python
- Size: 29.3 KB
- Stars: 8
- Watchers: 13
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CML with Tensorboard use case
This repository contains a sample project using [CML](https://github.com/iterative/cml) with Tensorboard.dev to track model training in real-time. When a pull request is made, the following steps occur:
- GitHub will deploy a runner machine with a specified CML Docker environment
- A Tensorboard.dev page will be created
- CML will report a link to the Tensorboard as a comment in the pull request
- The runner will execute a workflow to train a ML model (`python train.py`)
The key file enabling these actions is `.github/workflows/cml.yaml`.
## Secrets and environmental variables
In this example, `.github/workflows/cml.yaml` contains two environmental variables that are stored as repository secrets.
| Secret | Description |
|---|---|
| GITHUB_TOKEN | This is set by default in every GitHub repository. It does not need to be manually added. |
| TB_CREDENTIALS | Tensorboard credentials |
To access your Tensorboard credentials:
1. On your local machine, run `tensorboard dev upload`
2. Accept the TOS and follow the authentication procedure.
3. When you have authenticated, copy your credentials out of `~/.config/tensorboard/credentials/uploader-creds.json` (this is the typical path for OSX/Linux systems). Paste these credentials as the secret TB_CREDENTIALS.
## Cloning this project
Note that if you clone this project, you will have to configure your own TB credentials for the example.