mirror of
https://github.com/wiltodelta/remove-ai-watermarks.git
synced 2026-08-07 06:28:36 +02:00
39 lines
2.1 KiB
Markdown
39 lines
2.1 KiB
Markdown
# 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](installation.md) | You need the CLI, an optional model backend, or a development environment. |
|
|
| [CLI guide](cli.md) | You want a command for one image, a directory, or a specific watermark type. |
|
|
| [Python API](python-api.md) | You want to call the package from Python. |
|
|
| [Supported signals](supported-signals.md) | You need to know which visible marks, metadata formats, and invisible signals are covered. |
|
|
| [Known limitations](known-limitations.md) | You need the quality, device, format, or verification boundaries. |
|
|
| [Scope, safety, and legal notes](legal-and-safety.md) | You need the intended use and legal context. |
|
|
|
|
## Maintainer references
|
|
|
|
| Page | Purpose |
|
|
| --- | --- |
|
|
| [Module internals](module-internals.md) | Current architecture, invariants, and regression guards by module. |
|
|
| [Verification plan](verification-plan.md) | Verification methods, completed measurements, and remaining validation gaps. |
|
|
| [Release and distribution](release-and-distribution.md) | PyPI, Homebrew, Hugging Face Space, and release workflow. |
|
|
| [Watermarking landscape](watermarking-landscape.md) | Vendor signals and detection approaches. |
|
|
| [SynthID technical reference](synthid.md) | 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.
|
|
|
|
- [ControlNet removal research](controlnet-removal-pipeline-research.md)
|
|
- [Qwen improvement research](qwen-improvement-research.md)
|
|
- [Doubao reverse-alpha research](research-doubao-distillation.md)
|
|
- [SynthID identity research](synthid-robust-identity-research.md)
|
|
- [SynthID identity follow-up](synthid-robust-identity-research-2026-06-08.md)
|
|
- [Text protection research](text-protection-research.md)
|