Update README.md
Browse files
README.md
CHANGED
@@ -9,202 +9,108 @@ tags:
|
|
9 |
- transformers
|
10 |
- trl
|
11 |
- unsloth
|
|
|
|
|
|
|
|
|
|
|
12 |
---
|
13 |
|
14 |
-
# Model Card for
|
15 |
-
|
16 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
17 |
-
|
18 |
-
|
19 |
-
|
20 |
-
## Model Details
|
21 |
|
22 |
### Model Description
|
23 |
|
24 |
-
|
25 |
-
|
26 |
-
|
27 |
-
|
28 |
-
- **Developed by:** [More Information Needed]
|
29 |
-
- **Funded by [optional]:** [More Information Needed]
|
30 |
-
- **Shared by [optional]:** [More Information Needed]
|
31 |
-
- **Model type:** [More Information Needed]
|
32 |
-
- **Language(s) (NLP):** [More Information Needed]
|
33 |
-
- **License:** [More Information Needed]
|
34 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
35 |
-
|
36 |
-
### Model Sources [optional]
|
37 |
-
|
38 |
-
<!-- Provide the basic links for the model. -->
|
39 |
|
40 |
-
- **
|
41 |
-
- **
|
42 |
-
- **
|
|
|
|
|
|
|
43 |
|
44 |
## Uses
|
45 |
|
46 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
47 |
-
|
48 |
### Direct Use
|
49 |
|
50 |
-
|
51 |
-
|
52 |
-
|
53 |
-
|
54 |
-
### Downstream Use [optional]
|
55 |
-
|
56 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
57 |
-
|
58 |
-
[More Information Needed]
|
59 |
-
|
60 |
-
### Out-of-Scope Use
|
61 |
-
|
62 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
63 |
-
|
64 |
-
[More Information Needed]
|
65 |
|
66 |
## Bias, Risks, and Limitations
|
67 |
|
68 |
-
|
69 |
-
|
70 |
-
|
71 |
-
|
72 |
-
### Recommendations
|
73 |
-
|
74 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
75 |
-
|
76 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
77 |
|
78 |
## How to Get Started with the Model
|
79 |
|
80 |
-
|
81 |
-
|
82 |
-
|
83 |
-
|
84 |
-
## Training Details
|
85 |
-
|
86 |
-
### Training Data
|
87 |
-
|
88 |
-
<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
|
89 |
-
|
90 |
-
[More Information Needed]
|
91 |
-
|
92 |
-
### Training Procedure
|
93 |
-
|
94 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
95 |
-
|
96 |
-
#### Preprocessing [optional]
|
97 |
-
|
98 |
-
[More Information Needed]
|
99 |
-
|
100 |
-
|
101 |
-
#### Training Hyperparameters
|
102 |
|
103 |
-
|
104 |
|
105 |
-
|
|
|
|
|
|
|
|
|
106 |
|
107 |
-
|
108 |
|
109 |
-
[More Information Needed]
|
110 |
|
111 |
-
|
112 |
|
113 |
-
|
|
|
114 |
|
115 |
-
###
|
|
|
116 |
|
117 |
-
|
|
|
118 |
|
119 |
-
<!-- This should link to a Dataset Card if possible. -->
|
120 |
|
121 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
122 |
|
123 |
-
#### Factors
|
124 |
|
125 |
-
|
126 |
|
127 |
-
|
|
|
128 |
|
129 |
-
|
130 |
|
131 |
-
|
132 |
-
|
133 |
-
[More Information Needed]
|
134 |
-
|
135 |
-
### Results
|
136 |
-
|
137 |
-
[More Information Needed]
|
138 |
-
|
139 |
-
#### Summary
|
140 |
-
|
141 |
-
|
142 |
-
|
143 |
-
## Model Examination [optional]
|
144 |
-
|
145 |
-
<!-- Relevant interpretability work for the model goes here -->
|
146 |
-
|
147 |
-
[More Information Needed]
|
148 |
-
|
149 |
-
## Environmental Impact
|
150 |
-
|
151 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
152 |
-
|
153 |
-
Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
|
154 |
-
|
155 |
-
- **Hardware Type:** [More Information Needed]
|
156 |
-
- **Hours used:** [More Information Needed]
|
157 |
-
- **Cloud Provider:** [More Information Needed]
|
158 |
-
- **Compute Region:** [More Information Needed]
|
159 |
-
- **Carbon Emitted:** [More Information Needed]
|
160 |
-
|
161 |
-
## Technical Specifications [optional]
|
162 |
-
|
163 |
-
### Model Architecture and Objective
|
164 |
-
|
165 |
-
[More Information Needed]
|
166 |
-
|
167 |
-
### Compute Infrastructure
|
168 |
-
|
169 |
-
[More Information Needed]
|
170 |
-
|
171 |
-
#### Hardware
|
172 |
-
|
173 |
-
[More Information Needed]
|
174 |
-
|
175 |
-
#### Software
|
176 |
-
|
177 |
-
[More Information Needed]
|
178 |
-
|
179 |
-
## Citation [optional]
|
180 |
-
|
181 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
182 |
-
|
183 |
-
**BibTeX:**
|
184 |
-
|
185 |
-
[More Information Needed]
|
186 |
-
|
187 |
-
**APA:**
|
188 |
-
|
189 |
-
[More Information Needed]
|
190 |
-
|
191 |
-
## Glossary [optional]
|
192 |
-
|
193 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
194 |
-
|
195 |
-
[More Information Needed]
|
196 |
-
|
197 |
-
## More Information [optional]
|
198 |
|
199 |
-
|
200 |
|
201 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
202 |
|
203 |
-
|
|
|
|
|
204 |
|
205 |
-
## Model Card Contact
|
206 |
|
207 |
-
[More Information Needed]
|
208 |
### Framework versions
|
209 |
|
210 |
- PEFT 0.17.1
|
|
|
9 |
- transformers
|
10 |
- trl
|
11 |
- unsloth
|
12 |
+
license: mit
|
13 |
+
datasets:
|
14 |
+
- samhog/psychology-RLHF
|
15 |
+
language:
|
16 |
+
- en
|
17 |
---
|
18 |
|
19 |
+
# Model Card for Psychology-RLHF
|
|
|
|
|
|
|
|
|
|
|
|
|
20 |
|
21 |
### Model Description
|
22 |
|
23 |
+
This model is a fine-tuned version of Qwen2.5-0.5B-Instruct on the samhog/psychology-RLHF dataset using ORPO.
|
24 |
+
The primary objective was to experiment with Reinforcement Learning from Human Feedback (RLHF) via ORPO, focusing on preference alignment.
|
25 |
+
The dataset comes from the psychology domain, but the main purpose of this fine-tuning was to study and demonstrate the effectiveness of ORPO for aligning small-scale instruction-tuned models.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
26 |
|
27 |
+
- **Language(s) (NLP):** English
|
28 |
+
- **License:** MIT
|
29 |
+
- **Finetuned from model:** unsloth/Qwen2.5-0.5B-Instruct
|
30 |
+
- **Fine-tuning Method**: ORPO (Offline Reinforcement Preference Optimization)
|
31 |
+
- **Dataset**: samhog/psychology-RLHF
|
32 |
+
- **Domain**: Psychology, mental health reasoning, and conversational alignment
|
33 |
|
34 |
## Uses
|
35 |
|
|
|
|
|
36 |
### Direct Use
|
37 |
|
38 |
+
- Educational and research purposes in psychology-related question-answering.
|
39 |
+
- Conversational agents for safe psychology discussions.
|
40 |
+
- Research on RLHF and ORPO fine-tuning in domain-specific contexts.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
41 |
|
42 |
## Bias, Risks, and Limitations
|
43 |
|
44 |
+
- This model is not a substitute for professional mental health advice.
|
45 |
+
- Trained on synthetic/human preference data β may still generate biased or hallucinated content.
|
46 |
+
- Small-scale model (0.5B parameters) β limited reasoning ability compared to larger LLMs.
|
|
|
|
|
|
|
|
|
|
|
|
|
47 |
|
48 |
## How to Get Started with the Model
|
49 |
|
50 |
+
```python
|
51 |
+
from huggingface_hub import login
|
52 |
+
from transformers import AutoTokenizer, AutoModelForCausalLM
|
53 |
+
from peft import PeftModel
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
54 |
|
55 |
+
login(token="")
|
56 |
|
57 |
+
tokenizer = AutoTokenizer.from_pretrained("unsloth/Qwen2.5-0.5B-Instruct",)
|
58 |
+
base_model = AutoModelForCausalLM.from_pretrained(
|
59 |
+
"unsloth/Qwen2.5-0.5B-Instruct",
|
60 |
+
device_map={"": 0}, token=""
|
61 |
+
)
|
62 |
|
63 |
+
model = PeftModel.from_pretrained(base_model,"khazarai/Psychology-RLHF")
|
64 |
|
|
|
65 |
|
66 |
+
prompt = """Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.
|
67 |
|
68 |
+
### Instruction:
|
69 |
+
{}
|
70 |
|
71 |
+
### Input:
|
72 |
+
{}
|
73 |
|
74 |
+
### Response:
|
75 |
+
{}"""
|
76 |
|
|
|
77 |
|
78 |
+
inputs = tokenizer(
|
79 |
+
[
|
80 |
+
prompt.format(
|
81 |
+
"You are an AI assistant that helps people find information",
|
82 |
+
"I'm having trouble with my teenage child. They're acting out and I don't know what to do.",
|
83 |
+
"",
|
84 |
+
)
|
85 |
+
],
|
86 |
+
return_tensors="pt",
|
87 |
+
).to("cuda")
|
88 |
|
|
|
89 |
|
90 |
+
from transformers import TextStreamer
|
91 |
|
92 |
+
text_streamer = TextStreamer(tokenizer)
|
93 |
+
_ = model.generate(**inputs, streamer=text_streamer, max_new_tokens=512)
|
94 |
|
95 |
+
```
|
96 |
|
97 |
+
## Training Details
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
98 |
|
99 |
+
Training Metrics:
|
100 |
|
101 |
+
- Training Loss: β from 1.86 β 0.2978
|
102 |
+
- NLL Loss: β from 1.77 β 0.34
|
103 |
+
- Reward (Chosen): -0.19 β -0.037
|
104 |
+
- Reward (Rejected): -0.20 β -0.150
|
105 |
+
- Reward Gap: β +0.11
|
106 |
+
|
107 |
+
Interpretation:
|
108 |
|
109 |
+
- Losses decreased steadily, indicating stable convergence.
|
110 |
+
- Chosen rewards improved toward 0, while rejected remained lower, showing preference alignment.
|
111 |
+
- Final model demonstrates improved distinction between good vs. bad responses.
|
112 |
|
|
|
113 |
|
|
|
114 |
### Framework versions
|
115 |
|
116 |
- PEFT 0.17.1
|