Update README.md
Browse files
README.md
CHANGED
|
@@ -1,11 +1,35 @@
|
|
| 1 |
---
|
| 2 |
-
title:
|
| 3 |
-
emoji:
|
| 4 |
colorFrom: red
|
| 5 |
colorTo: pink
|
| 6 |
sdk: static
|
| 7 |
pinned: false
|
| 8 |
license: mit
|
| 9 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 10 |
|
| 11 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
| 1 |
---
|
| 2 |
+
title: TrueWrite Scan:- AI-Powered Writing Assistant
|
| 3 |
+
emoji: 🚀
|
| 4 |
colorFrom: red
|
| 5 |
colorTo: pink
|
| 6 |
sdk: static
|
| 7 |
pinned: false
|
| 8 |
license: mit
|
| 9 |
---
|
| 10 |
+
🚀 TrueWrite Scan: AI-Powered Writing Assistant
|
| 11 |
+
TrueWrite Scan is a full-stack AI application designed to enhance writing integrity. It integrates state-of-the-art NLP models to provide real-time Grammar Checking, Plagiarism Detection, and AI Content Classification.
|
| 12 |
+
|
| 13 |
+
🌟 Key Features
|
| 14 |
+
📝 Advanced Grammar Checker: Utilizes language-tool-python and custom rule sets to detect syntax and stylistic errors.
|
| 15 |
+
🔍 Semantic Plagiarism Detection: Powered by sentence-transformers to detect paraphrased content, not just exact matches.
|
| 16 |
+
🤖 AI Content Detector: Implements Hugging Face Transformers to analyze perplexity and burstiness, identifying machine-generated text.
|
| 17 |
+
📄 Multi-Format Support: Parses text from .txt, .docx, and .pdf files.
|
| 18 |
+
🛠️ Tech Stack
|
| 19 |
+
Frontend
|
| 20 |
+
Framework: Next.js 13+ (React)
|
| 21 |
+
Styling: Tailwind CSS
|
| 22 |
+
Deployment: Cloudfare Pages
|
| 23 |
+
Backend
|
| 24 |
+
Framework: FastAPI (Python)
|
| 25 |
+
ML Libraries: PyTorch, Transformers, Scikit-learn, NumPy
|
| 26 |
+
Deployment: Hugging Face Spaces (Dockerized)
|
| 27 |
+
🏗️ Architecture & Deployment Strategy
|
| 28 |
+
Running heavy ML models (PyTorch + JVM for Grammar) requires significant RAM. I implemented a Split Deployment Strategy to optimize performance on free-tier infrastructure:
|
| 29 |
+
|
| 30 |
+
Frontend (Vercel): Handles UI/UX and client-side logic.
|
| 31 |
+
Backend (Hugging Face Spaces): A custom Docker container running FastAPI.
|
| 32 |
+
Why Docker? To install System-level dependencies (OpenJDK 21 for Grammar check, build-essential for Auth).
|
| 33 |
+
Optimization: Configured to use CPU-optimized PyTorch builds to reduce slug size and memory footprint.
|
| 34 |
|
| 35 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|