Skip to content

Commit 81e018a

Browse files
committed
docs(models): SAAF simplify module docstring
1 parent 59b248d commit 81e018a

1 file changed

Lines changed: 7 additions & 19 deletions

File tree

compressai/models/saaf.py

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,13 @@
44
Compression via Sparse Attention and Adaptive Frequency", IEEE/CVF Conf.
55
on Computer Vision and Pattern Recognition (CVPR), 2026.
66
7-
Adapted from the upstream reference implementation; the entropy stack
8-
shares the containerized
9-
:class:`~compressai.latent_codecs.HyperpriorLatentCodec` /
10-
:class:`~compressai.latent_codecs.ChannelGroupsLatentCodec` wiring with
11-
DCAE and reuses
12-
:class:`~compressai.models._helpers.dictionary_context.DictionaryMeanScaleContextHead`.
13-
14-
Two SAAF-specific additions to the DCAE template:
15-
16-
- An auxiliary encoder / decoder chain (``aux_enc`` / ``aux_dec``) of
17-
:class:`_AdaptiveFrequencyBlock` /
18-
:class:`_InverseAdaptiveFrequencyBlock` modules runs alongside ``g_a`` /
19-
``g_s`` and is summed into the main path at every stage boundary. Each
20-
block carries an :class:`compressai.models._helpers.auxt.OLP` so the
21-
AuxT regulariser is integral (not opt-in like TCM ``use_auxt``);
22-
:meth:`SAAF.aux_loss` aggregates them via the shared helper.
23-
- A :class:`_DenoisingAsRegularizer` "diffusion prior" head produces a
24-
scalar ``diffusion_loss`` during training that the host's training loop
25-
adds to the rate-distortion objective.
7+
Adapted from the upstream reference implementation at
8+
https://github.com/huidong-ma/SAAF
9+
based on CompressAI, DCAE, and AuxT.
10+
11+
SAAF combines adaptive-frequency auxiliary transform branches
12+
(``aux_enc`` / ``aux_dec``) with a denoising regularizer that produces
13+
``diffusion_loss`` during training.
2614
"""
2715

2816
from __future__ import annotations

0 commit comments

Comments
 (0)