Update README.md

README.md

@@ -72,3 +72,72 @@ The following hyperparameters were used during training:
 - Pytorch 2.2.1+cu121
 - Datasets 2.14.6
 - Tokenizers 0.15.2
+
+
+
+### Usage
+
+```python
+
+# Install transformers from source - only needed for versions <= v4.34
+# pip install git+https://github.com/huggingface/transformers.git
+# pip install accelerate
+
+import torch
+from transformers import pipeline
+
+pipe = pipeline("text-generation", model="
+zephyr-7b-gemma-sft-african-ultrachat-5k", torch_dtype=torch.bfloat16, device_map="auto")
+
+# We use the tokenizer's chat template to format each message - see https://huggingface.co/docs/transformers/main/en/chat_templating
+messages = [
+    {
+        "role": "system",
+        "content": "You are a friendly chatbot who answewrs question in given language",
+    },
+    {"role": "user", "content": "what is the 3 biggest countrys in Africa?"},
+]
+prompt = pipe.tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
+outputs = pipe(prompt, max_new_tokens=256, do_sample=True, temperature=0.7, top_k=50, top_p=0.95)
+print(outputs[0]["generated_text"])
+# <|system|>
+# You are a friendly chatbot who always responds in the style of a pirate<eos>
+# <|user|>
+# what is the 3 biggest countrys in Africa?<eos>
+# <|assistant|>
+# The 3 biggest countries in Africa are Nigeria, Ethiopia and South Africa.
+```
+
+
+### Quantized Versions through bitsandbytes
+
+``` python
+
+import torch
+from transformers import pipeline
+from transformers import AutoTokenizer, AutoModelForCausalLM, BitsAndBytesConfig
+
+
+quantization_config = BitsAndBytesConfig(load_in_4bit=True)
+
+tokenizer = AutoTokenizer.from_pretrained("
+zephyr-7b-gemma-sft-african-ultrachat-5k")
+model = AutoModelForCausalLM.from_pretrained("
+zephyr-7b-gemma-sft-african-ultrachat-5k", quantization_config=quantization_config)
+
+
+pipe = pipeline("text-generation", model=model,tokenizer=tokenizer, torch_dtype=torch.bfloat16, device_map="auto")
+
+messages = [
+    {
+        "role": "system",
+        "content": "You are a friendly chatbot who answewrs question in given language",
+    },
+    {"role": "user", "content": "list languages in Africa?"},
+]
+prompt = pipe.tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
+outputs = pipe(prompt, max_new_tokens=256, do_sample=True, temperature=0.7, top_k=50, top_p=0.95)
+print(outputs[0]["generated_text"])
+
+```
+