Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,64 @@
+
+---
+license: apache-2.0
+language:
+- iku
+datasets:
+- cis-lmu/Glot500
+- legacy-datasets/wikipedia
+- allenai/MADLAD-400
+library_name: transformers
+pipeline_tag: text-generation
+tags:
+- goldfish
+
+---
+
+# iku_cans_full
+
+Goldfish is a suite of monolingual language models trained for 350 languages.
+This model is the <b>Inuktitut</b> (Unified Canadian Aboriginal Syllabics script) model trained on 74MB of data (all our data in the language), after accounting for an estimated byte premium of 2.16; content-matched text in Inuktitut takes on average 2.16x 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: iku_cans is a [macrolanguage](https://iso639-3.sil.org/code_tables/639/data) code. None of its contained individual languages are included in Goldfish (for script cans).
+
+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): 160.63MB
+* Training text data (byte premium scaled): 74.415MB
+* Training tokens: 13798400 (x10 epochs)
+* Vocabulary size: 50000
+* Compute cost: 7.0412454199296e+16 FLOPs or ~6.7 NVIDIA A6000 GPU hours
+
+Training datasets (percentages prior to deduplication):
+* 50.41059%: [Nunavut Hansard Inuktitut–English Parallel Corpus 3.0](https://nrc-digital-repository.canada.ca/eng/view/object/?id=c7e34fa7-7629-43c2-bd6d-19b32bf64f60)
+* 42.46450%: [Glot500](https://huggingface.co/datasets/cis-lmu/Glot500), including [Wikipedia Hugging Face](https://huggingface.co/datasets/legacy-datasets/wikipedia)
+* 7.06461%: [MADLAD-400 (CommonCrawl)](https://huggingface.co/datasets/allenai/MADLAD-400)
+* 0.06031%: [Wikipedia 2023/08](https://dumps.wikimedia.org/)
+
+
+## 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},
+}
+```