Welcome to the PlotSenseAI Hackathon Demo Projects repository! This collection contains three comprehensive demo projects designed to help participants learn and explore the capabilities of PlotSenseAI for data visualization, machine learning explainability, and anomaly detection.
These demo projects serve as:
- Learning Resources for hackathon participants
- Reference Implementations showcasing PlotSenseAI best practices
- Starter Templates for building your own AI-powered data visualization applications
- Open Source Examples for the community to contribute to and extend
PlotSenseAI-Hackathon-Demo-Projects/
βββ project_one/ # ML Explainability Demo
β βββ ml_explainability_demo.ipynb
β βββ README.md
βββ project_two/ # Anomaly Detection Plugin
β βββ plotsense_anomaly/
β βββ examples/
β βββ tests/
β βββ README.md
βββ project_three/ # Data Storytelling Web App
β βββ app.py
β βββ data/
β βββ README.md
βββ docs/ # Documentation
β βββ CONTRIBUTING.md
β βββ SETUP.md
β βββ TUTORIALS.md
βββ README.md # This file
Focus: Machine Learning model interpretation and visualization
What you'll learn:
- Loading and preprocessing real-world datasets (UCI Breast Cancer Recurrence)
- Training machine learning models (Random Forest)
- Using PlotSenseAI for automated visualization recommendations
- Generating AI-driven explanations for model results
- Advanced explainability techniques (partial dependence, counterfactuals)
Tech Stack: Jupyter Notebook, scikit-learn, pandas, PlotSenseAI
π View Project One Documentation
Focus: Extending PlotSenseAI with custom functionality
What you'll learn:
- Building plugins for PlotSenseAI
- Implementing Z-score based anomaly detection
- Creating custom visualization components
- Writing unit tests for data science code
- Package structure and distribution
Tech Stack: Python, NumPy, pandas, pytest, PlotSenseAI
π View Project Two Documentation
Focus: Building production-ready web applications
What you'll learn:
- Creating interactive web applications with Streamlit
- Integrating PlotSenseAI with web frameworks
- Building user-friendly data exploration interfaces
- Handling API keys and environment configuration
- Real-time data filtering and visualization
Tech Stack: Streamlit, pandas, PlotSenseAI, Groq API
π View Project Three Documentation
- Python 3.8 or higher
- pip package manager
- Git
- Clone the repository:
git clone https://github.com/HavilahAcademy/PlotSenseAI-Hackathon-Demo-Projects.git
cd PlotSenseAI-Hackathon-Demo-Projects- Create a virtual environment (recommended):
python -m venv plotsense-env
source plotsense-env/bin/activate # On Windows: plotsense-env\Scripts\activate- Install PlotSenseAI:
pip install plotsense- Choose your project and follow its specific setup guide:
- Setup Guide - Detailed installation and configuration instructions
- Tutorials - Step-by-step tutorials for each project
- Contributing Guide - How to contribute to this project
- API Reference - PlotSenseAI official documentation
We recommend exploring the projects in this order:
- Start with Project One to understand PlotSenseAI basics and ML explainability
- Move to Project Three to see how PlotSenseAI integrates with web applications
- Explore Project Two to learn about extending PlotSenseAI with custom plugins
| Technology | Purpose | Projects |
|---|---|---|
| PlotSenseAI | AI-powered data visualization | All projects |
| Jupyter Notebook | Interactive data analysis | Project One |
| Streamlit | Web application framework | Project Three |
| scikit-learn | Machine learning | Project One |
| pandas | Data manipulation | All projects |
| pytest | Unit testing | Project Two |
| Groq API | AI explanations | Project Three |
We welcome contributions from the community! Whether you're:
- π Fixing bugs
- β¨ Adding new features
- π Improving documentation
- π§ͺ Adding tests
- π‘ Suggesting improvements
Please read our Contributing Guide to get started.
- Use these projects as starting points for your hackathon submissions
- Feel free to modify, extend, or combine elements from different projects
- Focus on creativity and innovation while leveraging PlotSenseAI's capabilities
- Document your modifications and new features
- These projects provide comprehensive examples for workshops and tutorials
- Each project includes varying complexity levels suitable for different skill levels
- Use the documentation to guide participants through the learning process
This project is licensed under the MIT License - see the LICENSE file for details.
Need help? We've got you covered:
- π Documentation: Check the individual project READMEs and documentation
- π Issues: Report bugs or request features in our Issues
- π¬ Discussions: Join the conversation in our Discussions
- π§ Email: Contact us at support@havilahacademy.org
- Havilah Academy Team for developing these comprehensive demo projects
- PlotSenseAI (plotsenseai.org) for the amazing visualization platform
- UCI Machine Learning Repository for providing quality datasets
- The open-source community for inspiration and tools
- All hackathon participants and contributors
Happy Hacking! π
Built with β€οΈ by the Havilah Academy Team for PlotSenseAI