DataMiner

A Data Mining application that lets you explore and visualize student bios and certifications through two AI-powered assistants: TextMiner and GraphMiner for using Streamlit for UI.

Report Bug . Request Feature

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License
• Authors

About The Project

This tool allows users to:

• 💬 Chat with the TextMiner to semantically search student bios using NLP.
• 📊 Chat with the GraphMiner to generate interactive graphs of relationships based on either student names or certifications.

It's designed for educators, administrators, and data explorers who want to interactively analyze educational data.

Built With

This tech stack powers the dynamic chat interface and graph-based exploration in the project. Streamlit and st-chat provide an intuitive chat UI, while Pandas and NetworkX handle the data and visualization logic.

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

• Python 3.8+
• Poetry (recommended for managing dependencies)

Installation

1. Clone the repo

   git clone https://github.com/Yousinator/DataMiner
   cd DataMiner

2. Install Poetry (if you haven’t)

   curl -sSL https://install.python-poetry.org | python3 -
   

3. Install Dependencies

   poetry install
   

4. Activate the Virtual Environment

   poetry shell
   

5. Run the App

   poetry run streamlit run main.py
   

Usage

• Launch the app using poetry run streamlit run main.py.
• Use the sidebar to switch between TextMiner Chat and GraphMiner Chat.
• Ask questions about student bios or generate graphs by entering a name or certificate.
• Chat history clears when switching pages for a clean user experience.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

Authors

• Yousinator - Yousinator

Notes:

1. About the Project: Elaborate on the purpose, features, and functionalities of your project.
2. Built With: List all significant technologies and frameworks used in the project.
3. Getting Started: Provide detailed instructions on setting up the project locally. Adjust paths and commands to match your project's structure.
4. Usage: Describe how to use the application, including any important commands.
5. Contributing: Encourage other developers to contribute to your project.
6. License: Specify the license under which the project is released.
7. Authors: Credit yourself and any other contributors.
8. Acknowledgements: Acknowledge any individual, institution, or resource that helped you in your project.

Feel free to modify and expand each section to suit your project’s specifics.

Made with ❤️ by Yousinator