AI-Checker / READMEs.md
Pujan-Dev's picture
feat:added readme.md
8ac659e
# AI-Contain-Checker
A modular AI content detection system with support for **image classification**, **image edit detection**, **Nepali text classification**, and **general text classification**. Built for performance and extensibility, it is ideal for detecting AI-generated content in both visual and textual forms.
## 🌟 Features
### πŸ–ΌοΈ Image Classifier
* **Purpose**: Classifies whether an image is AI-generated or a real-life photo.
* **Model**: Fine-tuned **InceptionV3** CNN.
* **Dataset**: Custom curated dataset with **\~79,950 images** for binary classification.
* **Location**: [`features/image_classifier`](features/image_classifier)
* **Docs**: [`docs/features/image_classifier.md`](docs/features/image_classifier.md)
### πŸ–ŒοΈ Image Edit Detector
* **Purpose**: Detects image tampering or post-processing.
* **Techniques Used**:
* **Error Level Analysis (ELA)**: Visualizes compression artifacts.
* **Fast Fourier Transform (FFT)**: Detects unnatural frequency patterns.
* **Location**: [`features/image_edit_detector`](features/image_edit_detector)
* **Docs**:
* [ELA](docs/detector/ELA.md)
* [FFT](docs/detector/fft.md )
* [Metadata Analysis](docs/detector/meta.md)
* [Backend Notes](docs/detector/note-for-backend.md)
### πŸ“ Nepali Text Classifier
* **Purpose**: Determines if Nepali text content is AI-generated or written by a human.
* **Model**: Based on `XLMRClassifier` fine-tuned on Nepali language data.
* **Dataset**: Scraped dataset of **\~18,000** Nepali texts.
* **Location**: [`features/nepali_text_classifier`](features/nepali_text_classifier)
* **Docs**: [`docs/features/nepali_text_classifier.md`](docs/features/nepali_text_classifier.md)
### 🌐 English Text Classifier
* **Purpose**: Detects if English text is AI-generated or human-written.
* **Pipeline**:
* Uses **GPT2 tokenizer** for input preprocessing.
* Custom binary classifier to differentiate between AI and human-written content.
* **Location**: [`features/text_classifier`](features/text_classifier)
* **Docs**: [`docs/features/text_classifier.md`](docs/features/text_classifier.md)
---
## πŸ—‚οΈ Project Structure
```bash
AI-Checker/
β”‚
β”œβ”€β”€ app.py # Main FastAPI entry point
β”œβ”€β”€ config.py # Configuration settings
β”œβ”€β”€ Dockerfile # Docker build script
β”œβ”€β”€ Procfile # Deployment file for Heroku or similar
β”œβ”€β”€ requirements.txt # Python dependencies
β”œβ”€β”€ README.md # You are here πŸ“˜
β”‚
β”œβ”€β”€ features/ # Core detection modules
β”‚ β”œβ”€β”€ image_classifier/
β”‚ β”œβ”€β”€ image_edit_detector/
β”‚ β”œβ”€β”€ nepali_text_classifier/
β”‚ └── text_classifier/
β”‚
β”œβ”€β”€ docs/ # Internal and API documentation
β”‚ β”œβ”€β”€ api_endpoints.md
β”‚ β”œβ”€β”€ deployment.md
β”‚ β”œβ”€β”€ detector/
β”‚ β”‚ β”œβ”€β”€ ELA.md
β”‚ β”‚ β”œβ”€β”€ fft.md
β”‚ β”‚ β”œβ”€β”€ meta.md
β”‚ β”‚ └── note-for-backend.md
β”‚ β”œβ”€β”€ functions.md
β”‚ β”œβ”€β”€ nestjs_integration.md
β”‚ β”œβ”€β”€ security.md
β”‚ β”œβ”€β”€ setup.md
β”‚ └── structure.md
β”‚
β”œβ”€β”€ IMG_Models/ # Saved image classifier model(s)
β”‚ └── latest-my_cnn_model.h5
β”‚
β”œβ”€β”€ notebooks/ # Experimental and debug notebooks
β”œβ”€β”€ static/ # Static assets if needed
└── test.md # Test notes
````
---
## πŸ“š Documentation Links
* [API Endpoints](docs/api_endpoints.md)
* [Deployment Guide](docs/deployment.md)
* [Detector Documentation](docs/detector/)
* [Error Level Analysis (ELA)](docs/detector/ELA.md)
* [Fast Fourier Transform (FFT)](docs/detector/fft.md)
* [Metadata Analysis](docs/detector/meta.md)
* [Backend Notes](docs/detector/note-for-backend.md)
* [Functions Overview](docs/functions.md)
* [NestJS Integration Guide](docs/nestjs_integration.md)
* [Security Details](docs/security.md)
* [Setup Instructions](docs/setup.md)
* [Project Structure](docs/structure.md)
---
## πŸš€ Usage
1. **Install dependencies**
```bash
pip install -r requirements.txt
```
2. **Run the API**
```bash
uvicorn app:app --reload
```
3. **Build Docker (optional)**
```bash
docker build -t ai-contain-checker .
docker run -p 8000:8000 ai-contain-checker
```
---
## πŸ” Security & Integration
* **Token Authentication** and **IP Whitelisting** supported.
* NestJS integration guide: [`docs/nestjs_integration.md`](docs/nestjs_integration.md)
* Rate limiting handled using `slowapi`.
---
## πŸ›‘οΈ Future Plans
* Add **video classifier** module.
* Expand dataset for **multilingual** AI content detection.
* Add **fine-tuning UI** for models.
---
## πŸ“„ License
See full license terms here: [`LICENSE.md`](license.md)