Update README.md

README.md

@@ -10,9 +10,9 @@ tags:
 - sft
 - generated_from_trainer
 datasets:
-- israel/sd
+- masakhane/african-translated-alpaca
 model-index:
-- name: zephyr-7b-gemma-sft-alpaca
+- name: zephyr-7b-gemma-sft-african-alpaca
   results: []
 language:
 - af
@@ -27,7 +27,7 @@ should probably proofread and complete it, then remove this comment. -->
 
 # zephyr-7b-gemma-sft-alpaca
 
-This model is a fine-tuned version of [google/gemma-7b](https://huggingface.co/google/gemma-7b) on the israel/sd dataset.
+This model is a fine-tuned version of [google/gemma-7b](https://huggingface.co/google/gemma-7b) on the masakhane/african-translated-alpaca dataset.
 It achieves the following results on the evaluation set:
 - Loss: 0.2737
 
@@ -76,4 +76,39 @@ The following hyperparameters were used during training:
 - Transformers 4.39.0.dev0
 - Pytorch 2.2.1+cu121
 - Datasets 2.14.6
-- Tokenizers 0.15.2
+- 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="israel/zephyr-7b-gemma-sft-alpaca", 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.
+```