Update README.md

README.md

@@ -14,25 +14,51 @@ should probably proofread and complete it, then remove this comment. -->
 
 # Hieroglyph-Translator-Using-Gardiner-Codes
 
-This model is a fine-tuned version of [t5-small](https://huggingface.co/t5-small) on the None dataset.
+This model was created to translate hieroglyphs into english.
+
+Egyptian Hieroglyphs have been grouped into different classes and given a referencing method called Gardiner Codes using Gardiner Classification.
+
+Using the Gardiner Codes we can assign meanings to different combinations of hieroglyphs.
+
+To Translate any sequence of hieroglyphs using this model, provide the following input :-
+"Translate hieroglyph unicode sequence to English: {Gardiner Codes of the Hieroglyphs}"
+
+Examples :
+"Translate hieroglyph unicode sequence to English: A1 B6 F8"
+"Translate hieroglyph unicode sequence to English: G4 H9 P3"
+
 It achieves the following results on the evaluation set:
 - Loss: 3.4556
 - Bleu: 0.4084
 - Gen Len: 5.795
 
-## Model description
 
-More information needed
 
-## Intended uses & limitations
+# Model description
+
+This model is a fine-tuned version of t5-small on a custom dataset derived from the Dictionary of Middle Egyptian.
+
+The Inference Api on the hugging face model page doesn't work well, load the model in jupyter notebook using the following code snippet:
+  text = "" # add your hieroglyph gardiner code combination in the string
+  
+  from transformers import AutoTokenizer
+  
+  tokenizer = AutoTokenizer.from_pretrained("AnushS/hieroglyph_unicode_translator_t5_small")
+  inputs = tokenizer(text, return_tensors="pt").input_ids
+  
+  from transformers import AutoModelForSeq2SeqLM
+  
+  
+  model = AutoModelForSeq2SeqLM.from_pretrained("AnushS/hieroglyph_unicode_translator_t5_small")
+  outputs = model.generate(inputs, max_new_tokens=40, do_sample=True, top_k=30, top_p=0.95)
+  translated_keywords = str(tokenizer.decode(outputs[0], skip_special_tokens=True))
+
 
-More information needed
+Intended uses & limitations
 
-## Training and evaluation data
+The Model is intended to be used to translate hieroglyphs. The model does not provide full sentences, it only outputs bits and keywords.
 
-More information needed
 
-## Training procedure
 
 ### Training hyperparameters