model-card-example / README.md
pallabi's picture
Update README.md
9cba46d verified
metadata
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

Overview


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

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

# 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 - pallabi.stu2017@juniv.edu

Project Link: https://huggingface.co/spaces/pallabi/Translator