Update README.md

README.md

@@ -7,63 +7,159 @@ colorTo: purple
 sdk: gradio
 sdk_version: 5.49.1
 ---
-An AI-powered code review assistant that analyzes code quality, detects security vulnerabilities, and suggests improvements across 13+ programming languages.
-
-✨ Features
-🛡️ Security Vulnerability Detection: Identifies SQL injection, XSS, buffer overflows, and more
-📊 Code Quality Analysis: Detects code smells, performance issues, and best practice violations
-💡 Improvement Suggestions: Provides actionable recommendations
-🐛 Bug Detection: Catches common programming errors
-🌐 Multi-Language Support: Python, JavaScript, Java, C, C++, C#, Go, PHP, Ruby, Swift, Kotlin, TypeScript, Fortran
-🚀 How to Use
+🔒 STHASI Code Review Assistant
+
+An AI-powered code review assistant that analyzes code quality, detects security vulnerabilities, and suggests improvements.
+
+
+🌟 Features
+
+Code Quality Analysis: Evaluate code structure, readability, and best practices
+
+Security Vulnerability Detection: Identify SQL injection, XSS, authentication flaws, and more
+
+Improvement Suggestions: Get performance optimizations and refactoring recommendations
+
+Bug Detection: Find logic errors, edge cases, and potential issues
+
+Multi-Language Support: Python, JavaScript, Java, C++, Go, Rust, PHP, and more
+
+🚀 Technology Stack
+
+Model: Qwen2.5-Coder-7B-Instruct (State-of-the-art code understanding)
+
+Framework: Gradio 5.49.1
+
+Platform: Hugging Face Spaces
+
+📦 Installation
+For Hugging Face Spaces Deployment:
+
+Create a new Space on Hugging Face
+
+Choose "Gradio" as the SDK
+
+Upload the following files:
+
+app.py
+
+requirements.txt
+
+README.md
+
+Set the Space to use GPU (recommended: T4 or A10G)
+For Local Development:
+# Clone the repository
+git clone <your-repo-url>
+cd sthasi-code-review-assistant
+
+# Install dependencies
+pip install -r requirements.txt
+
+# Run the application
+python app.py
+
+🎯 Usage
+
 Paste your code in the code editor
+
 Select the programming language
-Choose analysis type: Security Vulnerabilities, Code Quality, or Both
-Click "Analyze Code" to get insights
-Or load one of the pre-built vulnerable code examples
-🧠 Model
-
-Powered by CodeAstra-7B, a state-of-the-art vulnerability detection model with 83% accuracy, fine-tuned on:
-
-CVEFix dataset
-YesWeHack vulnerable code repository
-OWASP test cases
-80+ programming languages from The Stack
-📊 Performance
-
-CodeAstra-7B achieves superior performance compared to other models:
-
-Model	Accuracy
-GPT-4o	88.78%
-CodeAstra-7B	83.00%
-CodeBERT	62.08%
-RoBERTa	61.05%
-🔧 Technical Stack
-Frontend: Gradio 4.19.2
-Model: CodeAstra-7B (Mistral-7B-Instruct fine-tuned)
-Inference: PEFT with 4-bit quantization for efficient GPU usage
-Backend: Transformers, PyTorch, BitsAndBytes
-👨‍💻 About the Creator
 
+Choose analysis type:
+
+Full Analysis (Quality + Security + Improvements)
+
+Security Vulnerabilities Only
+
+Code Quality & Improvements
+
+Bug Detection
+
+Click "Analyze Code" and get comprehensive feedback
+📋 Supported Languages
+
+Python
+
+JavaScript
+
+Java
+
+C/C++
+
+C#
+
+Go
+
+Rust
+
+PHP
+
+Ruby
+
+TypeScript
+
+SQL
+
+Bash
+
+Kotlin
+
+Swift
+
+🔧 Advanced Settings
+
+Temperature: Control response creativity (0.1-1.0)
+
+Max Tokens: Set maximum analysis length (512-4096)
+
+📊 Analysis Types
+🔍 Full Analysis
+
+Comprehensive review covering code quality, security, and improvements
+
+🛡️ Security Vulnerabilities Only
+
+Focused security analysis with severity ratings and CVE references
+
+✨ Code Quality & Improvements
+
+Evaluation of code structure, performance, and best practices
+
+🐛 Bug Detection
+
+Identification of syntax errors, logic errors, and edge case failures
+
+⚠️ Important Notes
+
+This is an AI-powered tool. Always verify critical security findings with manual review
+
+The tool provides suggestions based on best practices and common vulnerabilities
+
+For production systems, consult with security experts for comprehensive audits
+
+🤝 Contributing
+
+Contributions are welcome! Please feel free to submit issues or pull requests.
+
+📞 Contact
+
+Syed Tahir Hussan
+
+LinkedIn: syedtahirhussan
+
+GitHub: SyedTahirHussan
+
+📄 License
+
+This project is open source and available under the MIT License.
+
+🙏 Acknowledgments
+
+Powered by Qwen2.5-Coder-7B-Instruct
+
+Built with Gradio
+
+Hosted on Hugging Face Spaces
 Built with ❤️ by Syed Tahir Hussan
 
-💼 AI/ML/DL Project Manager & Researcher
-🎓 M.S. Software Engineering
-🏢 Founder, STH Research Center for Advanced Technologies
-📧 LinkedIn | GitHub
-⚠️ Limitations
-Works best with code snippets under 2048 tokens
-May not catch all vulnerabilities (use as part of comprehensive security review)
-Performance varies with code complexity
-Best results with English comments
-📝 License
-
-Apache 2.0 License - Free for commercial and non-commercial use
-
-🙏 Acknowledgements
-Hugging Face for hosting infrastructure
-CodeAstra-7B by Harish Santhanalakshmi Ganesan
-Mistral AI for the base model
-BigCode Initiative for The Stack dataset
-
-Disclaimer: This tool is for educational and assistive purposes. Always conduct thorough manual security audits for production code.
+Made with ❤️ for the developer community