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

πŸ–ŒοΈ Image Edit Detector

πŸ“ Nepali Text Classifier

🌐 English Text Classifier


πŸ—‚οΈ Project Structure

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


πŸš€ Usage

  1. Install dependencies

    pip install -r requirements.txt
    
  2. Run the API

    uvicorn app:app --reload
    
  3. Build Docker (optional)

    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
  • 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