OliverPerrin commited on
Commit
7317b04
Β·
1 Parent(s): c51e8ce

Fix app_file path to scripts/demo_gradio.py

Browse files
Files changed (1) hide show
  1. README.md +59 -6
README.md CHANGED
@@ -1,14 +1,67 @@
1
  ---
2
  title: LexiMind
3
- emoji: πŸ“Š
4
- colorFrom: pink
5
- colorTo: gray
6
  sdk: gradio
7
  sdk_version: 5.49.1
8
- app_file: app.py
9
  pinned: false
10
  license: mit
11
- short_description: Multi-Task Transformer for Document Analysis
12
  ---
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: LexiMind
3
+ emoji: 🧠
4
+ colorFrom: blue
5
+ colorTo: purple
6
  sdk: gradio
7
  sdk_version: 5.49.1
8
+ app_file: scripts/demo_gradio.py
9
  pinned: false
10
  license: mit
11
+ short_description: Multi-task transformer for document understanding
12
  ---
13
 
14
+ # LexiMind
15
+
16
+ LexiMind is a multitask transformer that performs document summarization, multi-label emotion detection, and topic classification in a single Gradio experience. The project packages the training code, inference pipeline, and visual analytics needed to explore model behavior.
17
+
18
+ ## Run The Demo Locally
19
+
20
+ ```bash
21
+ pip install -r requirements.txt
22
+ python scripts/demo_gradio.py
23
+ ```
24
+
25
+ The Gradio space expects the following assets to be available at runtime:
26
+
27
+ - `checkpoints/best.pt` – multitask model weights
28
+ - `artifacts/hf_tokenizer/` – tokenizer files (or adjust the `tokenizer_dir` argument)
29
+ - `data/labels.json` – label metadata for emotion and topic heads
30
+
31
+ ## Features
32
+
33
+ - πŸ“ **Text Summarization** with adjustable compression
34
+ - 😊 **Emotion Detection** with visualization
35
+ - 🏷️ **Topic Prediction** with confidence scores
36
+ - πŸ”₯ **Attention Heatmap** visualization
37
+
38
+ ## Project Structure
39
+
40
+ ```
41
+ .
42
+ β”œβ”€β”€ configs/ # YAML presets for data, model, and training runs
43
+ β”œβ”€β”€ scripts/
44
+ β”‚ β”œβ”€β”€ demo_gradio.py # Hugging Face Space entry point
45
+ β”‚ β”œβ”€β”€ train.py # Training CLI
46
+ β”‚ └── inference.py # Batch inference utility
47
+ β”œβ”€β”€ src/
48
+ β”‚ β”œβ”€β”€ data/ # Tokenization, datasets, and dataloaders
49
+ β”‚ β”œβ”€β”€ inference/ # Pipeline orchestration for multitask heads
50
+ β”‚ β”œβ”€β”€ models/ # Encoder/decoder/backbone modules
51
+ β”‚ β”œβ”€β”€ training/ # Trainer, callbacks, metrics, and losses
52
+ β”‚ └── visualization/ # Attention, embeddings, and metric plots
53
+ β”œβ”€β”€ tests/ # Pytest suites for API, data, inference, models, training
54
+ β”œβ”€β”€ artifacts/ # Saved tokenizer assets
55
+ β”œβ”€β”€ checkpoints/ # Pretrained multitask checkpoints
56
+ └── data/ # Raw, processed, and cached datasets
57
+ ```
58
+
59
+ ## Usage
60
+
61
+ Enter your text, adjust the compression slider, and click "Analyze" to see the results!
62
+
63
+ ## Repository
64
+
65
+ GitHub: [OliverPerrin/LexiMind](https://github.com/OliverPerrin/LexiMind)
66
+
67
+ HuggingFace: [OliverPerrin/LexiMind](https://huggingface.co/spaces/OliverPerrin/LexiMind)