Upload README.md with huggingface_hub

README.md

@@ -1,40 +1,67 @@
+
 ---
 license: mit
 datasets:
 - cerebras/SlimPajama-627B
-- oscar-corpus/OSCAR-2301
+- uonlp/CulturaX
+- pg19
 - bigcode/starcoderdata
 language:
 - fr
 - en
-pipeline_tag: text-generation
+pipeline_tag: text2text-generation
 tags:
 - legal
-- art
 - code
-- finance
-- medical
 - text-generation-inference
+- art
 ---
 
-# CroissantLLM: A not so flaky bilingual 1.3B model
+# CroissantLLM - Base (50k steps)
+
+This model is part of the CroissantLLM initiative, and corresponds to the checkpoint after 50k steps (0.79 T) tokens.
+
+To play with the final model, we recommend using the Chat version: https://huggingface.co/croissantllm/CroissantLLMChat-v0.1.
+
+
+
+## Abstract
+We introduce CroissantLLM, a 1.3B language model pretrained on a set of 3T English and French tokens, to bring to the research and industrial community a high-performance, fully open-sourced bilingual model that runs swiftly on consumer-grade local hardware.
+To that end, we pioneer the approach of training an intrinsically bilingual model with a 1:1 English-to-French pretraining data ratio, a custom tokenizer, and bilingual finetuning datasets. We release the training dataset, notably containing a French split with manually curated, high-quality, and varied data sources.
+To assess performance outside of English, we craft a novel benchmark, FrenchBench, consisting of an array of classification and generation tasks, covering various orthogonal aspects of model performance in the French Language. Additionally, rooted in transparency and to foster further Large Language Model research, we release codebases, and dozens of checkpoints across various model sizes, training data distributions, and training steps, as well as fine-tuned Chat models, and strong translation models. We evaluate our model through the FMTI framework, and validate 81% of the transparency criteria, far beyond the scores of even most open initiatives.
+This work enriches the NLP landscape, breaking away from previous English-centric work in order to strengthen our understanding of multilinguality in language models.
+
+## Citation
 
-An experimental mode trained on a small subsplit of the final data.
+Our work can be cited as:
+
+```bash
+Coming soon
+```
+
+## Usage
+
+This model is a base model, that is, it is not finetuned for Chat function and works best with few-shot prompting strategies.
 
-### Usage
 
 ```python
-model_name = "croissantllm/base_50k"
 
-model = AutoModelForCausalLM.from_pretrained(model_name, torch_dtype=torch.float16, device_map="auto")
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+
+model_name = "croissantllm/base_50k"
 tokenizer = AutoTokenizer.from_pretrained(model_name)
+model = AutoModelForCausalLM.from_pretrained(model_name, torch_dtype=torch.float16, device_map="auto")
 
-inputs = tokenizer("His name is Bob. -> Il s'appelle Bob.\nHe is heading to the market. -> Il va au marché.\nWe are heading to the beach, let's go together. ->", return_tensors="pt").to(model.device)
+inputs = tokenizer("I am so tired I could sleep right now. -> Je suis si fatigué que je pourrais m'endormir maintenant.
+He is heading to the market. -> Il va au marché.
+We are running on the beach. ->", return_tensors="pt").to(model.device)
 tokens = model.generate(**inputs, max_length=100, do_sample=True, top_p=0.95, top_k=60, temperature=0.5)
 print(tokenizer.decode(tokens[0]))
 
 # remove bos token
-inputs = tokenizer("France -> Paris, Italie -> Rome, Allemagne -> Berlin, Espagne ->", return_tensors="pt", add_special_tokens=False).to(model.device)
-tokens = model.generate(**inputs, max_length=250, do_sample=True, top_p=0.95, top_k=60)
+inputs = tokenizer("Capitales: France -> Paris, Italie -> Rome, Allemagne -> Berlin, Espagne ->", return_tensors="pt", add_special_tokens=True).to(model.device)
+tokens = model.generate(**inputs, max_length=100, do_sample=True, top_p=0.95, top_k=60)
 print(tokenizer.decode(tokens[0]))
-```
+```