Spaces:
Sleeping
Sleeping
File size: 3,152 Bytes
f3007f9 |
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 119 120 121 |
---
license: apache-2.0
title: GoEmotions Dashboard
sdk: streamlit
sdk_version: "1.22.0"
app_file: app.py
---
# GoEmotions Dashboard - Analyzing Emotions in Text
This is a Python script that uses Streamlit, Plotly, and the Hugging Face Inference API to create a web-based dashboard for analyzing emotions in text. Finally this dashboard is deployed on Hugging Face Spaces using GitHub Actions.
## Pre-requisites:
- Python 3.7 or higher
## Project Structure:
```dir
GoEmotions/
├── app.py
├── requirements.txt
├── .env
├── README.md
├── assets/
└── .github/workflows
```
## Setup
`Step 1` - Clone this repository to your local machine using the following command, or open the repository in GitHub Codespaces.
```bash
git clone https://github.com/devansh-srivastav/GoEmotions.git
```
`Step 2` - Navigate to the root directory of the project.
```bash
cd GoEmotions
```
`Step 3` - Create and activate a new python virtual environment: (This step can be skipped if working on GitHub Codespaces!)
```bash
python -m venv venv
```
For Windows
```bash
venv\Scripts\activate
```
For Linux/MacOS
```bash
source venv/bin/activate
```
`Step 4` - Install the required packages using pip: (This step can be skipped if working on GitHub Codespaces as it automatically installs the requirements!)
```bash
pip install -r requirements.txt
```
`Step 5`- Create a free account on the [Hugging Face website](https://huggingface.co/) and generate an API key (read).
`Step 6`
- Create a `.env` file in the root directory of the project and add your
- Hugging Face API key like this: `HF_API_KEY=<your_api_key_here>`
`Step 7` - Run the Streamlit app.
```bash
streamlit run app.py
```
or
```bash
python -m streamlit run app.py
```
- If you want to run this application on GitHub Codespaces, you will need to add the following flags to the `streamlit run` command:
```bash
python -m streamlit run app.py --server.enableCORS false --server.enableXsrfProtection false
```
## Deployment to Spaces (CI/CD)
`Step 1`
Commit your code and push it to your GitHub repository
`Step 2`
Create a new Space on Hugging Face, add it as an additional remote to git and force push your code on Spaces:
```bash
git remote add space https://huggingface.co/spaces/HF_USERNAME/SPACE_NAME
```
```bash
git push --force space main
```
`Step 3`
In the main.yml, add your Hugging Face username and Space name to the variables 'HF_username' and 'HF_space_name'
`Step 4`
Create a new API key on Hugging Face (write) and add it as a secret to your GitHub Repository naming it as 'HF_TOKEN'.
`Step 5`
Trigger the CI/CD pipeline by a push or a pull request to your main branch.
## Usage:
- A web-based dashboard will open in your default browser.
- Type or paste a text input in the text box provided.
- The dashboard will visualise the detected emotions in a set of gauges, with each gauge representing the intensity of a specific emotion category. The gauge colors are based on a predefined color map for each emotion category.
- Moreover, the dashboard will display the results from Hate Speech Analysis and Sexism Detection models.
|