Upload README.md

README.md

@@ -1,60 +1,100 @@
----
-license: mit
-title: Construction_Snag_Tool_Llama_3.2_Vision
-sdk: gradio
-emoji: ⚡
-colorFrom: blue
-colorTo: green
-short_description: ' AI tool designed to enhance workplace safety and compliance'
-sdk_version: 5.1.0
----
-## Construction Site Safety Analyzer
+# Construction Site Snag Detector
+
+## Overview
+
+The Construction Site Snag Detector is a powerful tool built using Python, Gradio, and the Groq platform. It leverages AI to automatically detect defects, unfinished work, and quality issues in construction site images and videos. This solution aims to enhance quality control and project management by providing real-time insights and expert analysis.
+
+## Features
+
+- **Multi-file Support**: Upload multiple images and videos for batch processing.
+- **Real-time Analysis**: Get immediate results for uploaded files without waiting for long processing times.
+- **Expert Insights**: Detailed reports generated by an AI assistant specializing in construction site snag detection.
+- **Interactive Chat**: Engage in real-time discussions with the AI assistant to clarify findings and ask follow-up questions.
+- **Customizable Reports**: Download comprehensive reports for record-keeping and future reference.
+
+## Getting Started
 
-**Description:**  
-The Construction Site Safety Analyzer is a powerful tool designed to enhance workplace safety and compliance through advanced image and video analysis. Utilizing cutting-edge technologies like Llama 3.2 90B Vision and expert chat assistance, this application helps identify potential hazards, ensure adherence to safety standards, and recommend actionable steps.
+### Prerequisites
 
-### Features
+Before you begin, ensure you have the following installed:
 
-1. **Multi-file Upload**: Supports uploading multiple construction site images and videos simultaneously.
-2. **Real-time Analysis**: Instantly analyzes each uploaded file to detect safety issues, categorize them, and provide detailed descriptions.
-3. **Expert Chat Assistance**: Engages in real-time conversations to answer specific safety-related questions and provide additional insights.
-4. **Summary Reports**: Generates comprehensive reports summarizing all analyzed files and chat interactions.
-5. **User-friendly Interface**: Designed with ease of use in mind, featuring a clean and intuitive design.
+- Python 3.8 or higher
+- Required Python packages (`requirements.txt` provided below)
 
 ### Installation
 
-To run the Construction Site Safety Analyzer, you need to have Python installed on your system. Follow these steps to install the required dependencies:
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/your-repo/construction-site-snag-detector.git
+   cd construction-site-snag-detector
+   ```
+
+2. Install dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+3. Set the `GROQ_API_KEY` environment variable:
+   ```bash
+   export GROQ_API_KEY=your_groq_api_key_here
+   ```
+
+### Running the Application
+
+To start the application, simply run the main script:
 
 ```bash
-pip install gradio opencv-python-headless pillow numpy groq-sdk
+python app.py
 ```
 
-Additionally, ensure you have a valid `GROQ_API_KEY` set in your environment variables. This key is necessary for interacting with the Groq API.
+This will launch a Gradio web interface where you can interact with the Construction Site Snag Detector.
 
-### Usage
+## Usage
 
-1. **Launch the Application**: Run the script to start the Gradio interface.
-   ```bash
-   python your_script_name.py
-   ```
-   
-2. **Upload Files**: Navigate to the web interface and upload one or more construction site images or videos.
-3. **Initiate Analysis**: Click the "🔍 Analyze Safety Hazards" button to start the analysis.
-4. **View Results**: The safety analysis results will be displayed in the chat interface, along with any expert chat responses.
-5. **Download Reports**: After completing your analysis, click the "📥 Download Report" button to save a summary report of all interactions.
+1. **Upload Files**:
+   - Go to the "Upload Files" section and select one or more images or videos of your construction site.
+
+2. **Detect Snags**:
+   - Click the "Detect Snags" button to initiate the analysis.
+
+3. **View Results**:
+   - The analysis results will be displayed in the chat area. Each file's results will be shown separately.
+
+4. **Engage with the AI Assistant**:
+   - Ask questions about the detected snags or request additional information directly within the chat interface.
+
+5. **Download Report**:
+   - Once you're satisfied with the analysis, click the "Download Report" button to save a comprehensive report for your records.
+
+## Technical Details
+
+### Architecture
+
+- **Frontend**: Built using Gradio for a user-friendly interface.
+- **Backend**: Utilizes Python for file handling, image processing, and AI analysis.
+- **AI Integration**: Leverages the Groq platform for AI inference, enabling real-time analysis.
+
+### Dependencies
+
+The project relies on several libraries, including:
 
-### Customization
+- `gradio`: For creating the interactive web interface.
+- `PIL`, `opencv-python`, `numpy`: For image processing.
+- `base64`: For encoding images.
+- `logging`: For logging errors and debugging information.
+- `tempfile`: For generating temporary files.
+- `groq`: For interacting with the Groq platform.
 
-The application includes custom CSS for enhanced styling. You can modify the `custom_css` variable to customize the appearance according to your preferences.
+These dependencies are managed via `requirements.txt`.
 
-### Error Handling
+## Contributing
 
-The application includes robust error handling mechanisms to log and display errors encountered during file analysis, chat sessions, and report generation. Detailed logs can be found in the application's output console.
+Contributions are welcome! Feel free to submit pull requests, bug reports, or feature suggestions.
 
-### Contact
+## License
 
-This Tool is developed by CA Pradeep Gujaran. For further support or inquiries, please contact us at pradeepb@icai.org or through Linkedin https://www.linkedin.com/in/pradeep-gujaran-botguy/
+This project is licensed under the MIT License. See the `LICENSE` file for details.
 
 ---
 
-This README provides a comprehensive overview of the Construction Site Safety Analyzer, its features, installation instructions, usage guide, customization options, and error handling mechanisms.
+**Note:** Ensure you have the necessary permissions and comply with all relevant laws and regulations when using this tool, especially concerning data privacy and security.