Update README.md

README.md

@@ -8,14 +8,15 @@ metrics:
 model-index:
 - name: flan-t5-base-eng-hwp
   results: []
+language:
+- en
+library_name: transformers
+pipeline_tag: translation
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
+# English-Hawaiian Pidgin Translator | flan-t5-base-eng-hwp
 
-# flan-t5-base-eng-hwp
-
-This model is a fine-tuned version of [google/flan-t5-base](https://huggingface.co/google/flan-t5-base) on the None dataset.
+This model is a fine-tuned version of [google/flan-t5-base](https://huggingface.co/google/flan-t5-base) on a English and Hawaiian Pidgin dataset.
 It achieves the following results on the evaluation set:
 - Loss: 1.5058
 - Bleu: 4.9532
@@ -23,15 +24,23 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-More information needed
+### Running the model
 
-## Intended uses & limitations
+The [google/flan-t5-base](https://huggingface.co/google/flan-t5-base) documentation has more details on running the model.
+
+However, to use this model to translate English to Hawaiian Pidgin, enter ``"translate English to Hawaiian Pidgin: "`` before your statement. 
 
-More information needed
+For example, if you would like to translate "I went to Ala Moana today to go shopping" please tokenize all of the following: ``"translate English to Hawaiian Pidgin: I went to Ala Moana today to go shopping."``
+
+If you are trying the [English-Hawaiian Pidgin Translator](https://huggingface.co/spaces/claudiatang/english_to_hawaiian-pidgin) space, there is no need for the input prefix, as it is automatically added.
 
 ## Training and evaluation data
 
-More information needed
+There are not many English-Hawaiian Pidgin parallel corpora that are easily accessible. A parallel dataset, similar to [bible_para](https://huggingface.co/datasets/bible_para), was compiled by scraping the Hawaiʻi Pidgin Version (HWP) and the King James Version (KJV) from [biblegateway.com](https://www.biblegateway.com/). <!--- For more information, please refer to [this notebook](). -->
+
+## Intended uses & limitations
+
+Due to a limited set of training and evaluation data, this model has many limitations, such as not knowing certain Hawaiian Pidgin phrases or having trouble with longer sentences.
 
 ## Training procedure
 
@@ -70,3 +79,16 @@ The following hyperparameters were used during training:
 - Pytorch 2.1.0+cu118
 - Datasets 2.14.6
 - Tokenizers 0.14.1
+
+## Resources
+ - Christodouloupoulos, C., & Steedman, M. (2014). A massively parallel corpus: the Bible in 100 languages. Language Resources and Evaluation, 49(2), 375–395. https://doi.org/10.1007/s10579-014-9287-y
+‌
+ - Chung, H. W., Hou, L., Longpre, S., Zoph, B., Tay, Y., Fedus, W., … Wei, J. (2022). _Scaling Instruction-Finetuned Language Models._ doi:10.48550/ARXIV.2210.11416
+ 
+ - _Hawaii Pidgin_. (2017). Wycliffe. https://www.biblegateway.com/versions/Hawaii-Pidgin-HWP/ (Original work published 2000)
+
+ - _King James Bible_. (2017). BibleGateway.com. https://www.biblegateway.com/versions/king-james-version-kjv-bible/ (Original work published 1769)
+
+ - T5. (n.d.). Huggingface.co. https://huggingface.co/docs/transformers/model_doc/t5
+
+ - Translation. (n.d.). Huggingface.co. Retrieved October 18, 2023, from https://huggingface.co/docs/transformers/tasks/translation