Certainly! Here's a sample README.md
file for your project:
# Number Drawing App
A web application that allows users to draw numbers and check if their drawings match the target numbers. This app makes use of the MNIST dataset for number recognition and provides a simple and intuitive interface for users to interact with.
## Features
- Displays a target number for the user to draw.
- Allows users to draw numbers using a canvas.
- Submits the drawing for prediction and displays the result.
- Provides feedback on whether the drawing matches the target number.
- Supports clearing the canvas and starting over.
## Prerequisites
- Python 3.6 or higher
- TensorFlow 2.6.0 or higher
- Pillow 8.3.2 or higher
- Streamlit 0.90.0 or higher
## Installation
1. Clone the repository:
```shell
git clone https://github.com/your-username/number-drawing-app.git
-
Navigate to the project directory:
cd number-drawing-app
-
Install the required dependencies:
pip install -r requirements.txt
-
Prepare the MNIST model:
- Download or train your MNIST model.
- Save the model as
mnist_model.h5
. - Place the
mnist_model.h5
file in thedata/mnist
directory.
-
Start the app:
streamlit run app/main.py
-
Open your web browser and visit
http://localhost:8501
to access the app. -
Draw the number displayed on the screen using the canvas.
-
Click the "Submit" button to submit your drawing for prediction.
-
The app will display the predicted number and provide feedback on whether it matches the target number.
-
To clear the canvas and start over, click the "Clear" button.
This project is licensed under the MIT License.
Feel free to modify and customize the `README.md` file according to your specific project requirements.