mubi-613 commited on
Commit
7877b4e
Β·
1 Parent(s): 2b18317

readme update

Browse files
Files changed (1) hide show
  1. README.md +11 -13
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
- * - Web UI: http://localhost:8501
68
- * - API Docs: http://localhost:8000/docs
69
 
70
  ## Project Structure
71
 
72
  AI-Code-Security-Scanner/
73
- β”œβ”€β”€ app.py # Main Streamlit Dashboard & UI Logic
74
- β”œβ”€β”€ api_backend.py # FastAPI Server for REST API Access
75
- β”œβ”€β”€ combined_detector.py # Hybrid Logic (Rules + CodeBERT Model)
76
- β”œβ”€β”€ rule_detector.py # Static Analysis & AST-based Heuristics
77
- β”œβ”€β”€ fix_generator.py # AI-powered Remediation Engine
78
- β”œβ”€β”€ saved_model/ # Fine-tuned CodeBERT Weights & Config
79
- β”œβ”€β”€ docker-compose.yml # Container Orchestration for UI & API
80
- β”œβ”€β”€ requirements.txt # Project Dependencies
81
- └── README.md # Technical Documentation
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