Running in a minute.

With a double-click

1. Download MAFDET: on GitHub, Code → Download ZIP, and unzip it (or git clone).
2. Double-click start_mafdet.bat. The first time it creates a Python environment in .venv and installs MAFDET, about a minute. Needs Python 3.10 or later.
3. After that, a double-click opens MAFDET in under a second. After an update it installs the new libraries by itself.

From PyPI

With Python from python.org, pip works as it is.

$ pip install mafdet
$ mafdet

Runs on NVIDIA through CUDA (reference: RTX 2060, 6 GB), on AMD Radeon through Vulkan (in place, not measured yet), or on the CPU.

With a double-click

1. Download MAFDET (Code → Download ZIP, or git clone).
2. Double-click start_mafdet.command. Python 3.10 or later: from python.org, or brew install python@3.12.
3. If the Finder says it cannot verify the file: right-click, Open, then Open again. Only the first time.

From PyPI, with pipx

Homebrew's Python refuses pip install outside a virtual environment: pipx gives MAFDET an environment of its own.

$ brew install pipx
$ pipx ensurepath        # then open a new terminal
$ pipx install mafdet
$ mafdet

Apple Silicon (M1 or later) runs the models on the GPU through Metal, in the unified memory. Tested on an M2 Pro with 16 GB. Intel Macs run on the CPU.

Not tested yet

Linux has its llama.cpp builds and code paths in place (CUDA, Vulkan, CPU), but nobody has run MAFDET on it end to end yet. If you try it, an issue with the output of mafdet doctor is the most useful thing you can send.

From PyPI, with pipx

Recent Ubuntu and Debian stop pip install with externally-managed-environment: use pipx.

$ sudo apt install pipx
$ pipx ensurepath        # then open a new terminal
$ pipx install mafdet
$ mafdet

In a terminal

Also for the measurements in research/.

$ git clone https://github.com/TheLastOxygen/mafdet.git
$ cd mafdet
$ python -m venv .venv          # Windows: py -3.12 -m venv .venv
$ source .venv/bin/activate     # Windows: .venv\Scripts\Activate.ps1
$ pip install -e .
$ mafdet

Updating

$ pipx upgrade mafdet          # or: pip install -U mafdet

The double-click scripts update their environment by themselves after a git pull.