Spaces:
Running
Running
readme update
Browse files
README.md
CHANGED
|
@@ -27,8 +27,6 @@ An advanced security orchestration tool that detects critical vulnerabilities (S
|
|
| 27 |
* **Batch Processing:** Optimized for high-throughput scanning of multiple Python files simultaneously using Python's `multiprocessing` capabilities.
|
| 28 |
* **REST API Architecture:** Built with a **FastAPI** backend, allowing for easy integration into existing CI/CD pipelines as a security gate.
|
| 29 |
|
| 30 |
-
---
|
| 31 |
-
|
| 32 |
## Technical Stack
|
| 33 |
* **Deep Learning:** CodeBERT (Transformers), PyTorch
|
| 34 |
* **Analysis Engine:** Python AST, Custom Rule-based Heuristics
|
|
@@ -64,21 +62,21 @@ An advanced security orchestration tool that detects critical vulnerabilities (S
|
|
| 64 |
* docker-compose up --build
|
| 65 |
|
| 66 |
## Access at:
|
| 67 |
-
*
|
| 68 |
-
*
|
| 69 |
|
| 70 |
## Project Structure
|
| 71 |
|
| 72 |
AI-Code-Security-Scanner/
|
| 73 |
-
βββ app.py
|
| 74 |
-
βββ api_backend.py
|
| 75 |
-
βββ combined_detector.py # Hybrid Logic (Rules + CodeBERT Model)
|
| 76 |
-
βββ rule_detector.py
|
| 77 |
-
βββ fix_generator.py
|
| 78 |
-
βββ saved_model/
|
| 79 |
-
βββ docker-compose.yml
|
| 80 |
-
βββ requirements.txt
|
| 81 |
-
βββ README.md
|
| 82 |
|
| 83 |
## Architecture Diagram
|
| 84 |
|
|
|
|
| 27 |
* **Batch Processing:** Optimized for high-throughput scanning of multiple Python files simultaneously using Python's `multiprocessing` capabilities.
|
| 28 |
* **REST API Architecture:** Built with a **FastAPI** backend, allowing for easy integration into existing CI/CD pipelines as a security gate.
|
| 29 |
|
|
|
|
|
|
|
| 30 |
## Technical Stack
|
| 31 |
* **Deep Learning:** CodeBERT (Transformers), PyTorch
|
| 32 |
* **Analysis Engine:** Python AST, Custom Rule-based Heuristics
|
|
|
|
| 62 |
* docker-compose up --build
|
| 63 |
|
| 64 |
## Access at:
|
| 65 |
+
* Web UI: http://localhost:8501
|
| 66 |
+
* API Docs: http://localhost:8000/docs
|
| 67 |
|
| 68 |
## Project Structure
|
| 69 |
|
| 70 |
AI-Code-Security-Scanner/
|
| 71 |
+
* βββ app.py # Main Streamlit Dashboard & UI Logic
|
| 72 |
+
* βββ api_backend.py # FastAPI Server for REST API Access
|
| 73 |
+
* βββ combined_detector.py # Hybrid Logic (Rules + CodeBERT Model)
|
| 74 |
+
* βββ rule_detector.py # Static Analysis & AST-based Heuristics
|
| 75 |
+
* βββ fix_generator.py # AI-powered Remediation Engine
|
| 76 |
+
* βββ saved_model/ # Fine-tuned CodeBERT Weights & Config
|
| 77 |
+
* βββ docker-compose.yml # Container Orchestration for UI & API
|
| 78 |
+
* βββ requirements.txt # Project Dependencies
|
| 79 |
+
* βββ README.md # Technical Documentation
|
| 80 |
|
| 81 |
## Architecture Diagram
|
| 82 |
|