huvucode commited on
Commit
7923af4
·
verified ·
1 Parent(s): 428ce69

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +22 -6
README.md CHANGED
@@ -29,15 +29,31 @@ PsychAdapter is a modular framework designed to adapt Large Language Models (LLM
29
  - **Repository:** https://github.com/humanlab/psychadapter
30
  - **Paper:** https://www.nature.com/articles/s44387-026-00071-9
31
 
32
- ## Checkpoint Structure
33
 
34
- The provided checkpoints include the following components:
35
 
36
- 1. **Base Models:** The foundational pre-trained LLM weights (e.g., Gemma-2b) used as the backbone for adaptation.
37
- 2. **LoRA Weights (Big 5):** Specialized Low-Rank Adaptation (LoRA) weights trained specifically on the Big Five personality traits (Openness, Conscientiousness, Extraversion, Agreeableness, Neuroticism).
38
- 3. **LoRA Weights (Mental Health):** Specialized LoRA weights trained to reflect mental health variables, specifically Depression and Satisfaction with Life (SWL).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
39
 
40
- These adapters are designed to be swapped or combined to steer the base model's output according to the desired psychological profile.
41
 
42
  ## Intended Use
43
 
 
29
  - **Repository:** https://github.com/humanlab/psychadapter
30
  - **Paper:** https://www.nature.com/articles/s44387-026-00071-9
31
 
32
+ ## Checkpoint Structure & Setup
33
 
34
+ The model checkpoints are provided as separate ZIP files to keep the psychological dimensions modular. Note that each model requires the shared decoder weights to function.
35
 
36
+ ### 1. Downloaded Files:
37
+ * **big5_model.zip**: LoRA weights and projection matrix weights for Big Five personality traits.
38
+ * **dep_model.zip**: LoRA weights and projection matrix weights for Depression markers.
39
+ * **swl_model.zip**: LoRA weights and projection matrix weights for Satisfaction with Life.
40
+ * **decoder.zip**: Contains the shared base model/decoder weights required by all adapters.
41
+
42
+ ### 2. Assembly Instructions:
43
+ All model directories contain an empty `decoder/` subdirectory. To use the models, you must manually populate these directories:
44
+
45
+ 1. Unzip your desired model (e.g., `big5_model.zip`).
46
+ 2. Unzip `decoder.zip`.
47
+ 3. Copy the entire **content** of the unzipped `decoder` folder into the `decoder/` directory located inside your model folder (e.g., `big5_model/decoder/`).
48
+
49
+ **Note:** The models will fail to load if the `decoder/` directory is empty or missing the shared weights.
50
+
51
+ ## Checkpoint Details
52
+
53
+ * **Base Models:** Found in `decoder.zip` (e.g., Gemma-2b backbone).
54
+ * **LoRA Weights (Big 5):** Found in `big5_model.zip`, trained on Openness, Conscientiousness, Extraversion, Agreeableness, and Neuroticism.
55
+ * **LoRA Weights (Mental Health):** Found in `dep_model.zip` (Depression) and `swl_model.zip` (Satisfaction with Life).
56
 
 
57
 
58
  ## Intended Use
59