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