Upload README.md

README.md

@@ -1,100 +1,50 @@
----
-license: mit
-title: Construction Site Safety Analyzer
-sdk: gradio
-emoji: 🏢
-colorFrom: green
-colorTo: blue
-short_description: AI Tool to enhance safety compliance
-sdk_version: 5.1.0
----
-# 🏗️ Construction Site Safety Analyzer
-
-## Overview
-
-The **Construction Site Safety Analyzer** is a powerful tool designed to enhance workplace safety and compliance through AI-powered image and video analysis. Leveraging the capabilities of Llama 3.2 90B Vision and expert chat assistance, this application helps identify safety issues, categorize them, provide detailed descriptions, and suggest steps to resolve them.
-
-## Features
+## Construction Site Safety Analyzer
 
-### 1. Image Analysis
-- **Upload Multiple Images**: Easily upload multiple construction site images for comprehensive analysis.
-- **Automatic Image Resizing**: Ensures that images do not exceed API size limits while maintaining quality.
-- **Safety Hazard Identification**: Identifies potential safety hazards, categorizes them, and provides detailed descriptions.
-- **Resolution Suggestions**: Offers actionable steps to mitigate identified risks.
+**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.
 
-### 2. Video Analysis
-- **Upload Videos**: Upload videos to analyze specific frames for safety hazard identification.
-- **Key Frame Extraction**: Extracts key frames from videos at specified time points (default: start, middle, end).
-- **Detailed Analysis**: Provides detailed analysis for each extracted frame, similar to image analysis.
+### Features
 
-### 3. Expert Chat Assistance
-- **Interactive Chat**: Engage in real-time conversations with an AI assistant specializing in construction site safety.
-- **Question-Based Analysis**: Ask questions about specific safety measures or regulations related to the analyzed hazards.
-- **Comprehensive Insights**: Receive detailed answers based on the initial analysis, enhancing understanding and decision-making.
-
-## Getting Started
-
-### Prerequisites
-- Python 3.8+
-- `pip` (Python package installer)
+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.
 
 ### Installation
-1. Clone the repository:
-   ```bash
-   git clone https://github.com/your-repo/construction-site-safety-analyzer.git
-   cd construction-site-safety-analyzer
-   ```
 
-2. Install dependencies:
-   ```bash
-   pip install -r requirements.txt
-   ```
-
-3. Set up environment variables:
-   ```bash
-   export GROQ_API_KEY="your-groq-api-key"
-   ```
+To run the Construction Site Safety Analyzer, you need to have Python installed on your system. Follow these steps to install the required dependencies:
 
-### Running the Application
-To launch the application, simply run the main script:
 ```bash
-python app.py
+pip install gradio opencv-python-headless pillow numpy groq-sdk
 ```
 
-This will start a local server, and you can access the application via your web browser at `http://localhost:7860`.
-
-## Usage
+Additionally, ensure you have a valid `GROQ_API_KEY` set in your environment variables. This key is necessary for interacting with the Groq API.
 
-1. **Upload Images/Videos**: Navigate to the "Upload Construction Site Images" or "Upload Construction Site Video" sections and select the appropriate files.
-2. **Analyze Safety Hazards**: Click the "🔍 Analyze Safety Hazards" button to initiate the analysis process.
-3. **View Analysis Results**: The safety analysis results will be displayed in the "Safety Analysis Results and Expert Chat" section.
-4. **Chat with the Assistant**: Engage in interactive conversations with the AI assistant to get more insights or ask questions about specific safety measures.
+### Usage
 
-## Requirements
+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.
 
-The application requires the following Python packages:
-- `os`
-- `base64`
-- `gradio`
-- `PIL`
-- `io`
-- `json`
-- `groq`
-- `logging`
-- `cv2`
-- `numpy`
-- `traceback`
+### Customization
 
-These dependencies can be installed using `pip` as shown in the installation instructions.
+The application includes custom CSS for enhanced styling. You can modify the `custom_css` variable to customize the appearance according to your preferences.
 
-## Contributing
+### Error Handling
 
-Contributions are welcome! Feel free to submit pull requests, report bugs, or suggest improvements.
+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.
 
-## License
+### Contact
 
-This project is licensed under the MIT License - see the MIT file for details.
+For further support or inquiries, please contact us at [support@example.com](mailto:[email protected]).
 
 ---
 
-Built with ❤️ by CA Pradeep Gujaran
+This README provides a comprehensive overview of the Construction Site Safety Analyzer, its features, installation instructions, usage guide, customization options, and error handling mechanisms.