Spaces:
Configuration error
Configuration error
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,46 +0,0 @@
|
|
| 1 |
-
# BERTopic Thematic Analysis Agent
|
| 2 |
-
|
| 3 |
-
Gradio app for a Braun & Clarke (2006) six-phase thematic analysis pipeline using BERTopic clustering and LLM-assisted labeling.
|
| 4 |
-
|
| 5 |
-
## Features
|
| 6 |
-
- Upload Scopus CSV and run a guided phase-by-phase analysis.
|
| 7 |
-
- BERTopic discovery with charts (bar, treemap, scatter, heatmap).
|
| 8 |
-
- Review table workflow for approvals, renames, and grouping.
|
| 9 |
-
- PAJAIS taxonomy mapping and narrative export.
|
| 10 |
-
|
| 11 |
-
## Requirements
|
| 12 |
-
- Python 3.11
|
| 13 |
-
- Mistral API key
|
| 14 |
-
|
| 15 |
-
## Setup
|
| 16 |
-
1. Create and activate a virtual environment.
|
| 17 |
-
2. Install dependencies:
|
| 18 |
-
|
| 19 |
-
pip install -r requirements.txt
|
| 20 |
-
|
| 21 |
-
3. Set the Mistral API key in your environment:
|
| 22 |
-
|
| 23 |
-
MISTRAL_API_KEY=your_key_here
|
| 24 |
-
|
| 25 |
-
## Run
|
| 26 |
-
|
| 27 |
-
python app.py
|
| 28 |
-
|
| 29 |
-
Then open the local URL shown in the terminal.
|
| 30 |
-
|
| 31 |
-
## Notes
|
| 32 |
-
- Phase 2 calls the Mistral API to label topics; rate limits may apply.
|
| 33 |
-
- Charts are loaded from charts.json, which is regenerated when Phase 2 runs.
|
| 34 |
-
|
| 35 |
-
## Hugging Face Spaces
|
| 36 |
-
1. Create a new Space (Gradio).
|
| 37 |
-
2. Upload app.py, agent.py, tools.py, requirements.txt.
|
| 38 |
-
3. Add MISTRAL_API_KEY as a Space secret.
|
| 39 |
-
4. Build and run.
|
| 40 |
-
|
| 41 |
-
## Project Structure
|
| 42 |
-
- app.py: Gradio UI and workflow wiring.
|
| 43 |
-
- agent.py: LangGraph ReAct agent configuration.
|
| 44 |
-
- tools.py: Pipeline tools (CSV load, BERTopic, labeling, taxonomy, exports).
|
| 45 |
-
- summaries.json: Run summaries (generated).
|
| 46 |
-
- charts.json: Plotly chart JSON (generated).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|