Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,66 @@
+
+---
+license: apache-2.0
+language:
+- pan
+datasets:
+- cis-lmu/Glot500
+- legacy-datasets/wikipedia
+- allenai/nllb
+- oscar-corpus/OSCAR-2109
+library_name: transformers
+pipeline_tag: text-generation
+tags:
+- goldfish
+
+---
+
+# pan_guru_1000mb
+
+Goldfish is a suite of monolingual language models trained for 350 languages.
+This model is the <b>Panjabi</b> (Gurmukhi script) model trained on 1000MB of data, after accounting for an estimated byte premium of 2.22; content-matched text in Panjabi takes on average 2.22x as many UTF-8 bytes to encode as English.
+The Goldfish models are trained primarily for comparability across languages and for low-resource languages; Goldfish performance for high-resource languages is not designed to be comparable with modern large language models (LLMs).
+
+Note: pan_guru is an [individual language](https://iso639-3.sil.org/code_tables/639/data) code. It is not contained in any macrolanguage codes contained in Goldfish (for script guru).
+
+All training and hyperparameter details are in our paper, [Goldfish: Monolingual Language Models for 350 Languages (Chang et al., 2024)](https://github.com/tylerachang/goldfish/blob/main/goldfish_paper_20240815.pdf).
+
+Training code and sample usage: https://github.com/tylerachang/goldfish
+
+Sample usage also in this Google Colab: [link](https://colab.research.google.com/drive/1rHFpnQsyXJ32ONwCosWZ7frjOYjbGCXG?usp=sharing)
+
+## Model details:
+
+To access all Goldfish model details programmatically, see https://github.com/tylerachang/goldfish/model_details.json.
+All models are trained with a [CLS] (same as [BOS]) token prepended, and a [SEP] (same as [EOS]) token separating sequences.
+Details for this model specifically:
+
+* Architecture: gpt2
+* Parameters: 124770816
+* Maximum sequence length: 512 tokens
+* Training text data (raw): 2220.97MB
+* Training text data (byte premium scaled): 1000.005MB
+* Training tokens: 215775232 (x10 epochs)
+* Vocabulary size: 50000
+* Compute cost: 1.1011630104576e+18 FLOPs or ~104.1 NVIDIA A6000 GPU hours
+
+Training datasets (percentages prior to deduplication):
+* 80.26136%: [Glot500](https://huggingface.co/datasets/cis-lmu/Glot500), including [AI4Bharat](https://ai4bharat.org/), [Anuvaad](https://github.com/project-anuvaad/anuvaad-parallel-corpus), [CCNet](https://github.com/facebookresearch/cc_net), [Earthlings](https://publicdata.canterbury.ac.nz/Research/Geocorpus/CCGLU_v5.0/), [Indiccorp](https://ai4bharat.iitm.ac.in/corpora), [OSCAR](https://oscar-project.org/), [Wikipedia Hugging Face](https://huggingface.co/datasets/legacy-datasets/wikipedia)
+* 11.38636%: [NLLB (CommonCrawl and ParaCrawl)](https://huggingface.co/datasets/allenai/nllb)
+* 5.73324%: [OSCAR 2021/09](https://huggingface.co/datasets/oscar-corpus/OSCAR-2109)
+* 2.48906%: [Wikipedia 2023/08](https://dumps.wikimedia.org/)
+* 0.12998%: [eBible](https://ebible.org/find/)
+
+
+## Citation
+
+If you use this model, please cite:
+
+```
+@article{chang-etal-2024-goldfish,
+  title={Goldfish: Monolingual Language Models for 350 Languages},
+  author={Chang, Tyler A. and Arnett, Catherine and Tu, Zhuowen and Bergen, Benjamin K.},
+  journal={Preprint},
+  year={2024},
+}
+```