Abhinayathir/memory-triggered-emotion-classifier

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: Abhinayathir
• —Funded by [optional]: Personal project
• —Shared by [optional]: Abhinayathir
• —Model type: Text Classification, Emotion Recognition
• —Language(s) (NLP): English
• —License: MIT
• —Finetuned from model [optional]: DistilBERT

Model Sources [optional]

<!-- Provide the basic links for the model. -->

• —Repository: https://huggingface.co/Abhinayathir/memory-triggered-emotion-classifier
• —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. -->

The model can be used in therapeutic applications to assist users in recalling personal memories based on their current emotional state. It can be used in apps or websites offering emotional support and well-being services.

Downstream Use [optional]

<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->

The model can be integrated into mental health apps, chatbots, or virtual assistants that aim to offer emotional support by recalling memories.

Out-of-Scope Use

<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->

This model should not be used in any context that involves medical diagnosis or as a substitute for professional mental health counseling.

Bias, Risks, and Limitations

<!-- This section is meant to convey both technical and sociotechnical limitations. -->

• —The model is trained on a limited dataset and might not capture all emotional nuances from users of different cultural backgrounds.
• —It may not always provide the most accurate or helpful memory recall, as it relies on the emotional input from the user, which might be misinterpreted in some cases.
• —The model is not a replacement for professional therapy or mental health support and should only be used for general emotional support.

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.

from transformers import pipeline

Load the model

memory_recaller = pipeline("text-classification", model="Abhinayathir/memory-triggered-emotion-classifier")

Input user's emotional state

userinput = "I am feeling sad" recalledmemory = memoryrecaller(userinput) print(recalled_memory)

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. -->

Dataset Source: Custom dataset created for training emotional classification models. The dataset contains labeled emotional states such as “sad”, “happy”, “anxious”, “excited”, etc., along with associated memories. Data Processing: Text data was preprocessed using tokenization and padding to make it suitable for transformer-based models. Emotions were labeled based on the dataset descriptions.

Training Procedure

<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->

The model was trained on labeled emotional state data for emotion classification. It used fine-tuning techniques on a pre-trained DistilBERT model.

Preprocessing [optional]

Text Tokenization: Text was tokenized using the Hugging Face DistilBERT tokenizer, converting input text into token IDs. Padding and Truncation: Inputs were padded to a fixed length of 128 tokens, and truncation was applied to longer texts. Normalization: Input text was normalized to lowercase for consistency.

Training Hyperparameters

• —Training regime: fp16 mixed precision <!--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. -->

Epochs: 3 epochs Batch Size: 32 Learning Rate: 5e-5 Optimizer: AdamW

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 presented in Lacoste et al. (2019).

• —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]