Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sayakpaul committed Aug 9, 2020
1 parent 5e6a4ea commit 6c213b2
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
@@ -1,12 +1,15 @@
This repository demonstrates how to integrate [GitHub Actions](https://docs.github.com/en/actions) to (upon a new commit):

- Automatically authenticate `wandb` (Weights and Biases) using a custom GitHub secret.
- Automatically train a small Random Forest Regressor model on the [wine quality dataset](https://www.kaggle.com/uciml/red-wine-quality-cortez-et-al-2009).
- Automatically log the training and other important model metrics to Weights and Biases (`wandb`).
- Automatically log the training and other important model metrics to `wandb`.
- Cache Python dependencies so that old dependencies do not get installed each time a run is triggered.
- Generate a `metrics.csv` file after a run is successfully completed.

![](https://i.ibb.co/JqZWHDC/image.png)

The heart of this repository is [this YAML](https://github.com/sayakpaul/wine/blob/wandb-integration/.github/workflows/cml.yaml) file that defines a workflow that runs automatically after a new commit is pushed.

## Acknowledgements

[This video](https://www.youtube.com/watch?v=9BgIDqAzfuA) by DVCorg helped me a lot to clear the initial concepts regarding GitHub Actions.

0 comments on commit 6c213b2

Please sign in to comment.