cabreraevil/nsfw-detector repository overview

nsfw-detector/
├── app/
│   ├── __init__.py
│   ├── main.py                 # FastAPI application
│   ├── api/
│   │   ├── __init__.py
│   │   └── routes.py          # API endpoints
│   ├── core/
│   │   ├── __init__.py
│   │   ├── config.py          # Configuration management
│   │   └── detector.py        # NSFW detection logic
│   ├── models/
│   │   ├── __init__.py
│   │   └── schemas.py         # Pydantic models
│   └── utils/
│       ├── __init__.py
│       └── logger.py          # Structured logging
├── tests/
│   ├── __init__.py
│   └── test_api.py            # API tests
├── scripts/
│   └── classify_cli.py        # CLI tool
├── config/                     # Configuration files
├── docker/                     # Docker-related files
├── logs/                       # Application logs
├── .mise.toml                  # Mise configuration
├── docker-compose.yml          # Docker Compose config
├── Dockerfile                  # Multi-stage Docker build
├── requirements.txt            # Python dependencies
├── requirements-dev.txt        # Development dependencies
├── pyproject.toml             # Project metadata and tools
├── Makefile                   # Convenience commands
└── README.md                  # This file

git clone <repository-url>
cd nsfw-detector
docker-compose up -d

curl http://localhost:8000/api/v1/health

curl -X POST "http://localhost:8000/api/v1/classify/url" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/image.jpg"}'

cd nsfw-detector
mise install          # Install Python 3.11
mise run install      # Install dependencies

mise run dev

python -m venv .venv
source .venv/bin/activate  # Linux/Mac
# or
.venv\Scripts\activate     # Windows

pip install -r requirements.txt

uvicorn app.main:app --reload --host 0.0.0.0 --port 8000

curl -X POST "http://localhost:8000/api/v1/classify" \
  -F "file=@/path/to/image.jpg"

{
  "label": "nsfw",
  "score": 0.9876,
  "raw": [
    {"label": "nsfw", "score": 0.9876},
    {"label": "normal", "score": 0.0124}
  ]
}

curl -X POST "http://localhost:8000/api/v1/classify/url" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/image.jpg"}'

{
  "label": "safe",
  "score": 0.9912,
  "raw": [
    {"label": "normal", "score": 0.9912},
    {"label": "nsfw", "score": 0.0088}
  ]
}

curl -X POST "http://localhost:8000/api/v1/classify/batch" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": [
      "https://example.com/image1.jpg",
      "https://example.com/image2.jpg"
    ]
  }'

{
  "results": [
    {
      "image": "https://example.com/image1.jpg",
      "label": "safe",
      "score": 0.9912,
      "raw": [...],
      "error": null
    },
    {
      "image": "https://example.com/image2.jpg",
      "label": "nsfw",
      "score": 0.9234,
      "raw": [...],
      "error": null
    }
  ]
}

{
  "status": "healthy",
  "version": "1.0.0",
  "model_loaded": true
}

{
  "total_requests": 42,
  "total_images": 45,
  "nsfw_count": 12,
  "safe_count": 33,
  "average_processing_time": 0.1234
}

# Single image
python scripts/classify_cli.py /path/to/image.jpg

# Multiple images
python scripts/classify_cli.py image1.jpg image2.jpg image3.jpg

# JSON output
python scripts/classify_cli.py --json /path/to/image.jpg

# Application Settings
APP_NAME=NSFW Image Detector
ENVIRONMENT=production
DEBUG=False

# API Settings
API_HOST=0.0.0.0
API_PORT=8000
MAX_UPLOAD_SIZE=10485760  # 10MB

# Model Settings
MODEL_NAME=Falconsai/nsfw_image_detection
MODEL_CACHE_DIR=./model_cache
DEVICE=cpu  # Use 'cuda' for GPU acceleration

# Logging
LOG_LEVEL=INFO
LOG_FORMAT=json

# Workers
WORKERS=1

pip install -r requirements-dev.txt

pytest tests/ -v
# or
make test

ruff format app/ tests/
# or
make format

ruff check app/ tests/
# or
make lint

# Build image
make docker-build
# or
docker build -t nsfw-detector:latest .

# Start services
make docker-up
# or
docker-compose up -d

# View logs
make docker-logs
# or
docker-compose logs -f

# Stop services
make docker-down
# or
docker-compose down

# docker-compose.scale.yml
services:
  nsfw-detector:
    # ... existing config ...
    deploy:
      replicas: 3

docker-compose up -d --scale nsfw-detector=3

FROM nvidia/cuda:11.8.0-runtime-ubuntu22.04