INSTALLATION.md

Installation Guide

Installation Options

Choose the method that works best for your workflow:

Using pip (recommended)

pip install moderators

Using uv

uv venv --python 3.10
source .venv/bin/activate
uv add moderators

From source (cloned repo)

uv sync --extra transformers

Requirements

• Python: 3.10+
• For image tasks: Pillow and a deep learning framework (PyTorch preferred)
  • Moderators can auto-install these dependencies when needed

Dependency Auto-Installation

If something is missing (e.g., torch, transformers, Pillow), Moderators can automatically install it via uv or pip unless you disable this feature.

To disable auto-installation:

export MODERATORS_DISABLE_AUTO_INSTALL=1

Manual Dependency Control

If you prefer to manage dependencies manually, install with extras:

pip install "moderators[transformers]"

Offline Mode

After caching models, you can run completely offline:

CLI:

moderators <model_id> <input> --local-files-only

Python API:

moderator = AutoModerator.from_pretrained("model-id", local_files_only=True)

GPU Support

Moderators works on CPU by default. If your deep learning framework (e.g., PyTorch) is installed with CUDA support, GPU acceleration will be used automatically.

To ensure GPU usage:

• Install PyTorch with CUDA support following PyTorch installation guide
• Verify CUDA availability in your environment