Update README.md

README.md

@@ -38,9 +38,73 @@ BRAG-Llama-3.1-8b-v0.1 is part of the BRAG series of SLMs (Small Language Models
 | BRAG SLM   | BRAG-Llama-3-8b-v0.1      | 8b         | 8k             | 51.70               |
 | BRAG Ultra SLM | BRAG-Qwen2-1.5b-v0.1      | 1.5b       | 32k            | 46.43               |
 
-## How to Use
+## Usage
 
-[Include information on how to use the model]
+#### Prompt Format
+
+Below is the message prompt format required for using the model.
+
+```
+messages = [
+    {"role": "system", "content": "You are a helpful assistant to answer the queries based on the given context."},
+    {"role": "user", "content": """Context: <CONTEXT INFORMATION> \n\n <USER QUERY>"""},
+]
+
+```
+
+#### Running with the `pipeline` API
+
+```python
+import transformers
+import torch
+
+model_id = "maximalists/BRAG-Llama-3.1-8b-v0.1"
+
+pipeline = transformers.pipeline(
+    "text-generation",
+    model=model_id,
+    model_kwargs={"torch_dtype": torch.bfloat16},
+    device_map="auto",
+)
+
+messages = [
+    {"role": "system", "content": "You are a helpful assistant to answer the queries based on the given context."},
+    {"role": "user", "content": """Context:\nArchitecturally, the school has a Catholic character. Atop the Main Building\'s gold dome is a golden statue of the Virgin Mary. Immediately in front of the Main Building and facing it, is a copper statue of Christ with arms upraised with the legend "Venite Ad Me Omnes". Next to the Main Building is the Basilica of the Sacred Heart. Immediately behind the basilica is the Grotto, a Marian place of prayer and reflection. It is a replica of the grotto at Lourdes, France where the Virgin Mary reputedly appeared to Saint Bernadette Soubirous in 1858. At the end of the main drive (and in a direct line that connects through 3 statues and the Gold Dome), is a simple, modern stone statue of Mary.\n\nTo whom did the Virgin Mary allegedly appear in 1858 in Lourdes France?"""},
+]
+
+outputs = pipeline(
+    messages,
+    max_new_tokens=256,
+)
+
+print(outputs[0]["generated_text"][-1])
+```
+
+#### Running the model on a single / multi GPU
+
+```python
+# pip install accelerate
+from transformers import AutoTokenizer, AutoModelForCausalLM
+import torch
+
+model_id = "maximalists/BRAG-Llama-3.1-8b-v0.1"
+
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+model = AutoModelForCausalLM.from_pretrained(
+    model_id,
+    device_map="auto",
+)
+
+messages = [
+    {"role": "system", "content": "You are a helpful assistant to answer the queries based on the given context."},
+    {"role": "user", "content": """Context:\nArchitecturally, the school has a Catholic character. Atop the Main Building\'s gold dome is a golden statue of the Virgin Mary. Immediately in front of the Main Building and facing it, is a copper statue of Christ with arms upraised with the legend "Venite Ad Me Omnes". Next to the Main Building is the Basilica of the Sacred Heart. Immediately behind the basilica is the Grotto, a Marian place of prayer and reflection. It is a replica of the grotto at Lourdes, France where the Virgin Mary reputedly appeared to Saint Bernadette Soubirous in 1858. At the end of the main drive (and in a direct line that connects through 3 statues and the Gold Dome), is a simple, modern stone statue of Mary.\n\nTo whom did the Virgin Mary allegedly appear in 1858 in Lourdes France?"""},
+]
+
+input_ids = tokenizer.apply_chat_template(messages, return_tensors="pt", return_dict=True).to("cuda")
+
+outputs = model.generate(**input_ids, max_new_tokens=256)
+print(tokenizer.decode(outputs[0]))
+```
 
 ## Use Cases