Update README.md
Browse files
README.md
CHANGED
|
@@ -1,12 +1,17 @@
|
|
| 1 |
---
|
| 2 |
language: en
|
| 3 |
-
license:
|
| 4 |
library_name: transformers
|
| 5 |
tags:
|
| 6 |
- llama
|
|
|
|
| 7 |
- causal-lm
|
| 8 |
-
- merged
|
| 9 |
- vllm
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 10 |
inference:
|
| 11 |
parameters:
|
| 12 |
max_new_tokens: 256
|
|
@@ -15,21 +20,25 @@ inference:
|
|
| 15 |
repetition_penalty: 1.1
|
| 16 |
---
|
| 17 |
|
| 18 |
-
# CBT-Copilot
|
| 19 |
|
| 20 |
-
CBT-Copilot is a fine-tuned version of `meta-llama/Llama-3.2-3B-Instruct`, designed to simulate
|
| 21 |
|
| 22 |
-
|
| 23 |
|
| 24 |
-
|
|
|
|
|
|
|
| 25 |
|
| 26 |
-
|
| 27 |
|
| 28 |
```bash
|
| 29 |
-
|
|
|
|
|
|
|
| 30 |
```
|
| 31 |
|
| 32 |
-
Then query it
|
| 33 |
|
| 34 |
```python
|
| 35 |
import openai
|
|
@@ -40,6 +49,7 @@ openai.api_base = "http://localhost:8000/v1"
|
|
| 40 |
response = openai.ChatCompletion.create(
|
| 41 |
model="CBT-Copilot",
|
| 42 |
messages=[
|
|
|
|
| 43 |
{"role": "user", "content": "I've been feeling really anxious lately. What can I do?"}
|
| 44 |
]
|
| 45 |
)
|
|
@@ -47,19 +57,33 @@ response = openai.ChatCompletion.create(
|
|
| 47 |
print(response["choices"][0]["message"]["content"])
|
| 48 |
```
|
| 49 |
|
|
|
|
|
|
|
| 50 |
## 🧠 Intended Use
|
| 51 |
|
| 52 |
-
This model is intended for
|
| 53 |
|
| 54 |
-
|
|
|
|
|
|
|
| 55 |
|
| 56 |
-
This model is
|
| 57 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 58 |
|
| 59 |
---
|
| 60 |
|
| 61 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 62 |
|
| 63 |
---
|
| 64 |
|
| 65 |
-
**
|
|
|
|
|
|
| 1 |
---
|
| 2 |
language: en
|
| 3 |
+
license: mit
|
| 4 |
library_name: transformers
|
| 5 |
tags:
|
| 6 |
- llama
|
| 7 |
+
- llama-3
|
| 8 |
- causal-lm
|
|
|
|
| 9 |
- vllm
|
| 10 |
+
- conversational
|
| 11 |
+
- cognitive-therapy
|
| 12 |
+
- mental-health
|
| 13 |
+
- lora
|
| 14 |
+
- peft
|
| 15 |
inference:
|
| 16 |
parameters:
|
| 17 |
max_new_tokens: 256
|
|
|
|
| 20 |
repetition_penalty: 1.1
|
| 21 |
---
|
| 22 |
|
| 23 |
+
# 🧠 CBT-Copilot
|
| 24 |
|
| 25 |
+
**CBT-Copilot** is a fine-tuned version of [`meta-llama/Llama-3.2-3B-Instruct`](https://huggingface.co/meta-llama/Llama-3.2-3B-Instruct), designed to simulate compassionate and supportive dialogues in the style of **Cognitive Behavioral Therapy (CBT)**.
|
| 26 |
|
| 27 |
+
Fine-tuned using LoRA on the [`Lumiiree/therapod-dpo`](https://huggingface.co/datasets/Lumiiree/therapod-dpo) dataset and merged into a standalone model, it supports deployment through `transformers`, `vLLM`, and other inference frameworks.
|
| 28 |
|
| 29 |
+
---
|
| 30 |
+
|
| 31 |
+
## 🚀 How to Use (with vLLM)
|
| 32 |
|
| 33 |
+
Serve this model using [vLLM](https://github.com/vllm-project/vllm):
|
| 34 |
|
| 35 |
```bash
|
| 36 |
+
pip install vllm[serve]
|
| 37 |
+
|
| 38 |
+
python3 -m vllm.entrypoints.openai.api_server --model thillaic/CBT-Copilot
|
| 39 |
```
|
| 40 |
|
| 41 |
+
Then query it via the OpenAI-compatible API:
|
| 42 |
|
| 43 |
```python
|
| 44 |
import openai
|
|
|
|
| 49 |
response = openai.ChatCompletion.create(
|
| 50 |
model="CBT-Copilot",
|
| 51 |
messages=[
|
| 52 |
+
{"role": "system", "content": "You are a compassionate CBT therapist."},
|
| 53 |
{"role": "user", "content": "I've been feeling really anxious lately. What can I do?"}
|
| 54 |
]
|
| 55 |
)
|
|
|
|
| 57 |
print(response["choices"][0]["message"]["content"])
|
| 58 |
```
|
| 59 |
|
| 60 |
+
---
|
| 61 |
+
|
| 62 |
## 🧠 Intended Use
|
| 63 |
|
| 64 |
+
This model is intended for:
|
| 65 |
|
| 66 |
+
- Mental health chatbot research
|
| 67 |
+
- Journaling and self-reflection tools
|
| 68 |
+
- Prototyping conversational CBT agents
|
| 69 |
|
| 70 |
+
> ⚠️ **Disclaimer**: This model is not a replacement for licensed mental health professionals. It should only be used for **educational, research, or prototyping purposes**.
|
| 71 |
|
| 72 |
+
---
|
| 73 |
+
|
| 74 |
+
## 📜 License
|
| 75 |
+
|
| 76 |
+
Licensed under the **MIT License**.
|
| 77 |
|
| 78 |
---
|
| 79 |
|
| 80 |
+
## 🙏 Acknowledgements
|
| 81 |
+
|
| 82 |
+
- Based on Meta’s LLaMA 3.2B Instruct model
|
| 83 |
+
- Trained on [Lumiiree/therapod-dpo](https://huggingface.co/datasets/Lumiiree/therapod-dpo)
|
| 84 |
+
- Fine-tuning performed with Hugging Face `transformers`, `PEFT`, and `LoRA`
|
| 85 |
|
| 86 |
---
|
| 87 |
|
| 88 |
+
**🛠️ Model developed by [Thillai Chithambaram](https://huggingface.co/thillaic)**
|
| 89 |
+
|