mirror of
https://github.com/wiltodelta/remove-ai-watermarks.git
synced 2026-10-14 13:30:55 +02:00
60 lines
4.5 KiB
Markdown
60 lines
4.5 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 an image, video metadata or visible marks, 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. |
|
|
| [Photo pixel classification](photo-classify.md) | You want `classify` / `classify_pixels`: AI versus camera, optional provider. |
|
|
| [Photo classifier training](photo-classify-training.md) | You need the retrain pack, public sources, and what is not published. |
|
|
| [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. |
|
|
| [Development](development.md) | Environment setup, dependency recovery, CI behavior, and fixture policy. |
|
|
| [Watermark benchmark kernel](benchmark-kernel.md) | Reproducible local detection, removal-observation, and fidelity measurements. |
|
|
| [Code provenance](code-provenance.md) | Required notices for licensed derivative work. |
|
|
| [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, photo-classify Hub model, ComfyUI Registry, and the release workflow. |
|
|
| [Agent skill](agent-skill.md) | Install and maintain the published Agent Skill and Claude plugin. |
|
|
| [Watermarking landscape](watermarking-landscape.md) | Vendor signals and detection approaches. |
|
|
| [SynthID technical reference](synthid.md) | Mechanism, provenance, robustness, regeneration. |
|
|
|
|
## 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)
|
|
- [AI-generated image classifiers](ai-generated-image-classifiers.md) (photo AI-versus-camera freeze consumed by `classify_pixels`, not `identify`)
|
|
- [Photo classifier Hugging Face card](photo-classify-hf/README.md) (Hub publication text of the 2026-08-31 freeze)
|
|
- [SynthID source classifiers](synthid-classifiers.md) (metadata-free OpenAI/Gemini source finding and provider-lineage experiments)
|
|
- [SynthID local detector research](synthid-detector-research.md)
|
|
- [SynthID mark removal research](synthid-removal-research.md)
|
|
- [SynthID identity research](synthid-robust-identity-research.md)
|
|
- [SynthID identity follow-up](synthid-robust-identity-research-2026-06-08.md)
|
|
- [Video SynthID quality research](video-synthid-quality-research.md)
|
|
- [OpenAI SynthID oracle ladders](synthid-oracle-ladders.md) (routing hub)
|
|
- [Provider oracle tooling](provider-oracles.md) (Google, OpenAI, Microsoft, and Meta execution surfaces)
|
|
- [SynthID detector and removal plan](synthid-detector-removal-plan.md) (chronological mixed archive)
|
|
- [Text protection research](text-protection-research.md)
|
|
- [Audio provenance experiment](audio-provenance-experiment.md) (local AudioSeal matched-oracle study of video audio tracks across visual cleaning)
|
|
- [VideoSeal temporal evaluation](videoseal-temporal-evaluation.md) (per-frame scores, aggregation matrix, and crf decay on synthetic and real clips)
|
|
- [Watermark forgery study](watermark-forgery-study.md) (four-state model and double-embedding: the last writer wins under both oracles)
|
|
- [C2PA resolution research](c2pa-resolution-research.md) (measured resolver contracts, the privacy gradient, and the decision to never resolve over the network)
|
|
- [External benchmark licensing](external-benchmark-licensing.md) (ETI license-blocked, W-Bench dataset MIT with non-commercial code, verified 2026-09-07)
|
|
- [Chroma1 engine research](chroma1-engine-research.md)
|