Update README.md
Browse files
README.md
CHANGED
|
@@ -11,3 +11,51 @@ license: mit
|
|
| 11 |
---
|
| 12 |
|
| 13 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 11 |
---
|
| 12 |
|
| 13 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
| 14 |
+
|
| 15 |
+
# CSV Chatbot
|
| 16 |
+
|
| 17 |
+
An interactive chatbot that analyzes CSV files using natural language queries. Upload your CSV data and ask questions in plain English to get insights, visualizations, and reports.
|
| 18 |
+
|
| 19 |
+
## Features
|
| 20 |
+
|
| 21 |
+
- **Natural Language Queries**: Ask questions about your CSV data in plain English
|
| 22 |
+
- **Multiple File Support**: Upload and analyze multiple CSV files at once
|
| 23 |
+
- **Automatic Visualization**: Generate charts and graphs based on your data
|
| 24 |
+
- **Report Generation**: Export conversation and analysis results as HTML reports
|
| 25 |
+
- **Smart CSV Handling**: Automatic detection of encoding, delimiters, and data types
|
| 26 |
+
|
| 27 |
+
## How to Use
|
| 28 |
+
|
| 29 |
+
1. **Upload CSV Files**: Click the upload button and select one or more CSV files
|
| 30 |
+
2. **Process Files**: Click "Process Files" to index your data
|
| 31 |
+
3. **Ask Questions**: Type your question in the text box and click "Submit"
|
| 32 |
+
4. **View Results**: See text responses, tables, and visualizations in the chat
|
| 33 |
+
5. **Export Results**: Click "Export Conversation" to create a shareable report
|
| 34 |
+
|
| 35 |
+
## Example Queries
|
| 36 |
+
|
| 37 |
+
- "What's the average value in column X?"
|
| 38 |
+
- "Show me a histogram of the distribution in column Y"
|
| 39 |
+
- "Is there a correlation between column A and column B?"
|
| 40 |
+
- "What are the top 5 values in column Z?"
|
| 41 |
+
- "Compare the average values grouped by category"
|
| 42 |
+
|
| 43 |
+
## Technical Details
|
| 44 |
+
|
| 45 |
+
This application uses:
|
| 46 |
+
- Phi-3-mini language model for natural language understanding
|
| 47 |
+
- LlamaIndex for data indexing and retrieval
|
| 48 |
+
- Pandas for data analysis
|
| 49 |
+
- Matplotlib for visualization
|
| 50 |
+
- Gradio for the web interface
|
| 51 |
+
|
| 52 |
+
## Limitations
|
| 53 |
+
|
| 54 |
+
- Large CSV files (>100MB) may take longer to process
|
| 55 |
+
- Complex statistical analyses may require specific phrasing
|
| 56 |
+
- Currently limited to tabular data in CSV format
|
| 57 |
+
|
| 58 |
+
## Feedback and Contributions
|
| 59 |
+
|
| 60 |
+
This is an open-source project. Feedback and contributions are welcome!
|
| 61 |
+
|