Files
remove-ai-watermarks/docs/index.md
T

2.1 KiB

Documentation

This documentation is split by purpose. Start with the user guides if you want to run the tool. Use the maintainer references only when changing the code.

User guides

Page Use it when
Installation You need the CLI, an optional model backend, or a development environment.
CLI guide You want a command for one image, a directory, or a specific watermark type.
Python API You want to call the package from Python.
Supported signals You need to know which visible marks, metadata formats, and invisible signals are covered.
Known limitations You need the quality, device, format, or verification boundaries.
Scope, safety, and legal notes You need the intended use and legal context.

Maintainer references

Page Purpose
Module internals Current architecture, invariants, and regression guards by module.
Verification plan Verification methods, completed measurements, and remaining validation gaps.
Release and distribution PyPI, Homebrew, Hugging Face Space, and release workflow.
Watermarking landscape Vendor signals and detection approaches.
SynthID technical reference Mechanism, detector access, robustness, and implications for this project.

Research archive

These pages record experiments and the evidence behind past decisions. They are not command references and may describe prototypes that were later removed. The current behavior is defined by the code, tests, README, and user guides.