Update README.md

README.md

@@ -39,7 +39,6 @@ The following hyperparameters were used during training:
 
 ### Training results
 
-
 ### Framework versions
 
 - AutoAWQ 0.1.8
@@ -47,4 +46,42 @@ The following hyperparameters were used during training:
 - Transformers 4.37.0.dev0
 - Pytorch 2.1.2+cu121
 - Datasets 2.16.2.dev0
-- Tokenizers 0.15.0
+- Tokenizers 0.15.0
+
+
+## Example usage
+
+Using `transformers` and `AutoAWQ`:
+
+```shell
+pip install -U transformers autoawq
+```
+
+```
+# Use a pipeline as a high-level helper
+from transformers import pipeline
+
+messages = [
+    {"role": "system", "content": "You are an helpful Assistant."},
+    {"role": "user", "content": "Who are you?"},
+]
+pipe = pipeline("text-generation", model="wasertech/assistant-dolphin-2.2.1-mistral-7b-e1-awq", max_length=8096)
+pipe(messages)
+```
+
+Outputs
+
+```
+[
+  {
+    'generated_text': [
+      {'role': 'system', 'content': 'You are an helpful Assistant.'},
+      {'role': 'user', 'content': 'Who are you?'},
+      {'role': 'assistant', 'content': '<|im_start|> Assistant\nI am an artificial intelligence language model. My purpose is to provide information, advice, and assistance to users. I can perform many tasks, such as answering questions, explaining concepts, generating reports, or summarizing data. I am a tool that can be used to help you learn new things, make decisions, and achieve your goals. I do not have feelings, opinions, or personal experiences; I am simply a helpful resource to share knowledge and support users. What can I do for you?'}
+    ]
+  }
+]
+```
+
+Parsed Assistant answer:
+> I am an artificial intelligence language model. My purpose is to provide information, advice, and assistance to users. I can perform many tasks, such as answering questions, explaining concepts, generating reports, or summarizing data. I am a tool that can be used to help you learn new things, make decisions, and achieve your goals. I do not have feelings, opinions, or personal experiences; I am simply a helpful resource to share knowledge and support users. What can I do for you?