britbrat0 commited on
Commit
0f963b4
·
verified ·
1 Parent(s): dac4438

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +12 -49
README.md CHANGED
@@ -1,54 +1,17 @@
1
- # Persona Feedback Simulator — Hugging Face Space (Streamlit)
2
 
3
- This is a Streamlit app that simulates multi-persona feedback for product features.
4
- It supports:
5
- - Persona selection and creation
6
- - Uploading a `personas.json` file
7
- - Generating conversation responses via OpenAI
8
- - Generating a feedback report
9
- - Persona sentiment heatmap
10
 
11
- ---
12
 
13
- ## How to deploy on Hugging Face Spaces
 
14
 
15
- 1. Create a new Space at https://huggingface.co/spaces → **Create new Space**
16
- - SDK: **Streamlit**
17
- - Visibility: Public or Private
18
 
19
- 2. Push these files to the Space repository:
20
- - `app.py`, `utils.py`, `ai_helpers.py`, `config.py`, `requirements.txt`, `README.md`
21
-
22
- 3. Add your OpenAI API key in the Space settings:
23
- - Go to **Settings → Variables** and add:
24
- - `OPENAI_API_KEY` = `sk-...`
25
-
26
- The app will also accept the key typed into the sidebar.
27
-
28
- 4. Wait for the build to complete. The Space will provide a public URL.
29
-
30
- ---
31
-
32
- ## Notes & recommendations
33
-
34
- - **Secrets**: DO NOT commit your API key. Use the Space `Settings → Variables` to store `OPENAI_API_KEY` securely.
35
- - **Persistence**: `personas.json` is saved to the workspace. For production durability consider backing up to S3 or another persistent store.
36
- - **Monitoring**: If you need error tracking add Sentry and metrics (Prometheus/Grafana). Those require additional dependencies and config.
37
- - **OpenAI usage**: Take care to monitor costs and rate limits for your chosen model.
38
-
39
- ---
40
-
41
- ## Troubleshooting
42
-
43
- - If conversation generation fails, verify:
44
- - `OPENAI_API_KEY` is set (in Space variables or entered in sidebar).
45
- - The selected model is available to your account.
46
- - If saving personas fails on Spaces, confirm the runtime has write access (Spaces usually allow writing to repo workspace).
47
- - If you run into dependency errors, update `requirements.txt` and push again.
48
-
49
- ---
50
-
51
- ## Next steps (optional)
52
- - Add Sentry for error tracking.
53
- - Add automated backup to S3 (via GitHub Actions or cron job inside a container).
54
- - Add authentication (Auth0) for access control.
 
1
+ # Persona Simulation App
2
 
3
+ This is an interactive Streamlit application that generates simulated
4
+ conversations using configurable personas. It supports uploading files,
5
+ generating persona sentiment heatmaps, and visual analytics.
 
 
 
 
6
 
7
+ ## 🚀 How to Run
8
 
9
+ The app is designed to run automatically on Hugging Face Spaces
10
+ using the **Streamlit** SDK.
11
 
12
+ No additional configuration is required.
 
 
13
 
14
+ ### Running locally
15
+ ```bash
16
+ pip install -r requirements.txt
17
+ streamlit run app.py