Lajavaness
/

wav2vec2-lg-xlsr-fr-speech-emotion-recognition

@@ -1,199 +1,83 @@
 ---
 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]

 ---
+language:
+- fr
+license: apache-2.0
 library_name: transformers
+tags:
+- emotion-recognition
+- speech
+- french
+- classification
+- audio
+- emotion
+- wav2vec2
+metrics:
+- f1
+pipeline_tag: audio-classification
 ---
+# Speech Emotion Recognition model for French conversation
+This model is a simple 5-classes multilabel classifier trained on a proprietary dataset containing real life conversations in the French language.
+The model is trained on a large number of speakers (>30) in a wide variety of contexts and environment with varying audio quality.
+It has been developed within the frame of the R&D at La Javaness as part of a [Master Thesis project](https://odr.chalmers.se/server/api/core/bitstreams/5180e50c-cb17-4cb0-8abb-bbdcabeea6af/content) for developping a multi-task conversational analysis tool for real conversation.
+The development of this model aims at reducing the accuracy gap between benchmark emotion classification models where audio are professionnaly recorded actors with highly stereotyped emotion expression and emotion expression in a _real life_ context. Hence, we developed this model to provide more convenient and usable solutions for emotion recognition in real life context (e.g. Call centers, interview analysis, etc.)
+<img src="https://cdn-uploads.huggingface.co/production/uploads/63bd79a1d7dea2e13e55083d/iD_8-jQPPf5QolRsYToWI.png" alt="model-architecture" width="400"/>
+## Classes
+The model is trained with 5-classes based on defined subspaces from Valence-Arousal emotion space. The number of classes has been reduced to 5 to improve overall performance while covering most of the conceptual Valence-Arousal space.
+```python
+['Pleased','Relaxed','Neutral','Sad','Tension']
+```
+<img src="https://cdn-uploads.huggingface.co/production/uploads/63bd79a1d7dea2e13e55083d/JwuwrvmlbnQV0IZlkV2QT.png" alt="emotion-mapping" width="400"/>
 ## Evaluation
+_Notes : This model aims at providing solution for emotion classification for real life conversation in French language. While performance of the model remains quite poor on usual benchmark English and French datasets. We observe that the performance on real conversations improves compare to models trained with benchmark datasets. In addition, one should acknowledge that emotion recognition in real context remains a highly data-centric problem and that our training dataset was quite small (~ 4 hours of content). Therefore, it is provided a proof-of-concept and we expect significant improvement in F1-scores with larger dataset (>10 hours)_
+### Scores on our proprietary dataset and comparison with benchmark model
+|         |     ehcalabres/wav2vec2-lg-xlsr-en-speech-emotion-recognition    |      lajavaness/wav2vec2-lg-xlsr-fr-speech-emotion-recognition |
+|---|---|---|
+|     F1-micro    |     0.41    |     0.56    |
+|     F1-macro    |     0.31    |     0.45    |
+|         |     **F1-score by class**    |  |
+|     Pleased    |     0.07    |     0.35    |
+|     Relaxed    |     0.18    |     0.32    |
+|     Neutral    |     0.65    |     0.72    |
+|     Sad    |     0.21    |     0.27    |
+|     Tension    |     0.43    |     0.56    |
+### Scores on RAVDESS dataset
+| **Class** | **F1-score** | **Support** |
+|---|---|---|
+| Pleased | 0.00 | 192 |
+| Relaxed | 0.43 | 192 |
+| Neutral | 0.33 | 96 |
+| Sad | 0.17 | 192 |
+| Tension | 0.76 | 192 |
+## Citation
+```latex
+@article{baevski2020wav2vec,
+  title={wav2vec 2.0: A framework for self-supervised learning of speech representations},
+  author={Baevski, Alexei and Zhou, Yuhao and Mohamed, Abdelrahman and Auli, Michael},
+  journal={Advances in neural information processing systems},
+  volume={33},
+  pages={12449--12460},
+  year={2020}
+}
+@article{sintes2023multi,
+  title={Multi-task French speech analysis with deep learning Emotion recognition and speaker diarization models for end-to-end conversational analysis tool},
+  author={Sintes, Jules},
+  year={2023}
+}
+```