-
Notifications
You must be signed in to change notification settings - Fork 7
Add TrustMark to doc site #198
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
e790aff
Add trustmark to gitignore
crandmck 28d003c
Add TrustMark
crandmck 2bb61b6
Add overview and reorg
crandmck f6c8873
Revise overview and sidebar entries
crandmck 6848f52
John's comments
crandmck 68f023b
clean up
crandmck 67a2fdc
Add TOC to FAQ
crandmck db5c19e
Add GitHub link to sidebar
crandmck File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
id: trustmark-overview | ||
title: TrustMark watermarking | ||
--- | ||
|
||
TrustMark is an open-source universal watermarking system for images that: | ||
|
||
- Can encode, decode, and remove watermarks from images. | ||
- Works with arbitrary resolution images. | ||
- Has implementations in both Python (using PyTorch) and JavaScript (using ONNX). | ||
|
||
:::info | ||
For full technical details and help getting started with TrustMark, see [TrustMark - Quick start](trustmark/readme.md#quick-start). | ||
::: | ||
|
||
## Variants | ||
|
||
TrustMark has three primary model variants, each with different characteristics. | ||
|
||
Images encoded with one variant cannot be decoded with another variant, so you need to stick with the same variant throughout your pipeline. | ||
|
||
- **Variant Q (Default)** Use in most cases, where you want a good balance between robustness and imperceptibility. PSNR is 48-50 dB. | ||
- **Variant P** - Use when image quality is the top priority. PSNR is 43-45 dB. | ||
- **Variant C (Compact)** - Use if you need to minimize model size and can live with slightly lower visual quality. PSNR is 38-39 dB. | ||
|
||
The general recommendation is to use either: | ||
- Variant Q for most use cases | ||
- Variant P when visual quality is paramount | ||
|
||
### About PSNR | ||
|
||
PSNR (Peak Signal-to-Noise Ratio) is a technical metric used to measure image quality, particularly when comparing an original image to a modified version (in this case, the watermarked image). PSNR is measured in decibels (dB), and higher values indicate better image quality: | ||
- Values around 40+ dB typically indicate very good quality | ||
crandmck marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- Values around 30 dB indicate acceptable quality | ||
- Values below 20 dB usually indicate poor quality | ||
|
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.