Update README.md

README.md

@@ -1,78 +1,106 @@
 ---
-base_model: HuggingFaceTB/cosmo2-135M-webinst-sc2
-tags:
-- alignment-handbook
-- trl
-- dpo
-- generated_from_trainer
-- trl
-- dpo
-- generated_from_trainer
-datasets:
-- HuggingFaceTB/Helpsteer
-model-index:
-- name: cosmo2-135M-webinst-sc2-dpo-helpsteer-ep1
-  results: []
+library_name: transformers
+license: apache-2.0
+language:
+- en
 ---
 
-<!-- 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. -->
 
-[<img src="https://raw.githubusercontent.com/wandb/assets/main/wandb-github-badge-28.svg" alt="Visualize in Weights & Biases" width="200" height="32"/>](https://wandb.ai/loubnabnl/huggingface/runs/bh5ijwbx)
-# cosmo2-135M-webinst-sc2-dpo-helpsteer-ep1
-
-This model is a fine-tuned version of [HuggingFaceTB/cosmo2-135M-webinst-sc2](https://huggingface.co/HuggingFaceTB/cosmo2-135M-webinst-sc2) on the HuggingFaceTB/Helpsteer dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.6824
-- Rewards/chosen: -0.0115
-- Rewards/rejected: -0.0340
-- Rewards/accuracies: 0.5833
-- Rewards/margins: 0.0225
-- Logps/rejected: -190.0087
-- Logps/chosen: -147.2760
-- Logits/rejected: 0.1785
-- Logits/chosen: -0.0247
-- IFEval loose prompt 14.79
-- IFEval strict prompt 12.2
-  
-## Model description
-
-More information needed
-
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
-
-More information needed
-
-## Training procedure
-
-### Training hyperparameters
-
-The following hyperparameters were used during training:
-- learning_rate: 5e-06
-- train_batch_size: 2
-- eval_batch_size: 4
-- seed: 42
-- distributed_type: multi-GPU
-- num_devices: 8
-- gradient_accumulation_steps: 8
-- total_train_batch_size: 128
-- total_eval_batch_size: 32
-- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
-- lr_scheduler_type: cosine
-- lr_scheduler_warmup_ratio: 0.1
-- num_epochs: 1
-
-### Training results
-
-
-
-### Framework versions
-
-- Transformers 4.42.3
-- Pytorch 2.1.2
-- Datasets 2.20.0
-- Tokenizers 0.19.1
+# SmolLM
+
+<center>
+    <img src="https://huggingface.co/datasets/HuggingFaceTB/images/resolve/main/banner_smol.png" alt="SmolLM" width="1100" height="600">
+</center>
+
+##  Table of Contents
+
+1. [Model Summary](##model-summary)
+2. [Limitations](##limitations)
+3. [Training](##training)
+4. [License](##license)
+5. [Citation](##citation)
+
+## Model Summary
+
+SmolLM is a series of state-of-the-art small language models available in three sizes: 135M, 360M, and 1.7B parameters. These models are built on Cosmo-Corpus, a meticulously curated high-quality training dataset. Cosmo-Corpus includes Cosmopedia v2 (28B tokens of synthetic textbooks and stories generated by Mixtral), Python-Edu (4B tokens of educational Python samples from The Stack), and FineWeb-Edu (220B tokens of deduplicated educational web samples from FineWeb). For duther details, we refer to our blogpost TODO.
+
+To build SmolLM-Instruct, we instruction tuned the models using publicly available permissive instruction datasets. We trained all three models for one epoch on the permissive subset of the WebInstructSub dataset, combined with StarCoder2-Self-OSS-Instruct. Following this, we performed DPO (Direct Preference Optimization) for one epoch: using HelpSteer for the 135M and 1.7B models, and argilla/dpo-mix-7k for the 360M model. We followed the training parameters from the Zephyr-Gemma recipe in the alignment handbook, but adjusted the SFT (Supervised Fine-Tuning) learning rate to 3e-4.
+[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0)
+
+### Generation
+```bash
+pip install transformers
+```
+
+#### Running the model on CPU/GPU/multi GPU
+* _Using full precision_
+```python
+# pip install git+https://github.com/huggingface/transformers.git # TODO: merge PR to main
+from transformers import AutoModelForCausalLM, AutoTokenizer
+checkpoint = "HuggingFaceTB/SmolLM-135M"
+device = "cuda" # for GPU usage or "cpu" for CPU usage
+tokenizer = AutoTokenizer.from_pretrained(checkpoint)
+# for multiple GPUs install accelerate and do `model = AutoModelForCausalLM.from_pretrained(checkpoint, device_map="auto")`
+model = AutoModelForCausalLM.from_pretrained(checkpoint).to(device)
+inputs = tokenizer.encode("def print_hello_world():", return_tensors="pt").to(device)
+outputs = model.generate(inputs)
+print(tokenizer.decode(outputs[0]))
+```
+```bash
+>>> print(f"Memory footprint: {model.get_memory_footprint() / 1e6:.2f} MB")
+Memory footprint: 12624.81 MB
+```
+* _Using `torch.bfloat16`_
+```python
+# pip install accelerate
+import torch
+from transformers import AutoTokenizer, AutoModelForCausalLM
+checkpoint = "HuggingFaceTB/SmolLM-135M"
+tokenizer = AutoTokenizer.from_pretrained(checkpoint)
+# for fp16 use `torch_dtype=torch.float16` instead
+model = AutoModelForCausalLM.from_pretrained(checkpoint, device_map="auto", torch_dtype=torch.bfloat16)
+inputs = tokenizer.encode("def print_hello_world():", return_tensors="pt").to("cuda")
+outputs = model.generate(inputs)
+print(tokenizer.decode(outputs[0]))
+```
+```bash
+>>> print(f"Memory footprint: {model.get_memory_footprint() / 1e6:.2f} MB")
+Memory footprint: 269.03 MB
+```
+
+#### Quantized Versions through `bitsandbytes`
+* _Using 8-bit precision (int8)_
+
+```python
+# pip install bitsandbytes accelerate
+from transformers import AutoTokenizer, AutoModelForCausalLM, BitsAndBytesConfig
+# to use 4bit use `load_in_4bit=True` instead
+quantization_config = BitsAndBytesConfig(load_in_8bit=True)
+checkpoint = "HuggingFaceTB/SmolLM-135M"
+tokenizer = AutoTokenizer.from_pretrained(checkpoint)
+model = AutoModelForCausalLM.from_pretrained(checkpoint, quantization_config=quantization_config)
+inputs = tokenizer.encode("def print_hello_world():", return_tensors="pt").to("cuda")
+outputs = model.generate(inputs)
+print(tokenizer.decode(outputs[0]))
+```
+```bash
+>>> print(f"Memory footprint: {model.get_memory_footprint() / 1e6:.2f} MB")
+# load_in_8bit
+Memory footprint: 162.87 MB
+# load_in_4bit
+>>> print(f"Memory footprint: {model.get_memory_footprint() / 1e6:.2f} MB")
+Memory footprint: 109.78 MB
+```
+
+# Limitations
+
+While SmolLM models have been trained on a diverse dataset including educational content and synthetic texts, they have limitations. The models primarily understand and generate content in English. They can produce text on a variety of topics, but the generated content may not always be factually accurate, logically consistent, or free from biases present in the training data. These models should be used as assistive tools rather than definitive sources of information. Users should always verify important information and critically evaluate any generated content. For a more comprehensive discussion of the models' capabilities and limitations, please refer to our full blog post.
+
+# Citation
+```bash
+@misc{allal2024SmolLM,
+      title={SmolLM - blazingly fast and remarkably powerful}, 
+      author={Loubna Ben Allal and Anton Lozhkov and Elie Bakouch and Leandro von Werra and Thomas Wolf},
+      year={2024},
+}
+```