fedec65 commited on
Commit
d49a2af
Β·
verified Β·
1 Parent(s): 3f6db1d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +69 -1
README.md CHANGED
@@ -11,4 +11,72 @@ license: unknown
11
  short_description: 'DashboardsNarrator '
12
  ---
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  short_description: 'DashboardsNarrator '
12
  ---
13
 
14
+ # Dashboard Narrator πŸ“Š
15
+
16
+ **Unlock the hidden stories in your dashboards with AI-powered analysis**
17
+
18
+ Dashboard Narrator leverages Claude AI to convert complex data visualizations into clear, actionable insights. By analyzing your dashboard PDFs, it generates comprehensive reports that reveal patterns, trends, and recommendations you might have missed.
19
+
20
+ ## 🌟 Features
21
+
22
+ - **Multi-Dashboard Analysis**: Upload multiple PDF dashboards for individual and comparative analysis
23
+ - **Intelligent Sectioning**: Automatically divides dashboards into vertical sections for detailed examination
24
+ - **Multilingual Support**: Generate reports in 5 languages (English, Italian, French, Spanish, German)
25
+ - **Comprehensive Insights**: Extracts meaningful patterns, trends, anomalies, and actionable recommendations
26
+ - **PDF & Markdown Reports**: Download nicely formatted reports ready for sharing
27
+
28
+ ## πŸš€ Getting Started
29
+
30
+ 1. **Get an API Key**: You'll need a Claude API key from Anthropic
31
+ 2. **Upload Dashboards**: Select one or more dashboard PDFs for analysis
32
+ 3. **Choose Settings**: Select your preferred language and number of vertical sections
33
+ 4. **Add Analysis Goal** (optional): Provide context for more targeted insights
34
+ 5. **Generate Report**: Click "Analyze Dashboards" and let the AI do its work!
35
+
36
+ ## πŸ’‘ Use Cases
37
+
38
+ - **Business Intelligence**: Turn raw data into actionable business insights
39
+ - **Performance Monitoring**: Identify trends and anomalies across time periods
40
+ - **Competitive Analysis**: Compare metrics across multiple dashboards
41
+ - **Executive Summaries**: Create professional-ready reports for management
42
+ - **Data Exploration**: Discover hidden patterns in complex visualizations
43
+
44
+ ## πŸ”§ Advanced Settings
45
+
46
+ - **Vertical Sections**: Adjust the number of sections (2-10) based on your dashboard's complexity
47
+ - **Analysis Goal**: Guide the AI by specifying what you're looking for in the data
48
+ - **Language Selection**: Choose from 5 supported languages for your report
49
+
50
+ ## πŸ“‹ Output Files
51
+
52
+ For each analysis session, you'll receive:
53
+ - Individual Markdown reports for each dashboard
54
+ - Individual PDF reports with clean formatting
55
+ - A comparative analysis (when multiple dashboards are uploaded)
56
+ - All files are timestamped for easy organization
57
+
58
+ ## πŸ› οΈ Technical Details
59
+
60
+ Dashboard Narrator uses:
61
+ - Claude 3.7 Sonnet for AI analysis
62
+ - PyPDF2 and pdf2image for PDF processing
63
+ - Gradio for the user interface
64
+ - Markdown and weasyprint for report generation
65
+
66
+ ## πŸ“ License
67
+
68
+ This project is available under [License Type] License - see the LICENSE file for details.
69
+
70
+ ## πŸ‘₯ Contributors
71
+
72
+ - [fedec65/sandsiv]
73
+ - Powered by sandsiv+
74
+
75
+ ## πŸ™ Acknowledgements
76
+
77
+ - Anthropic for Claude AI
78
+ - Hugging Face for hosting the space
79
+
80
+ ---
81
+
82
+ *Note: You will need your own Anthropic API key to use this application. The key is never stored and is only used for your current session.*