Marek4321 commited on
Commit
a481429
Β·
verified Β·
1 Parent(s): 7da60fb

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +140 -8
README.md CHANGED
@@ -1,14 +1,146 @@
1
  ---
2
  title: QualiLab
3
- emoji: 🌍
4
- colorFrom: indigo
5
- colorTo: gray
6
- sdk: gradio
7
- sdk_version: 5.35.0
8
  app_file: app.py
9
  pinned: false
10
- license: apache-2.0
11
- short_description: Advanced qualitative research laboratory
12
  ---
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: QualiLab
3
+ emoji: πŸ§ͺ
4
+ colorFrom: green
5
+ colorTo: blue
6
+ sdk: streamlit
7
+ sdk_version: 1.31.0
8
  app_file: app.py
9
  pinned: false
10
+ license: other
11
+ short_description: AI-powered qualitative research transcription and analysis
12
  ---
13
 
14
+ # πŸ§ͺ QualiLab
15
+ ## Advanced Qualitative Research Laboratory
16
+
17
+ **QualiLab** is a comprehensive AI-powered platform for qualitative researchers, designed to streamline the entire research workflow from audio transcription to intelligent report generation.
18
+
19
+ ### 🎯 **What it does**
20
+
21
+ QualiLab automates the most time-consuming aspects of qualitative research:
22
+
23
+ 1. **πŸŽ™οΈ Smart Audio Processing**
24
+ - Automatic transcription using OpenAI Whisper
25
+ - Supports multiple formats: MP3, WAV, MP4, M4A, AAC
26
+ - Intelligent file splitting for large interviews (>25MB)
27
+ - Handles both Focus Group Interviews (FGI) and In-Depth Interviews (IDI)
28
+
29
+ 2. **πŸ€– Intelligent Report Generation**
30
+ - AI analyzes all transcriptions collectively
31
+ - Generates comprehensive research reports
32
+ - Self-prompting system ensures detailed, thorough analysis
33
+ - Automatically detects interview type and adapts report structure
34
+
35
+ 3. **πŸ“Š Professional Output**
36
+ - Executive summaries with key insights
37
+ - Structured analysis with participant quotes
38
+ - Business recommendations and next steps
39
+ - Multiple export formats (TXT, with more coming soon)
40
+
41
+ ### πŸš€ **Key Features**
42
+
43
+ - **Multi-file Processing**: Upload and process multiple interviews simultaneously
44
+ - **Large File Support**: Automatically splits files >25MB for processing
45
+ - **Research Brief Integration**: Include study objectives for targeted analysis
46
+ - **Real-time Progress Tracking**: Monitor transcription and report generation
47
+ - **Cost Estimation**: See estimated API costs before processing
48
+ - **Session Management**: Resume interrupted sessions
49
+ - **Professional Reports**: Publication-ready research reports
50
+
51
+ ### πŸ› οΈ **How to Use**
52
+
53
+ 1. **Setup**: Enter your OpenAI API key (requires access to Whisper and GPT-4o-mini)
54
+ 2. **Upload**: Add your interview audio/video files
55
+ 3. **Brief** (Optional): Describe your research objectives and target audience
56
+ 4. **Process**: Click "Start" and let QualiLab handle the rest
57
+ 5. **Analyze**: Review generated transcriptions and comprehensive report
58
+ 6. **Export**: Download your professional research report
59
+
60
+ ### πŸ“‹ **Requirements**
61
+
62
+ - **OpenAI API Key** with access to:
63
+ - Whisper API (for transcription)
64
+ - GPT-4o-mini (for report generation)
65
+ - **Supported File Formats**: MP3, WAV, MP4, M4A, AAC
66
+ - **File Size**: Up to 200MB per file (automatically split if larger)
67
+
68
+ ### πŸ’‘ **Perfect for**
69
+
70
+ - **Market Researchers** conducting focus groups and interviews
71
+ - **UX Researchers** analyzing user feedback sessions
72
+ - **Academic Researchers** processing qualitative data
73
+ - **Product Managers** analyzing customer interviews
74
+ - **Consultants** creating client reports from interviews
75
+
76
+ ### πŸ”¬ **Technology Stack**
77
+
78
+ - **Frontend**: Streamlit
79
+ - **Transcription**: OpenAI Whisper API
80
+ - **Analysis**: GPT-4o-mini with custom prompting
81
+ - **Audio Processing**: Pydub, Librosa
82
+ - **Deployment**: HuggingFace Spaces
83
+
84
+ ### πŸ“Š **Sample Use Cases**
85
+
86
+ **Focus Group Interview (FGI)**
87
+ - Analyze group dynamics and consensus opinions
88
+ - Identify different participant segments
89
+ - Extract key themes and contradictions
90
+ - Generate actionable business insights
91
+
92
+ **In-Depth Interview (IDI)**
93
+ - Deep dive into individual perspectives
94
+ - Uncover personal motivations and barriers
95
+ - Detailed journey mapping
96
+ - Personalized recommendations
97
+
98
+ ### ⚑ **Performance**
99
+
100
+ - **Transcription Speed**: ~10x faster than real-time
101
+ - **Report Generation**: 5-10 minutes for comprehensive analysis
102
+ - **Cost Efficient**: Typically $0.10-$0.50 per hour of audio
103
+ - **Accuracy**: Professional-grade transcription and analysis
104
+
105
+ ### πŸ”’ **Privacy & Security**
106
+
107
+ - Your audio files are processed securely through OpenAI APIs
108
+ - No permanent storage of your data
109
+ - API keys are handled securely within your session
110
+ - Temporary files are automatically cleaned up
111
+
112
+ ### πŸŽ“ **Tips for Best Results**
113
+
114
+ 1. **Good Audio Quality**: Clear audio produces better transcriptions
115
+ 2. **Detailed Brief**: More context leads to better analysis
116
+ 3. **File Organization**: Name files descriptively for easier tracking
117
+ 4. **Multiple Interviews**: Better insights when analyzing multiple perspectives together
118
+
119
+ ### πŸ†˜ **Troubleshooting**
120
+
121
+ **Large Files**: Files >200MB should be pre-compressed or split before upload
122
+ **API Errors**: Ensure your OpenAI API key has sufficient credits and access
123
+ **Processing Time**: Large files or multiple interviews may take 10-15 minutes
124
+
125
+ ### 🚧 **Roadmap**
126
+
127
+ - [ ] Support for more export formats (DOCX, PDF)
128
+ - [ ] Advanced analytics dashboards
129
+ - [ ] Multi-language support beyond Polish/English
130
+ - [ ] Integration with survey platforms
131
+ - [ ] Sentiment analysis visualization
132
+ - [ ] Participant persona generation
133
+
134
+ ### πŸ“„ **License**
135
+
136
+ **Copyright (c) 2025 Marek Staniszewski, www.Heuristica.pl. All rights reserved.**
137
+
138
+ This software is proprietary. No part of this software may be reproduced, distributed, or transmitted without explicit written permission from the author.
139
+
140
+ **For commercial licensing inquiries, contact:** [Contact via www.Heuristica.pl](https://www.heuristica.pl)
141
+
142
+ **Academic and Research Use:** This tool is made available for educational and non-commercial research purposes. Users may utilize QualiLab for their research projects but may not redistribute, modify, or commercialize the software.
143
+
144
+ ---
145
+
146
+ **Built with ❀️ for the research community by [Heuristica.pl](https://www.heuristica.pl)** πŸ§ͺ✨