Skip to content

Commit 2bb61b6

Browse files
committed
Add overview and reorg
1 parent 28d003c commit 2bb61b6

File tree

2 files changed

+39
-8
lines changed

2 files changed

+39
-8
lines changed

docs/trustmark-oveview.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
id: trustmark-overview
3+
title: TrustMark watermarking
4+
---
5+
6+
TrustMark is an open-source universal watermarking system for images that:
7+
- Can encode, decode, and remove watermarks from images.
8+
- Works with arbitrary resolution images.
9+
- Has implementations in both Python (using PyTorch) and JavaScript (using ONNX).
10+
11+
## Variants
12+
13+
TrustMark has three primary model variants, each with different characteristics.
14+
15+
Images encoded with one variant cannot be decoded with another variant, so you need to stick with the same variant throughout your pipeline.
16+
17+
- **Variant Q (Default)** Use in most cases, where you want a good balance between robustness and imperceptibility. PSNR is 48-50 dB.
18+
- **Variant P** - Use when image quality is the top priority. PSNR is 43-45 dB.
19+
- **Variant C (Compact)** - Use if you need to minimize model size and can live with slightly lower visual quality. PSNR is 38-39 dB.
20+
21+
The general recommendation is to use either:
22+
- Variant Q for most use cases
23+
- Variant P when visual quality is paramount
24+
25+
### About PSNR
26+
27+
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:
28+
- Values around 40+ dB typically indicate very good quality
29+
- Values around 30 dB indicate acceptable quality
30+
- Values below 20 dB usually indicate poor quality
31+

sidebars.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -271,14 +271,14 @@ const sidebars = {
271271
},
272272
{
273273
type: 'category',
274-
label: 'TrustMark',
275-
link: { type: 'doc', id: 'trustmark/readme' },
274+
label: 'TrustMark watermarking',
275+
link: { type: 'doc', id: 'trustmark-overview' },
276276
collapsed: true,
277277
items: [
278278
{
279279
type: 'doc',
280-
id: 'trustmark/faq',
281-
label: 'FAQ',
280+
id: 'trustmark/readme',
281+
label: 'Overview',
282282
},
283283
{
284284
type: 'doc',
@@ -287,13 +287,13 @@ const sidebars = {
287287
},
288288
{
289289
type: 'doc',
290-
id: 'trustmark/js-readme',
291-
label: 'TrustMark JS',
290+
id: 'trustmark/faq',
291+
label: 'FAQ',
292292
},
293293
{
294294
type: 'doc',
295-
id: 'trustmark/python-readme',
296-
label: 'FAQ',
295+
id: 'trustmark/js-readme',
296+
label: 'JavaScript implementation',
297297
},
298298
],
299299
},

0 commit comments

Comments
 (0)