Update README.md

README.md

@@ -64,5 +64,87 @@ model-index:
 library_name: transformers
 ---
 
+# ibleducation/ibl-tutoring-llm-openchat
+ibleducation/ibl-tutoring-llm-openchat is a model finetuned on top of openchat/openchat_3.5
 
-# ibleducation/ibl-tutoring-llm-openchat
+This model is finetuned to give responses in a way befitting of a professional teacher
+
+
+## Example Conversations
+1. Question:  I'm having trouble understanding this art movement. Can you help me? \
+   Answer:
+   ```code
+   Yes I can assist you, that is what I am here for. We can start by analyzing the artists' techniques, their motivations, and find creative ways to connect with the movement. Remember, it's important to be open to different perspectives and interpretations.
+   ```
+   
+2. Question: I am thinking of stopping school do you think it is right? \
+   Answer:
+   ```code
+   I understand that school can be challenging, but I believe that education is important. I'm here to for you. Where you have troubles, I will be happy to help
+   ```
+  
+
+## Motivation of Developing ibl-tutoring-llm-32k Model
+
+Students today use llm's in their learning and research. However, most models are not trained to behave and respond to conversations with the virtues a teacher must possess. ibl-tutoring-llm-32k Model is fine tuned 
+on top of amazon/Mistrallite to alter its behaviour to converse the way a teacher should
+
+
+## Model Details
+
+- **Developed by:** [IBL Education](https://ibl.ai)
+- **Model type:** [Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1)
+- **Base Model:** [OpenChat 3.5](https://huggingface.co/openchat/openchat_3.5)
+- **Language:** English
+- **Finetuned from weights:** [OpenChat 3.5](https://huggingface.co/openchat/openchat_3.5)
+- **Finetuned on data:**
+  - IBL-tutoring-dataset (private)
+- **Model License:** Apache 2.0
+
+## How to Use ibl-tutoring-llm-openchat Model from Python Code (HuggingFace transformers) ##
+
+### Install the necessary packages
+
+Requires: [transformers](https://pypi.org/project/transformers/) 4.34.0 or later, [flash-attn](https://pypi.org/project/flash-attn/) 2.3.1.post1 or later, 
+and [accelerate](https://pypi.org/project/accelerate/) 0.23.0 or later.
+
+```shell
+pip install transformers==4.34.0
+pip install accelerate==0.23.0
+```
+### You can then try the following example code
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+import transformers
+import torch
+
+model_id = "ibleducation/ibl-tutoring-llm-openchat"
+
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+model = AutoModelForCausalLM.from_pretrained(
+  model_id,
+  device_map="auto",
+)
+pipeline = transformers.pipeline(
+    "text-generation",
+    model=model,
+    tokenizer=tokenizer,
+)
+prompt = "<s>What makes a good teacher?</s>"
+
+sequences = pipeline(
+    prompt,
+    max_new_tokens=400,
+    do_sample=False,
+    return_full_text=False,
+    num_return_sequences=1,
+    eos_token_id=tokenizer.eos_token_id,
+)
+for seq in sequences:
+    print(f"{seq['generated_text']}")
+```
+**Important** - Use the prompt template below for ibl-tutoring-llm-32k:
+```
+<s>{prompt}</s>
+```