update

README.md

@@ -1,24 +1,98 @@
 # ANLP_WS24_CA2
+This repository contains the necessary scripts, data, and notebooks for analyzing and modeling the linguistic and structural features of humor in jokes. The project focuses on leveraging NLP techniques to analyze humor in text data, and aims to predict the humor score numerically using regression models.
+
+---
+
+### Objektive
+Leverage advanced NLP techniques (LSTM, CNN, BERT, and Transformer) to analyze text data and build an application that predicts humor ratings.
+
+### Research Question
+
+...
+
+
+## Data Source
+The data is sourced from the SemEval-2021 Task 7: 
+It contains a dataset of humor and offense ratings for jokes. The jokes are annotated with a humor rating on a scale from 0 to 4.
+
+- Traindata: HaHackathon.https://homepages.inf.ed.ac.uk/s1573290/data.html
+- Testdata: Since no test data was available, the traindata was used as test data and divided into test, train and validation data
+
+  
+## Data embeddings
+- gloVe 6B tokens: https://nlp.stanford.edu/projects/glove/
+
+
+### Preprocessing Steps
+1. Daten laden und bereinigen: Der Datensatz wird geladen und alle Zeilen mit fehlenden humor_rating-Werten werden entfernt. Außerdem wird die Zielvariable für die Humorbewertung extrahiert.
+2. Text-Embeddings: Vortrainierte GloVe-Embeddings werden geladen und in eine Matrix umgewandelt, die für die Modellierung genutzt werden kann.
+3. Datenaufteilung: Der Datensatz wird in Trainings-, Test- und Validierungsdaten aufgeteilt, um die Modelle später zu trainieren und zu evaluieren.
+4. Ensemble-Datenindizes: Verschiedene Methoden zur Erstellung von Datenindizes werden bereitgestellt, um die Trainingsdaten für Ensemble-Methoden aufzubereiten.
+
+---
+
+
+## Repository Structure
+
+- **`data/`**: Contains the dataset `hack.csv`, which includes raw joke data.
+- **Notebooks**: 
+  - Used for data analysis and visualization.
+  - represent the models
+
+---
+## Getting Started
+
+### Install Requirements
+Run the following command to install the required dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+## Preprocess Data
+This is carried out automatically when the models are executed
+
+## Workflow
+### 1. Preprocessing
+The text data is cleaned and transformed into formats suitable for analysis. The preprocessing steps include tokenization, stopword removal, and lemmatization.
+
+### 2. Model Training
+Various machine learning models, including Convolutional Neural Networks (CNNs), Long Short-Term Memory Networks (LSTMs), BERT, and Transformers, are trained to predict the humor rating of jokes based on their linguistic features.
+
+### 3. Model Evaluation
+The trained models are evaluated to determine their performance in predicting humor ratings. Metrics such as Mean Squared Error (MSE) and R² scores are used to assess the models.
+
+### 4. Classification and Regression
+While the primary goal of the project is to predict the numerical humor rating (regression task), we also experiment with classification models for humor detection (e.g., humor vs. non-humor)
+
+---
+
+## Research References 
+
+### Key Papers in Humor Detecion
+
+1. **Humor recognition using deep learning.” Humor recognition using deep learning** (https://aclanthology.org/N18-2018.pdf)
+
+2. **ADVERSARIAL TRAINING METHODS FOR SEMI-SUPERVISED TEXT CLASSIFICATION** (https://arxiv.org/pdf/1605.07725)
+
+3. **Humor Detection: A Transformer Gets the Last Laugh** (https://aclanthology.org/D19-1372/)
+
+---
+## Summary
+
+
+
 
 # Master MDS Use NLP techniques to analyse texts or to build an application. Document your approach.
 
 
 
-## TODOS
-data
-- maybe buffer zone between good and bad jokes (trade off would be less data)
-- maybe not bineary classification
-- maybe change to humor detection (more data available)
 
 
-- dataset shape doesnt work correctly
-
-- history: integrate validation loss
 
 ## Data
 
 
-
 https://competitions.codalab.org/competitions/27446
 
 https://aclanthology.org/2021.semeval-1.9.pdf#:~:text=HaHackathon%20is%20the%20first%20shared%20task%20to%20combine,its%20average%20ratings%20for%20both%20humor%20and%20offense.
@@ -28,13 +102,9 @@ https://aclanthology.org/2021.semeval-1.9.pdf#:~:text=HaHackathon%20is%20the%20f
 
 
 
-## Data embeddings
-- gloVe 6B tokens: https://nlp.stanford.edu/projects/glove/
-
-
-
 #### Not Prioritised (Pun data)
 - Challenge https://alt.qcri.org/semeval2017/task7/
 - Pun Annotated Amazon (joke not included ...): https://github.com/amazon-science/expunations/tree/main/data
 
 
+