Upload README.md

README.md

@@ -5,7 +5,17 @@ license: apache-2.0
 model_creator: Intel
 model_name: Neural Chat 7B v3-1
 model_type: mistral
-prompt_template: '{prompt}
+prompt_template: '### System:
+
+  {system_message}
+
+
+  ### User:
+
+  {prompt}
+
+
+  ### Assistant:
 
   '
 quantized_by: TheBloke
@@ -64,11 +74,17 @@ It is supported by:
 <!-- repositories-available end -->
 
 <!-- prompt-template start -->
-## Prompt template: Unknown
+## Prompt template: Orca-Hashes
 
 ```
+### System:
+{system_message}
+
+### User:
 {prompt}
 
+### Assistant:
+
 ```
 
 <!-- prompt-template end -->
@@ -133,7 +149,13 @@ prompts = [
     "What is 291 - 150?",
     "How much wood would a woodchuck chuck if a woodchuck could chuck wood?",
 ]
-prompt_template=f'''{prompt}
+prompt_template=f'''### System:
+{system_message}
+
+### User:
+{prompt}
+
+### Assistant:
 '''
 
 prompts = [prompt_template.format(prompt=prompt) for prompt in prompts]
@@ -175,7 +197,13 @@ from huggingface_hub import InferenceClient
 endpoint_url = "https://your-endpoint-url-here"
 
 prompt = "Tell me about AI"
-prompt_template=f'''{prompt}
+prompt_template=f'''### System:
+{system_message}
+
+### User:
+{prompt}
+
+### Assistant:
 '''
 
 client = InferenceClient(endpoint_url)
@@ -238,7 +266,13 @@ model = AutoModelForCausalLM.from_pretrained(
 streamer = TextStreamer(tokenizer, skip_prompt=True, skip_special_tokens=True)
 
 prompt = "Tell me about AI"
-prompt_template=f'''{prompt}
+prompt_template=f'''### System:
+{system_message}
+
+### User:
+{prompt}
+
+### Assistant:
 '''
 
 # Convert prompt to tokens
@@ -340,9 +374,9 @@ And thank you again to a16z for their generous grant.
 # Original model card: Intel's Neural Chat 7B v3-1
 
 
-## Finetuning on [habana](https://habana.ai/) HPU
+## Fine-tuning on [Habana](https://habana.ai/) Gaudi2
 
-This model is a fine-tuned model based on [mistralai/Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1) on the open source dataset [Open-Orca/SlimOrca](https://huggingface.co/datasets/Open-Orca/SlimOrca). Then we align it with DPO algorithm. For more details, you can refer our blog: [NeuralChat: Simplifying Supervised Instruction Fine-Tuning and Reinforcement Aligning](https://medium.com/intel-analytics-software/neuralchat-simplifying-supervised-instruction-fine-tuning-and-reinforcement-aligning-for-chatbots-d034bca44f69) and [The Practice of Supervised Fine-tuning and Direct Preference Optimization on Habana Gaudi2](https://medium.com/@NeuralCompressor/the-practice-of-supervised-finetuning-and-direct-preference-optimization-on-habana-gaudi2-a1197d8a3cd3).
+This model is a fine-tuned model based on [mistralai/Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1) on the open source dataset [Open-Orca/SlimOrca](https://huggingface.co/datasets/Open-Orca/SlimOrca). Then we align it with DPO algorithm. For more details, you can refer our blog: [The Practice of Supervised Fine-tuning and Direct Preference Optimization on Habana Gaudi2](https://medium.com/@NeuralCompressor/the-practice-of-supervised-finetuning-and-direct-preference-optimization-on-habana-gaudi2-a1197d8a3cd3).
 
 ## Model date
 Neural-chat-7b-v3-1 was trained between September and October, 2023.
@@ -372,10 +406,22 @@ The following hyperparameters were used during training:
 - total_train_batch_size: 64
 - total_eval_batch_size: 8
 - optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
-- lr_scheduler_type: linear
-- lr_scheduler_warmup_ratio: 0.02
+- lr_scheduler_type: cosine
+- lr_scheduler_warmup_ratio: 0.03
 - num_epochs: 2.0
 
+## Prompt Template
+
+```
+### System:
+{system}
+### User:
+{usr}
+### Assistant:
+
+```
+
+
 ## Inference with transformers
 
 ```shell
@@ -401,4 +447,3 @@ The NeuralChat team with members from Intel/SATG/AIA/AIPT. Core team members: Ka
 ## Useful links
 * Intel Neural Compressor [link](https://github.com/intel/neural-compressor)
 * Intel Extension for Transformers [link](https://github.com/intel/intel-extension-for-transformers)
-* Intel Extension for PyTorch [link](https://github.com/intel/intel-extension-for-pytorch)