readme update

README.md

@@ -10,82 +10,93 @@ pinned: false
 app_port: 8501
 short_description: AI Python security scanner using CodeBERT and rules.
 ---
-<<<<<<< HEAD
-# -AI-Code-Security-Scanner-Real-time-Vulnerability-Detection-Remediation
-An advanced AI-powered security tool that detects code vulnerabilities (SQLi, XSS, etc.) using hybrid Rule-Based analysis and CodeBERT Deep Learning models. Features interactive dashboards and real-time fix suggestions.
-=======
-# 🔒 AI Code Security Scanner
+# AI Code Security Scanner: Real-time Vulnerability Detection
 
-<p align="center">
-  <img src="https://img.shields.io/badge/python-3.9+-blue.svg" alt="Python 3.9+">
-  <img src="https://img.shields.io/badge/🤗-Spaces-yellow.svg" alt="Hugging Face Spaces">
-  <img src="https://img.shields.io/badge/Streamlit-1.28+-red.svg" alt="Streamlit">
-  <img src="https://img.shields.io/badge/License-MIT-green.svg" alt="License: MIT">
-</p>
+An advanced security orchestration tool that detects critical vulnerabilities (SQLi, XSS, Command Injection) using a **Hybrid Analysis Engine**: combining static rule-based heuristics with deep learning **CodeBERT** models.
 
-**AI-powered code security scanner that detects vulnerabilities in Python code using rule-based analysis and machine learning.**
+[![Hugging Face Space](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Space-yellow)](https://huggingface.co/spaces/mubi-613/AI-Code-Security-Scanner)
 
----
-
-## 🚀 Live Demo
-Try it now: [Hugging Face Spaces Demo](https://huggingface.co/spaces/your-username/code-security-scanner)
-
-## ✨ Features
-* **🤖 AI-Powered Detection**: Combines rule-based analysis with fine-tuned CodeBERT model.
-* **🔍 Multiple Vulnerability Types**: SQL Injection, XSS, Hardcoded Secrets, Command Injection, etc.
-* **💡 Fix Suggestions**: AI-generated fix recommendations with explanations.
-* **🌐 REST API**: Fully documented FastAPI backend for integration.
-* **📁 Batch Processing**: Analyze multiple files simultaneously.
-* **📊 Interactive Dashboard**: Real-time visualization of security scores.
-* **🐳 Docker Support**: Easy deployment with Docker & Docker Compose.
-* **🔧 CI/CD Pipeline**: Automated testing and deployment.
+> **Live Demo:** [AI Security Scanner on Hugging Face](https://huggingface.co/spaces/mubi-613/AI-Code-Security-Scanner)
 
 ---
 
-## 🏗️ Architecture
-
-
-┌─────────────────┐     ┌─────────────────┐     ┌─────────────────┐
-│  Streamlit UI   │────▶│ FastAPI Backend │────▶│    AI Engine    │
-│   (Frontend)    │     │   (REST API)    │     │    (Rule+ML)    │
-└─────────────────┘     └─────────────────┘     └─────────────────┘
-         │                       │                       │
-         ▼                       ▼                       ▼
-┌─────────────────┐     ┌─────────────────┐     ┌─────────────────┐
-│   User Input    │     │  Request Cache  │     │  Fix Generator  │
-│    & Results    │     │    & Logging    │     │   (AI + Rules)  │
-└─────────────────┘     └─────────────────┘     └─────────────────┘
-
-
-## 📦 Installation
+## Core Engineering Features
+* **Hybrid Detection Engine:** Utilizes **AST (Abstract Syntax Tree)** parsing for rule-based detection and fine-tuned **CodeBERT** (Deep Learning) for semantic vulnerability pattern matching.
+* **Automated Remediation:** Generates context-aware "Fix Suggestions" using AI to provide secure code alternatives for identified risks.
+* **Security Dashboard:** Real-time visualization of security scores and vulnerability distribution across large codebases.
+* **Batch Processing:** Optimized for high-throughput scanning of multiple Python files simultaneously using Python's `multiprocessing` capabilities.
+* **REST API Architecture:** Built with a **FastAPI** backend, allowing for easy integration into existing CI/CD pipelines as a security gate.
 
-### Local Development
-
-```bash
-# 1. Clone repository
-git clone https://github.com/your-username/ai-code-security-scanner.git
-cd ai-code-security-scanner
-
-# 2. Create virtual environment
-python -m venv venv
-# On Windows:
-.\venv\Scripts\activate
-# On Mac/Linux:
-source venv/bin/activate
-
-# 3. Install dependencies
-pip install -r requirements.txt
-
-# 4. Run the application
-streamlit run app.py`
-
-
-##  🐳 Docker Deployment
+---
 
-# Build and run with Docker Compose
-docker-compose up --build
+##  Technical Stack
+* **Deep Learning:** CodeBERT (Transformers), PyTorch
+* **Analysis Engine:** Python AST, Custom Rule-based Heuristics
+* **Backend/Frontend:** FastAPI, Streamlit
+* **Deployment:** Docker, Hugging Face Spaces (Debian Linux)
+
+##  Installation
+
+1. **Clone the repository:**
+   ```bash
+   git clone [https://github.com/mubi0613/AI-Code-Security-Scanner.git](https://github.com/mubi0613/AI-Code-Security-Scanner.git)
+   cd AI-Code-Security-Scanner
+
+2. **Setup environment:**
+   ```bash
+   python -m venv venv
+   # On Windows:
+   .\venv\Scripts\activate
+   # On Mac/Linux:
+   source venv/bin/activate
+
+ 3. **Install dependencies:**
+   ```bash
+   pip install -r requirements.txt
+
+ 4. **Run the application:**
+   ```bash
+   streamlit run app.py`
+
+##  Docker Deployment
+* Build and run with Docker Compose
+* docker-compose up --build
+
+## Access at:
+* - Web UI: http://localhost:8501
+* - API Docs: http://localhost:8000/docs
+
+##  Project Structure
+
+AI-Code-Security-Scanner/
+├── app.py                # Main Streamlit Dashboard & UI Logic
+├── api_backend.py        # FastAPI Server for REST API Access
+├── combined_detector.py   # Hybrid Logic (Rules + CodeBERT Model)
+├── rule_detector.py      # Static Analysis & AST-based Heuristics
+├── fix_generator.py      # AI-powered Remediation Engine
+├── saved_model/          # Fine-tuned CodeBERT Weights & Config
+├── docker-compose.yml    # Container Orchestration for UI & API
+├── requirements.txt      # Project Dependencies
+└── README.md             # Technical Documentation
+
+## Architecture Diagram
+
+```mermaid
+graph LR
+    subgraph "Frontend Layer"
+        A[Streamlit UI] --> B[User Code Input]
+    end
+
+    subgraph "Analysis Engine"
+        B --> C{Hybrid Scanner}
+        C --> D[Static Rule Engine]
+        C --> E[CodeBERT DL Model]
+    end
+
+    subgraph "Remediation & Reporting"
+        D & E --> F[Vulnerability Report]
+        F --> G[AI Fix Generator]
+        G --> H[Final Security Report]
+    end
+```
 
-# Access at:
-# - Web UI: http://localhost:8501
-# - API Docs: http://localhost:8000/docs
->>>>>>> da9f327 (Initial commit: Uploading AI Code Scanner project files and models)