Update README.md

rhammell · Jul 16, 2017 · c9cc106 · c9cc106
1 parent 996570c
commit c9cc106
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # mnist-draw
-This repository contains a single page website that enables users to draw and classify digits (0-9) using machine learning. 
+This repository contains a single page website that enables users to draw and classify digits (0-9) using machine learning. Included is a TFLearn model trained against the MNIST dataset, 
 
 # Setup 
 Python 3.5+ is required for compatability with all required modules
@@ -15,6 +15,15 @@ cd mnist-draw
 pip install -r requirements.txt
 ```
 
+## Machine Learning Model
+Python scripts related to defining, training, and implementing the machine learning model are contained within the `cgi-bin` folder. 
+
+A convolutional neural network (CNN) is defined within the `model.py` module using the [TFLearn](http://tflearn.org/) library. This model is designed for MNIST image input. 
+
+The defined CNN can be trained against the MNIST dataset by running the `train.py` script. This script will automaticallly load the MNIST dataset from the TFLearn library to use as input, and the trained model's parameter files are saved into the `models` directory. Pre-trained model files are made available in this directory already.
+
+The `mnist.py` script implements this trained model against the user's handdrawn input. 
+
 # Usage
 To launch the website, begin by starting a Python server from the repository folder:
 ```bash