Adding code for usage with HuggingFace transformers. (#1)

- Adding code for usage with HuggingFace transformers. (bb75d42fcd9ad9c15c33e6bc026e37f8a4d67270)


Co-authored-by: Leonard Püttmann <[email protected]>

README.md

@@ -133,6 +133,28 @@ This model uses a specific chat format for optimal performance.
 [The model's response]</s>
 ```
 
+## Usage with HuggingFace transformers 
+The model can be used with HuggingFace's `transformers` library:
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+model = AutoModelForCausalLM.from_pretrained("OuteAI/Lite-Mistral-150M-v2-Instruct")
+tokenizer = AutoTokenizer.from_pretrained("OuteAI/Lite-Mistral-150M-v2-Instruct")
+
+def generate_response(message):
+    # Encode the formatted message as input ids
+    input_ids = tokenizer.encode(f"<s>user\n{message}</s>", return_tensors="pt")
+    output = model.generate(input_ids, max_length=100, pad_token_id=tokenizer.eos_token_id)
+
+    # Decode the generated output
+    generated_text = tokenizer.decode(output[0], skip_special_tokens=True)
+    
+    return generated_text
+
+message = "What is the capital of Spain?"
+response = generate_response(message)
+```
+
 ## Risk Disclaimer
 
 By using this model, you acknowledge that you understand and assume the risks associated with its use. You are solely responsible for ensuring compliance with all applicable laws and regulations. We disclaim any liability for problems arising from the use of this open-source model, including but not limited to direct, indirect, incidental, consequential, or punitive damages. We make no warranties, express or implied, regarding the model's performance, accuracy, or fitness for a particular purpose. Your use of this model is at your own risk, and you agree to hold harmless and indemnify us, our affiliates, and our contributors from any claims, damages, or expenses arising from your use of the model.