Update README.md

README.md

@@ -20,6 +20,10 @@ This model translates german language to english language. It used Sequence to S
 - **License:** MIT
 - **Contact:** monjusha.2017@juniv.edu
 
+# Task Description
+This app translates German to English. First the language is tokenized, passed through encoder, decoder and trained with Seq2SeqTransformer.
+Then as output the language is english.
+
 # Data Processing
 
 Defining source and target languages and then Tokenization. Tokenizers for German and English are initialized using spaCy (spacy library).
@@ -99,13 +103,13 @@ These utility functions and transformations handle the preprocessing of text dat
 
 Then the model is trained with Seq2SeqTransformer and evaluated with function evaluate(model). 
 
-### Result Analysis
+# Result Analysis
 greedy_decode() - this function takes
-# model: The sequence-to-sequence transformer model.
-# src: The source sequence tensor.
-# src_mask: The mask for the source sequence.
-# max_len: The maximum length of the output sequence.
-# start_symbol: The index of the start symbol in the target vocabulary
+### model: The sequence-to-sequence transformer model.
+### src: The source sequence tensor.
+### src_mask: The mask for the source sequence.
+### max_len: The maximum length of the output sequence.
+### start_symbol: The index of the start symbol in the target vocabulary
 
 as parameter and returns the generated target sequence tensor ys, which contains the complete translation.
 
@@ -129,7 +133,7 @@ def translate(src_sentence: str):
 This function first loads the saved model. Then it tokenizes and implements greedy_decode for getting the translated output. Then returns the 
 output.
 
-## Hugging Face Interface:
+# Hugging Face Interface:
 
 For creating interface gradio and torch as well as Seq2SeqTransformer, translate and greedy_decode function from the germantoenglish.py file was loaded.
 ```bash
@@ -153,8 +157,11 @@ if __name__ == "__main__":
 iface.launch(share=True)
 
 ```
+The app interface looks like this:
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/65b2665fee3f66b2b0f7b765/J_Q4eqXiN7cNuhOM3NbjR.png)
 
-### Project Structure
+# Project Structure
 ```bash
 |---Readme.md
 |
@@ -170,7 +177,7 @@ iface.launch(share=True)
 
 ```
 
-### How to Run
+# How to Run
 
 ```bash
 
@@ -184,11 +191,11 @@ python app.py
 ```
 
 
-### License
+# License
 This project is licensed under the MIT License.
 
-### Contributor
+# Contributor
 Neelima Monjusha Preeti - monjusha.stu2017@juniv.edu
 
-link: https://huggingface.co/spaces/neelimapreeti297/GermanToEnglish
+App link: https://huggingface.co/spaces/neelimapreeti297/GermanToEnglish