Update README.md

README.md

@@ -1,13 +1,100 @@
 ---
-title: Translator
-emoji: 🚀
-colorFrom: indigo
+title: English2Spanish
+colorFrom: blue
 colorTo: purple
 sdk: gradio
-sdk_version: 4.25.0
-app_file: app.py
-pinned: false
-license: apache-2.0
+license: mit
+language:
+- en
+- es
+pipeline_tag: translation
+metrics:
+- accuracy
+library_name: transformers
+emoji: 🌍
 ---
+# Model Card
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+## Overview
+
+- **Model name:** English2Spanish Translation
+- **Model description:** Translates between English and Spanish.
+- **Authors:** Pallabi Biswas
+- **Repository link:** https://huggingface.co/spaces/pallabi/Translator/tree/main
+- **License:** MIT
+- **Contact information:** [email protected]
+
+
+---
+
+
+# English2Spanish Translation
+A simple and well designed web app to translate between **English** and **Spanish**.
+
+
+### Requirements
+- gradio
+- torch>=2.2
+- transformers
+
+
+### 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 **English** and **Spanish**.
+
+
+### Prject Architecture
+```
+├──  data
+│    └── english2Spanish.txt  - text dataset.
+│
+│
+├──  docs 
+│    └── english2Spanish.pdf  - paper of the related research.
+│
+│
+├──  models  
+│    └── english2Spanish.pt  - generated model.
+│ 
+│
+├──  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
+Pallabi Biswas - [@pallabi](https://huggingface.co/pallabi) - [email protected]
+
+Project Link: [https://huggingface.co/spaces/pallabi/Translator](https://huggingface.co/spaces/pallabi/Translator)