Skip to content

Commit a0346b0

Browse files
authored
Create README.md
1 parent 3b3bd65 commit a0346b0

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Nepali Currency Recognition Classifier
2+
3+
This repository contains code for a Nepali currency recognition classifier implemented in Python using TensorFlow and Keras.
4+
5+
## Overview
6+
7+
The classifier is based on a pre-trained VGG16 model with additional layers added for fine-tuning to the specific task of recognizing Nepali currency notes. It is trained on a dataset consisting of images of Nepali currency notes belonging to 7 different classes.
8+
9+
## Files
10+
11+
- `Nepali_Currency_Recognition_Classifier.ipynb`: Jupyter Notebook containing the code for the classifier.
12+
- `currency_classifier_model.h5`: Saved model file containing the trained classifier model.
13+
- `Prediction Checker/`: Folder containing test images for evaluating the classifier.
14+
15+
## Usage
16+
17+
1. **Training**: The notebook contains code for training the classifier. Simply run the notebook cells to train the model.
18+
19+
2. **Testing**: Once trained, you can test the classifier on new images by placing them in the `Prediction Checker/` folder and running the prediction code provided in the notebook.
20+
21+
## Dataset
22+
23+
Please note that the training dataset is not included in this repository due to its size. You can download the dataset from [Kaggle](https://www.kaggle.com/datasets/gauravneupane/nepali-rupees-collection). After downloading, extract the dataset and arrange the folder structure as follows:
24+
25+
dataset/
26+
27+
├── train/
28+
│ ├── class_1/
29+
│ ├── class_2/
30+
│ ├── ...
31+
│ └── class_n/
32+
33+
└── valid/
34+
├── class_1/
35+
├── class_2/
36+
├── ...
37+
└── class_n/
38+
39+
40+
Replace `class_1`, `class_2`, etc., with the actual class names or labels of the currency notes.
41+
42+
## Dependencies
43+
44+
- TensorFlow
45+
- Keras
46+
- Matplotlib
47+
- NumPy
48+
49+
## License
50+
51+
This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details.
52+

0 commit comments

Comments
 (0)