alifalhasan commited on
Commit
a5e200b
β€’
1 Parent(s): e4613fe

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +15 -47
README.md CHANGED
@@ -45,7 +45,6 @@ A simple and well designed web app to translate between **Arabic** and **English
45
 
46
  ### Table Of Contents
47
  - [Introduction](#introduction)
48
- - [Model Architecture](#model-architecture)
49
  - [Project Architecture](#project-architecture)
50
  - [How To Run](#how-to-run)
51
  - [License](#license)
@@ -53,62 +52,31 @@ A simple and well designed web app to translate between **Arabic** and **English
53
 
54
 
55
  ### Introduction
56
- A simple and well designed web app to identify the emblem of the top 5 teams of **EPL**. This model has been trained with a balanced dataset which contains almost **5k** images of the emblems of the teams.
57
-
58
-
59
- ### Model Architecture
60
- The model utilizes a straightforward convolutional neural network (CNN) architecture, comprising the following layers:
61
-
62
- 1. **Convolutional Layer:**
63
- - 32 filters, each of size 3x3
64
- - ReLU activation function
65
- - Input shape: 224x224x3 (RGB images)
66
- - Extracts spatial features from input images.
67
-
68
- 2. **Max Pooling Layer:**
69
- - Pool size: 2x2
70
- - Reduces spatial dimensions for capturing more global features.
71
-
72
- 3. **Flattening Layer:**
73
- - Flattens the 2D feature maps into a 1D vector for input to dense layers.
74
-
75
- 4. **Dense Layer 1:**
76
- - 64 neurons
77
- - ReLU activation function
78
-
79
- 5. **Output Layer (Dense Layer 2):**
80
- - 5 neurons (matching the number of classes)
81
- - Softmax activation to produce probability scores for each class.
82
-
83
- **Key Points:**
84
- - Input image size: 224x224 pixels
85
- - Optimizer: Adam with a learning rate of 0.001
86
- - Loss function: Categorical crossentropy
87
- - Performance metric: Accuracy
88
-
89
- **Visual Representation:**
90
- [Input image (224x224x3)] --> [Conv2D] --> [MaxPooling2D] --> [Flatten] --> [Dense 1] --> [Output Layer (Dense 2)] --> [Predicted class]
91
 
92
 
93
  ### Prject Architecture
94
  ```
95
  β”œβ”€β”€ data
96
- β”‚ └── arsenal - images of arsenal's emblem.
97
- β”‚ └── chelsea - images of chelsea's emblem.
98
- β”‚ └── liverpool - images of liverpool's emblem.
99
- β”‚ └── manchester-city - images of manchester-city's emblem.
100
- β”‚ └── manchester-united - images of united's emblem.
101
  β”‚
102
  β”‚
103
- β”œβ”€β”€ model
104
- β”‚ └── football_logo_model.h5 - generated model.
105
  β”‚
106
  β”‚
107
  β”œβ”€β”€ src
108
- β”‚ └── classify
109
- β”‚ └── classify.py - this module classifies the emblem from input image.
110
  β”‚ └── train
111
- β”‚ └── trainer.py - this module trains the model.
 
 
 
112
  β”‚
113
  β”‚
114
  β”œβ”€β”€ app.py - this module starts the app interface.
@@ -153,4 +121,4 @@ Distributed under the MIT License. See `LICENSE` for more information.
153
  ### Contributor
154
  Alif Al Hasan - [@alifalhasan](https://huggingface.co/alifalhasan) - [email protected]
155
 
156
- Project Link: [https://huggingface.co/spaces/alifalhasan/epl-top5-emblem-classifier](https://huggingface.co/spaces/alifalhasan/epl-top5-emblem-classifier)
 
45
 
46
  ### Table Of Contents
47
  - [Introduction](#introduction)
 
48
  - [Project Architecture](#project-architecture)
49
  - [How To Run](#how-to-run)
50
  - [License](#license)
 
52
 
53
 
54
  ### Introduction
55
+ A simple and well designed web app to translate between **Arabic** and **English**.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
56
 
57
 
58
  ### Prject Architecture
59
  ```
60
  β”œβ”€β”€ data
61
+ β”‚ └── arabic2english.txt - text dataset.
62
+ β”‚
63
+ β”‚
64
+ β”œβ”€β”€ docs
65
+ β”‚ └── arabic2english.pdf - paper of the related research.
66
  β”‚
67
  β”‚
68
+ β”œβ”€β”€ models
69
+ β”‚ └── arabic2english.pt - generated model.
70
  β”‚
71
  β”‚
72
  β”œβ”€β”€ src
73
+ β”‚ └── data_processing
74
+ β”‚ └── data_processing.py - this module preprocesses the input data.
75
  β”‚ └── train
76
+ β”‚ └── train.py - this module trains and saves the model.
77
+ β”‚ └── transformer.py - model file.
78
+ β”‚ └── translation
79
+ β”‚ └── translate.py - this module translates the input sentence.
80
  β”‚
81
  β”‚
82
  β”œβ”€β”€ app.py - this module starts the app interface.
 
121
  ### Contributor
122
  Alif Al Hasan - [@alifalhasan](https://huggingface.co/alifalhasan) - [email protected]
123
 
124
+ Project Link: [https://huggingface.co/spaces/alifalhasan/arabic2english](https://huggingface.co/spaces/alifalhasan/arabic2english)