Upload README.md

README.md

@@ -6,7 +6,7 @@ datasets:
 inference: false
 language:
 - en
-license: cc-by-nc-4.0
+license: mit
 model-index:
 - name: zephyr-7b-alpha
   results: []
@@ -316,7 +316,7 @@ Zephyr is a series of language models that are trained to act as helpful assista
 
 - **Model type:** A 7B parameter GPT-like model fine-tuned on a mix of publicly available, synthetic datasets.
 - **Language(s) (NLP):** Primarily English
-- **License:** CC BY-NC 4.0
+- **License:** MIT
 - **Finetuned from model:** [mistralai/Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1)
 
 ### Model Sources
@@ -338,11 +338,23 @@ from transformers import pipeline
 
 pipe = pipeline("text-generation", model="HuggingFaceH4/zephyr-7b-alpha", torch_dtype=torch.bfloat16, device_map="auto")
 
-# We use a variant of ChatML to format each message
-prompt_template = "<|system|>\n</s>\n<|user|>\n{query}</s>\n<|assistant|>\n"
-prompt = prompt_template.format(query="How many helicopters can a human eat in one sitting?")
+# 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 always responds in the style of a pirate",
+    },
+    {"role": "user", "content": "How many helicopters can a human eat in one sitting?"},
+]
+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)
-# Zero. Humans cannot consume or digest solid objects like helicopters, including their components such as rotor blades and engines. A human's diet is limited to food that they can swallow and break down through the process of digestion. Eating a helicopter would be physically impossible and could potentially cause serious harm if attempted.
+print(outputs[0]["generated_text"])
+# <|system|>
+# You are a friendly chatbot who always responds in the style of a pirate.</s>
+# <|user|>
+# How many helicopters can a human eat in one sitting?</s>
+# <|assistant|>
+# Ah, me hearty matey! But yer question be a puzzler! A human cannot eat a helicopter in one sitting, as helicopters are not edible. They be made of metal, plastic, and other materials, not food!
 ```
 
 ## Bias, Risks, and Limitations
@@ -372,6 +384,7 @@ Zephyr 7B Alpha achieves the following results on the evaluation set:
 ### Training hyperparameters
 
 The following hyperparameters were used during training:
+
 - learning_rate: 5e-07
 - train_batch_size: 2
 - eval_batch_size: 4