AIPsy
/

bert-base-client-topic-classification-eng

@@ -1,199 +1,179 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- 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. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-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).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
 **BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
 library_name: transformers
+license: mit
+language:
+- en
+base_model:
+- google-bert/bert-base-uncased
+pipeline_tag: text-classification
+tags:
+- PyTorch
+- multi-class-classification
 ---
+This is Bert-base-uncased model fine-tuned for topic classification of therapist remarks in psychotherapeutic contexts. The task is a multi-class classification with the following labels:
+```python
+id2label = {0: 'Others',
+           1: 'Relationship with a Female Figure',
+           2: 'Experiencing and Articulating Emotions',
+           3: 'Work and Personal Fulfillment',
+           4: 'Relationship with a Male Figure',
+           5: 'Meaning-Making and Conceptualization',
+           6: 'Education and Personal Development',
+           7: 'Experience of Fear and Anxiety',
+           8: 'Sexual Relationships and Identity',
+           9: 'Expression and Communication Difficulties',
+           10: 'Self-Acceptance and Social Relationships',
+           11: 'Time Perception and Management',
+           12: 'Cyclical Patterns of Experience',
+           13: 'Therapy Experience and Reflection',
+           14: 'Positive Emotional Experience',
+           15: 'Mother-Child Relationship Dynamics',
+           16: 'Creativity and Emotional Expression',
+           17: 'Humor and Cognitive Reframing',
+           18: 'Emotional Disturbance and Regulation',
+           19: 'Expressions of Certainty',
+           20: 'Guilt and Responsibility',
+           21: 'Self-Reflection on Maturity',
+           22: 'Sleep-Wake Cycle and Daily Rhythm',
+           23: 'Life Orientation and Authenticity',
+           24: 'Home and Attachment-Autonomy Conflict',
+           25: 'Parenting and Family Responsibility',
+           26: 'Internal Conflict and Emotional Regulation',
+           27: 'Friendship Dynamics',
+           28: 'Reflection and Awareness of Unconsidered Thought',
+           29: 'Reading as Cognitive and Reflective Engagement',
+           30: 'Processes of Personal Change',
+           31: 'Emotional Pain and Hurt',
+           32: 'Belief, Faith, and Existential Doubt',
+           33: 'Evaluation of Neurotic and Healthy States',
+           34: 'Emotional Distress and Negative Evaluation',
+           35: 'Experience and Regulation of Anger',
+           36: 'Positive Emotional Evaluation',
+           37: 'Dream Experience and Symbolic Processing',
+           38: 'Father-Child Relationship Dynamics',
+           39: 'Problem Framing and Self-Resolution',
+           40: 'Personal Learning Experiences',
+           41: 'Racial Identity and Intergroup Relations',
+           42: 'Healthcare Interactions and Medical Authority',
+           43: 'Uncertainty about Correctness',
+           44: 'Evaluation of Marriage',
+           45: 'Marital Relationship and Communication',
+           46: 'Self-Worth and Capacity for Love',
+           47: 'Self-Expression Through Appearance'}
+```
+## Usage
+```python
+from transformers import AutoTokenizer, AutoModelForSequenceClassification
+tokenizer = AutoTokenizer.from_pretrained("AIPsy/bert-base-client-topic-classification-eng")
+model = AutoModelForSequenceClassification.from_pretrained("AIPsy/bert-base-client-topic-classification-eng")
+text = "You know, I mean, it seems like you could just go to work and feel so much better."
+encoding = tokenizer(
+            text,
+            truncation=True,
+            padding="max_length",
+            return_tensors="pt"
+        )
+output = model(encoding['input_ids'], encoding['attention_mask']).logits
+result = np.argmax(output.detach().numpy(), axis=-1)
+print(id2label[result[0]])
+'Job Anxiety and Self-Reflection'
+```
+## Dataset
+The source material was the recordings of psychotherapeutic sessions posted on YouTube in the public domain. After conducting speaker diarization and transcription of the recordings 15324 items (sentences) were obtained.
+## Recommendations
+Given the broad context of issues discussed in psychotherapeutic sessions, the authors believe that this model can be used to analyze human communication in general.
+## Metrics
+Score metrics of trained model
+|Sample|F1 macro|
+|:-|:-:|
+|Test|0.76|
+|Validation|0.76|
+|Train|0.99|
+F1 score metrics for test sample across categories
+|ID|Topic|Precision|Recall|F1|
+|:-:|:-|:-:|:-:|:-:|
+| 0 | Others | 0.92 | 0.98 | 0.95 |
+| 1 | Relationship with a Female Figure | 0.94 | 0.94 | 0.94 |
+| 2 | Experiencing and Articulating Emotions | 0.88 | 0.77 | 0.82 |
+| 3 | Work and Personal Fulfillment | 0.71 | 0.72 | 0.72 |
+| 4 | Relationship with a Male Figure | 0.90 | 0.92 | 0.91 |
+| 5 | Meaning-Making and Conceptualization | 0.69 | 0.80 | 0.74 |
+| 6 | Education and Personal Development | 0.84 | 0.85 | 0.85 |
+| 7 | Experience of Fear and Anxiety | 0.82 | 0.84 | 0.83 |
+| 8 | Sexual Relationships and Identity | 0.79 | 0.75 | 0.77 |
+| 9 | Expression and Communication Difficulties | 0.69 | 0.77 | 0.73 |
+| 10 | Self-Acceptance and Social Relationships | 0.67 | 0.69 | 0.68 |
+| 11 | Time Perception and Management | 0.82 | 0.75 | 0.79 |
+| 12 | Cyclical Patterns of Experience | 0.81 | 0.75 | 0.78 |
+| 13 | Therapy Experience and Reflection | 0.79 | 0.79 | 0.79 |
+| 14 | Positive Emotional Experience | 0.72 | 0.67 | 0.70 |
+| 15 | Mother-Child Relationship Dynamics | 0.81 | 0.74 | 0.77 |
+| 16 | Creativity and Emotional Expression | 0.78 | 0.72 | 0.75 |
+| 17 | Humor and Cognitive Reframing | 0.75 | 0.58 | 0.66 |
+| 18 | Emotional Disturbance and Regulation | 0.76 | 0.70 | 0.73 |
+| 19 | Expressions of Certainty | 0.86 | 0.90 | 0.88 |
+| 20 | Guilt and Responsibility | 0.65 | 0.74 | 0.70 |
+| 21 | Self-Reflection on Maturity | 0.64 | 0.65 | 0.64 |
+| 22 | Sleep-Wake Cycle and Daily Rhythm | 0.66 | 0.73 | 0.69 |
+| 23 | Life Orientation and Authenticity | 0.62 | 0.64 | 0.63 |
+| 24 | Home and Attachment-Autonomy Conflict | 0.91 | 0.69 | 0.79 |
+| 25 | Parenting and Family Responsibility | 0.83 | 0.73 | 0.78 |
+| 26 | Internal Conflict and Emotional Regulation | 0.74 | 0.80 | 0.77 |
+| 27 | Friendship Dynamics | 0.64 | 0.66 | 0.65 |
+| 28 | Reflection and Awareness of Unconsidered Thought | 0.69 | 0.79 | 0.74 |
+| 29 | Reading as Cognitive and Reflective Engagement | 0.74 | 0.81 | 0.78 |
+| 30 | Processes of Personal Change | 0.69 | 0.61 | 0.65 |
+| 31 | Emotional Pain and Hurt | 0.81 | 0.81 | 0.81 |
+| 32 | Belief, Faith, and Existential Doubt | 0.91 | 0.85 | 0.88 |
+| 33 | Evaluation of Neurotic and Healthy States | 0.62 | 0.77 | 0.69 |
+| 34 | Emotional Distress and Negative Evaluation | 0.66 | 0.69 | 0.67 |
+| 35 | Experience and Regulation of Anger | 0.76 | 0.76 | 0.76 |
+| 36 | Positive Emotional Evaluation | 0.67 | 0.70 | 0.68 |
+| 37 | Dream Experience and Symbolic Processing | 0.83 | 0.88 | 0.86 |
+| 38 | Father-Child Relationship Dynamics | 0.83 | 0.71 | 0.77 |
+| 39 | Problem Framing and Self-Resolution | 0.71 | 0.56 | 0.62 |
+| 40 | Personal Learning Experiences | 0.73 | 0.56 | 0.63 |
+| 41 | Racial Identity and Intergroup Relations | 0.73 | 0.92 | 0.81 |
+| 42 | Healthcare Interactions and Medical Authority | 0.76 | 0.83 | 0.79 |
+| 43 | Uncertainty about Correctness | 0.86 | 0.72 | 0.78 |
+| 44 | Evaluation of Marriage | 0.78 | 0.95 | 0.86 |
+| 45 | Marital Relationship and Communication | 0.81 | 0.85 | 0.83 |
+| 46 | Self-Worth and Capacity for Love | 0.77 | 0.74 | 0.76 |
+| 47 | Self-Expression Through Appearance | 0.68 | 0.63 | 0.65 |
+## Citation
+- **Papers:** Vanin, A., Bolshev, V., & Panfilova, A. (2024). Applying LLM and Topic Modelling in Psychotherapeutic Contexts. ArXiv, abs/2412.17449. <https://arxiv.org/abs/2412.17449>
+- **Developed by:** @myentity, @VadZhen, @Alek123
+- **License:** MIT
 **BibTeX:**
+```
+@misc{vanin2024applyingllmtopicmodelling,
+      title={Applying LLM and Topic Modelling in Psychotherapeutic Contexts},
+      author={Alexander Vanin and Vadim Bolshev and Anastasia Panfilova},
+      year={2024},
+      eprint={2412.17449},
+      archivePrefix={arXiv},
+      primaryClass={cs.LG},
+      url={https://arxiv.org/abs/2412.17449},
+}
+```