Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,13 +1,100 @@
|
|
| 1 |
---
|
| 2 |
-
title:
|
| 3 |
-
|
| 4 |
-
colorFrom: indigo
|
| 5 |
colorTo: purple
|
| 6 |
sdk: gradio
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 11 |
---
|
|
|
|
| 12 |
|
| 13 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: English2Spanish
|
| 3 |
+
colorFrom: blue
|
|
|
|
| 4 |
colorTo: purple
|
| 5 |
sdk: gradio
|
| 6 |
+
license: mit
|
| 7 |
+
language:
|
| 8 |
+
- en
|
| 9 |
+
- es
|
| 10 |
+
pipeline_tag: translation
|
| 11 |
+
metrics:
|
| 12 |
+
- accuracy
|
| 13 |
+
library_name: transformers
|
| 14 |
+
emoji: π
|
| 15 |
---
|
| 16 |
+
# Model Card
|
| 17 |
|
| 18 |
+
## Overview
|
| 19 |
+
|
| 20 |
+
- **Model name:** English2Spanish Translation
|
| 21 |
+
- **Model description:** Translates between English and Spanish.
|
| 22 |
+
- **Authors:** Pallabi Biswas
|
| 23 |
+
- **Repository link:** https://huggingface.co/spaces/pallabi/Translator/tree/main
|
| 24 |
+
- **License:** MIT
|
| 25 |
+
- **Contact information:** pallabi.stu2017@juniv.edu
|
| 26 |
+
|
| 27 |
+
|
| 28 |
+
---
|
| 29 |
+
|
| 30 |
+
|
| 31 |
+
# English2Spanish Translation
|
| 32 |
+
A simple and well designed web app to translate between **English** and **Spanish**.
|
| 33 |
+
|
| 34 |
+
|
| 35 |
+
### Requirements
|
| 36 |
+
- gradio
|
| 37 |
+
- torch>=2.2
|
| 38 |
+
- transformers
|
| 39 |
+
|
| 40 |
+
|
| 41 |
+
### Table Of Contents
|
| 42 |
+
- [Introduction](#introduction)
|
| 43 |
+
- [Project Architecture](#project-architecture)
|
| 44 |
+
- [How To Run](#how-to-run)
|
| 45 |
+
- [License](#license)
|
| 46 |
+
- [Contributor](#contributor)
|
| 47 |
+
|
| 48 |
+
|
| 49 |
+
### Introduction
|
| 50 |
+
A simple and well designed web app to translate between **English** and **Spanish**.
|
| 51 |
+
|
| 52 |
+
|
| 53 |
+
### Prject Architecture
|
| 54 |
+
```
|
| 55 |
+
βββ data
|
| 56 |
+
β βββ english2Spanish.txt - text dataset.
|
| 57 |
+
β
|
| 58 |
+
β
|
| 59 |
+
βββ docs
|
| 60 |
+
β βββ english2Spanish.pdf - paper of the related research.
|
| 61 |
+
β
|
| 62 |
+
β
|
| 63 |
+
βββ models
|
| 64 |
+
β βββ english2Spanish.pt - generated model.
|
| 65 |
+
β
|
| 66 |
+
β
|
| 67 |
+
βββ app.py - this module starts the app interface.
|
| 68 |
+
β
|
| 69 |
+
β
|
| 70 |
+
βββ LICENSE - license file of this project.
|
| 71 |
+
β
|
| 72 |
+
β
|
| 73 |
+
βββ README.md - readme file of this project.
|
| 74 |
+
β
|
| 75 |
+
β
|
| 76 |
+
βββ requirements.txt - list of required packages.
|
| 77 |
+
```
|
| 78 |
+
|
| 79 |
+
### How To Run
|
| 80 |
+
```bash
|
| 81 |
+
# clone project
|
| 82 |
+
git clone https://huggingface.co/spaces/alifalhasan/arabic2english
|
| 83 |
+
# go inside the project directory
|
| 84 |
+
cd arabic2english
|
| 85 |
+
# install the required packages
|
| 86 |
+
pip install -r requirements.txt
|
| 87 |
+
# train & save the model
|
| 88 |
+
python src/train/trainer.py
|
| 89 |
+
# run the gradio app
|
| 90 |
+
python app.py
|
| 91 |
+
```
|
| 92 |
+
|
| 93 |
+
### License
|
| 94 |
+
Distributed under the MIT License. See `LICENSE` for more information.
|
| 95 |
+
|
| 96 |
+
|
| 97 |
+
### Contributor
|
| 98 |
+
Pallabi Biswas - [@pallabi](https://huggingface.co/pallabi) - pallabi.stu2017@juniv.edu
|
| 99 |
+
|
| 100 |
+
Project Link: [https://huggingface.co/spaces/pallabi/Translator](https://huggingface.co/spaces/pallabi/Translator)
|