|
--- |
|
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) |
