add image to readme

RobertJN64 · Sep 26, 2022 · 5c6bdc1 · 5c6bdc1
1 parent ffe1a81
commit 5c6bdc1
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,11 @@
 ![Python Version Badge](https://img.shields.io/pypi/pyversions/MLDashboard)
 ![License Badge](https://img.shields.io/github/license/RobertJN64/MLDashboard)
 
+![Image](image.png)
+
+Monitoring solution for tensorflow training. Particulary useful for
+image classification models. Not compatible with google colab or other 
+notebook based runtimes.
 
 ## Getting Started
 
@@ -14,6 +19,10 @@ This guide assumes you already understand python and tensorflow.
 pip install MLDashboard
 ```
 
+## Examples
+
+See [Examples](MLDashboard/Examples) for usage.
+
 ## Quick Start
 To start, you need a dashboard.json config file. This should be in the same directory as your script.
 Here is an example:

diff --git a/image.png b/image.png