Update README.md

README.md

@@ -19,94 +19,54 @@ license: apache-2.0
 ---
 # Schaapje-2B-Chat-V1.0
 
-<!-- Provide a quick summary of what the model is/does. -->
+## Model description
 
+This is the DPO aligned model based on the SFT trained model [robinsmits/Schaapje-2B-Chat-SFT-V1.0](https://huggingface.co/robinsmits/Schaapje-2B-Chat-SFT-V1.0).
 
-## Model Details
+General Dutch Chat and/or Instruction following works quitte well with this model.
 
-### Model Description
+## Model usage
 
-<!-- Provide a longer summary of what this model is. -->
+A basic example of how to use this DPO aligned model for Chat or Instruction following.
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+```
+import torch
+from transformers import AutoTokenizer, AutoModelForCausalLM
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+device = 'cuda'
+model_name = 'robinsmits/Schaapje-2B-Chat-V1.0'
 
-### Model Sources [optional]
+model = AutoModelForCausalLM.from_pretrained(model_name, 
+                                             device_map = "auto", 
+                                             torch_dtype = torch.bfloat16)
 
-<!-- Provide the basic links for the model. -->
+tokenizer = AutoTokenizer.from_pretrained(model_name)
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+messages = [{"role": "user", "content": "Hoi hoe gaat het ermee?"}]
 
-## Uses
+chat = tokenizer.apply_chat_template(messages, 
+                                     tokenize = False, 
+                                     add_generation_prompt = True)
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+input_tokens = tokenizer(chat, return_tensors = "pt").to('cuda')
 
-### Direct Use
+output = model.generate(**input_tokens, 
+                        max_new_tokens = 512,
+                        do_sample = True)
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+output = tokenizer.decode(output[0], skip_special_tokens = False)
+print(output)
+```
 
-[More Information Needed]
+## Intended uses & limitations
 
-### Downstream Use [optional]
+As with all LLM's this model can also experience bias and hallucinations. Regardless of how you use this model always perform the necessary testing and validation.
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+## Datasets and Licenses
 
-[More Information Needed]
+The following dataset was used for DPO alignment:
+- [BramVanroy/ultra_feedback_dutch_cleaned](https://huggingface.co/datasets/BramVanroy/ultra_feedback_dutch_cleaned): apache-2.0
 
-### Out-of-Scope Use
+##  Model Training
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
+The notebook used to train this DPO aligned model is available at the following link: [Schaapje-2B-Chat-DPO-V1.0](https://github.com/RobinSmits/Schaapje/blob/main/Schaapje-2B-Chat-DPO-V1.0.ipynb)