File size: 2,714 Bytes
f09623f
53b38a4
 
 
 
f09623f
 
 
ec64c29
f09623f
53b38a4
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
e4613fe
 
53b38a4
 
 
e4613fe
 
 
 
 
 
 
 
53b38a4
 
 
 
 
 
 
 
 
 
 
a5e200b
53b38a4
 
 
 
 
a5e200b
 
 
 
 
53b38a4
 
a5e200b
 
53b38a4
 
 
a5e200b
 
53b38a4
a5e200b
 
 
 
53b38a4
 
 
 
 
 
 
 
 
 
 
 
 
 
b11388e
53b38a4
 
c17e64c
53b38a4
c17e64c
84281f4
53b38a4
c17e64c
 
53b38a4
c17e64c
 
53b38a4
c17e64c
 
53b38a4
 
 
 
 
 
 
 
 
a5e200b
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
---
title: Arabic2English
colorFrom: blue
colorTo: purple
sdk: gradio
license: mit
language:
- en
- ar
pipeline_tag: translation
metrics:
- accuracy
library_name: transformers
---

# Model Card

## Overview

- **Model name:** Arabic2English Translation
- **Model description:** Translates between Arabic and English.
- **Authors:** Alif Al Hasan
- **Repository link:** https://huggingface.co/spaces/alifalhasan/arabic2english/tree/main
- **License:** MIT
- **Contact information:** [email protected]


---


# Arabic2English Translation
A simple and well designed web app to translate between **Arabic** and **English**.


### Requirements
- gradio
- torch>=1.6
- torchtext==0.6
- transformers
- nltk
- pandas
- spacy
- https://github.com/explosion/spacy-models/releases/download/en_core_web_sm-3.7.1/en_core_web_sm-3.7.1-py3-none-any.whl


### Table Of Contents
-  [Introduction](#introduction)
-  [Project Architecture](#project-architecture)
-  [How To Run](#how-to-run)
-  [License](#license)
-  [Contributor](#contributor)


### Introduction
A simple and well designed web app to translate between **Arabic** and **English**.


### Prject Architecture
```
β”œβ”€β”€  data
β”‚    └── arabic2english.txt  - text dataset.
β”‚
β”‚
β”œβ”€β”€  docs 
β”‚    └── arabic2english.pdf  - paper of the related research.
β”‚
β”‚
β”œβ”€β”€  models  
β”‚    └── arabic2english.pt  - generated model.
β”‚ 
β”‚
β”œβ”€β”€  src
β”‚    └── data_processing
β”‚        └── data_processing.py  - this module preprocesses the input data.
β”‚    └── train
β”‚        └── train.py  - this module trains and saves the model.
β”‚        └── transformer.py  - model file.
β”‚    └── translation
β”‚        └── translate.py  - this module translates the input sentence.
β”‚
β”‚
β”œβ”€β”€  app.py - this module starts the app interface.
β”‚
β”‚
β”œβ”€β”€  LICENSE - license file of this project.
β”‚
β”‚
β”œβ”€β”€  README.md - readme file of this project.
β”‚
β”‚
β”œβ”€β”€  requirements.txt - list of required packages.
```

### How To Run 
```bash
# clone project   
git clone https://huggingface.co/spaces/alifalhasan/arabic2english

# go inside the project directory 
cd arabic2english

# install the required packages
pip install -r requirements.txt

# train & save the model
python src/train/trainer.py

# run the gradio app
python app.py 
```

### License
Distributed under the MIT License. See `LICENSE` for more information.


### Contributor
Alif Al Hasan - [@alifalhasan](https://huggingface.co/alifalhasan) - [email protected]

Project Link: [https://huggingface.co/spaces/alifalhasan/arabic2english](https://huggingface.co/spaces/alifalhasan/arabic2english)