Update README.md

README.md

@@ -3,32 +3,37 @@ license: apache-2.0
 library_name: peft
 tags:
 - generated_from_trainer
+- mistral 
+- text-generation
+- Transformers
 base_model: mistralai/Mistral-7B-Instruct-v0.2
 model-index:
 - name: mental-health-mistral-7b-instructv0.2-finetuned-V2
   results: []
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
 
 # mental-health-mistral-7b-instructv0.2-finetuned-V2
 
-This model is a fine-tuned version of [mistralai/Mistral-7B-Instruct-v0.2](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2) on the None dataset.
+This model is a fine-tuned version of [mistralai/Mistral-7B-Instruct-v0.2](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2) on the [mental_health_counseling_conversations](https://huggingface.co/datasets/Amod/mental_health_counseling_conversations) dataset.     
 It achieves the following results on the evaluation set:
 - Loss: 0.6432
 
-## Model description
+## Model description  
 
-More information needed
+A Mistral-7B-Instruct-v0.2 model finetuned on a corpus of mental health conversations between a psychologist and a user.    
+The intention was to create a mental health assistant, "Connor", to address user questions based on responses from a psychologist.     
 
-## Intended uses & limitations
+## Intended uses & limitations    
 
-More information needed
+Intended to be used as a mental health chatbot to respond to user queries.    
 
 ## Training and evaluation data
 
-More information needed
+The model is finetuned on a corpus of mental health conversations between a psychologist and a client, in the form of context - response pairs. This dataset is a collection of questions and answers sourced from two online counseling and therapy platforms. The questions cover a wide range of mental health topics, and the answers are provided by qualified psychologists.         
+Dataset found here :-      
+* [Kaggle](https://www.kaggle.com/datasets/thedevastator/nlp-mental-health-conversations)
+* [Huggingface](https://huggingface.co/datasets/Amod/mental_health_counseling_conversations)
 
 ## Training procedure
 
@@ -53,6 +58,46 @@ The following hyperparameters were used during training:
 | 1.2608        | 2.0   | 704  | 0.6956          |
 | 1.1845        | 3.0   | 1056 | 0.6432          |
 
+# Usage
+
+```python
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer
+from peft import PeftConfig, PeftModel
+
+base_model = "mistralai/Mistral-7B-Instruct-v0.2"
+adapter = "GRMenon/mental-health-mistral-7b-instructv0.2-finetuned-V2"
+
+# Load tokenizer
+tokenizer = AutoTokenizer.from_pretrained(
+    base_model,
+    add_bos_token=True,
+    trust_remote_code=True,
+    padding_side='left'
+)
+
+# Create peft model using base_model and finetuned adapter
+config = PeftConfig.from_pretrained(adapter)
+model = AutoModelForCausalLM.from_pretrained(config.base_model_name_or_path, load_in_4bit=True, device_map='auto', torch_dtype='auto')
+model = PeftModel.from_pretrained(model, adapter)
+
+device = "cuda" if torch.cuda.is_available() else "cpu"
+model.to(device)
+model.eval()
+
+# Prompt content:
+messages = [
+    {"role": "user", "content": "Hey Connor! I have been feeling a bit down lately. I could really use some advice on how to feel better?"}
+]
+
+input_ids = tokenizer.apply_chat_template(conversation=messages, tokenize=True, add_generation_prompt=True, return_tensors='pt').to(device)
+output_ids = model.generate(input_ids=input_ids, max_new_tokens=512, do_sample=True, pad_token_id=2)
+response = tokenizer.batch_decode(output_ids.detach().cpu().numpy(), skip_special_tokens = True)
+
+# Model response: 
+print(response[0])
+```
+
 
 ### Framework versions