Update README.md

README.md

@@ -1,200 +1,98 @@
 ---
-# For reference on model card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1
-# Doc / guide: https://huggingface.co/docs/hub/model-cards
-{}
+title: English2French
+colorFrom: blue
+colorTo: purple
+sdk: gradio
+license: apache-2.0
+language:
+- en
+- fr
+pipeline_tag: translation
+metrics:
+- accuracy
+library_name: transformers
+emoji: 🌍
 ---
+# Model Card
 
-# Model Card for Model ID
+## Overview
 
-<!-- Provide a quick summary of what the model is/does. -->
+- **Model name:** English2French Translation
+- **Model description:** Translates between English and French.
+- **Authors:** Pallabi Biswas
+- **Repository link:** https://huggingface.co/spaces/pallabi/Translator/tree/main
+- **License:** Apache license 2.0
+- **Contact information:** pallabi.stu2017@juniv.edu
 
-This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
 
-## Model Details
-
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-
-
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
+---
 
-## Model Card Contact
 
-[More Information Needed]
+# English2Spanish Translation
+A simple and well designed web app to translate between **English** and **French**.
+
+
+### 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 **French**.
+
+
+### Prject Architecture
+```
+├──  data
+│    └── english2French.txt  - text dataset.
+│
+│
+├──  docs 
+│    └── english2French.pdf  - paper of the related research.
+│
+│
+├──  models  
+│    └── translation_en_to_fr - 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/pallabi/Translator
+# go inside the project directory 
+cd Translator
+# install the required packages
+pip install -r requirements.txt
+# run the gradio app
+python app.py 
+```
+
+### License
+Distributed under the Apache License 2.0. See `LICENSE` for more information.
+
+
+### Contributor
+Pallabi Biswas - [@pallabi](https://huggingface.co/pallabi) - pallabi.stu2017@juniv.edu
+
+Project Link: [https://huggingface.co/spaces/pallabi/Translator](https://huggingface.co/spaces/pallabi/Translator)