Hugging Face's logo

RummyAx
/
Mood-Parser

Model card Files
xet
 Community
1
Mood-Parser
File size: 2,886 Bytes
184da28
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
---

license: mit
---

Here’s the revised README for the **Mood Parser** project on Hugging Face, using the correct repo name `RummyAx/Mood-Parser`:

```markdown
# Mood Parser AI: Moodly

**Moodly** is an AI-powered Mood Parser that detects emotions in text using a fine-tuned transformer-based model, such as BERT or RoBERTa. Deployed on Hugging Face, it offers real-time mood analysis and emotion classification across multiple languages.

## Demo

You can try **Moodly** directly on Hugging Face:

[Try Moodly](https://huggingface.co/spaces/RummyAx/Mood-Parser)

## How it Works

Moodly detects a variety of emotions from text input. The model is trained on sentiment and emotion classification tasks to provide accurate results. It supports multiple languages for global usage.

### Supported Emotions

- Happiness
- Sadness
- Anger
- Fear
- Surprise
- Disgust

## Example

### Input:
```text
I am feeling really happy today!
```

### Output:
```json
{
  "emotion": "happiness",
  "confidence": 0.97
}
```

## API Usage

You can integrate the model into your applications using Hugging Face's API.

### API Endpoint

- **URL**: `https://api-inference.huggingface.co/models/RummyAx/Mood-Parser`
- **Method**: POST
- **Body**: Send a POST request with the input text.

### Example API Request:

```bash
curl -X POST "https://api-inference.huggingface.co/models/RummyAx/Mood-Parser" \
  -H "Authorization: Bearer YOUR_HUGGINGFACE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"inputs": "I am feeling very sad!"}'
```

### Example API Response:

```json
{
  "emotion": "sadness",
  "confidence": 0.95
}
```

## Installation (Local)

To run **Moodly** locally, follow these steps:

1. Clone the repository:

   ```bash
   git clone https://github.com/RummyAx/Mood-Parser.git
   ```

2. Install required libraries:

   ```bash
   pip install -r requirements.txt
   ```

3. Run the model:

   ```bash
   python app.py
   ```

This will allow you to use the model on your local machine.

## Contributing

We welcome contributions to this project! To contribute:

1. Fork the repository
2. Create a new branch (`git checkout -b feature-branch`)
3. Commit your changes (`git commit -am 'Add new feature'`)
4. Push to the branch (`git push origin feature-branch`)
5. Create a Pull Request

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

- Hugging Face for providing the platform and hosting the model.
- The authors of BERT and RoBERTa for their powerful transformer models.
- The open-source community for their contributions to NLP.
```

This updated README reflects the correct repository name `RummyAx/Mood-Parser` and includes links and API usage instructions for your Hugging Face project. Make sure to replace the `YOUR_HUGGINGFACE_API_KEY` placeholder with your actual Hugging Face API key.