docs(user): refresh user-facing docs (post-session-2026-04-29)#216
Merged
docs(user): refresh user-facing docs (post-session-2026-04-29)#216
Conversation
Refresh docs that drifted from recent merged surfaces: - docs/metrics/features.md — de-duplicate the extractor overview table (3 dupe rows from past merge conflicts removed); reflect CAMBI Vulkan (T7-36 / ADR-0210), integer-SSIM Vulkan (T7-24), SSIMULACRA 2 CUDA / SYCL twins (ADR-0206), and the in-flight PSNR Vulkan chroma path (T3-15(b) / PR #204) via footnotes; rewrite the per-section Backends lines for CAMBI, SSIM, and PSNR to match. - docs/api/gpu.md — flip the Vulkan section from "scaffold only as of v3.0" to "T5-1c full default-model coverage". List the live extractors, point at T7-29 image-import zero-copy API (vmaf_vulkan_state_init_external + import_image), and at the T7-10 HIP scaffold (PR #200, libvmaf_hip.h follow-up). - CHANGELOG.md — Unreleased § Changed entry for the doc-only refresh. Doc-only — no code changes.
lusoris
force-pushed
the
docs/refresh-user-facing
branch
from
70b036e to
a4dd91a
Compare
There was a problem hiding this comment.
Pull request overview
Updates user-facing documentation to reflect the current GPU-backend and extractor landscape, aligning docs with recently landed Vulkan/HIP work and feature-matrix cleanups.
Changes:
- Cleans up and updates the extractor/feature matrix in
docs/metrics/features.md(dedupe + backend/footnote updates). - Refreshes
docs/api/gpu.mdVulkan status/coverage and related GPU API notes. - Adds an Unreleased changelog entry describing the doc refresh.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| docs/metrics/features.md | Updates the feature/extractor overview table and multiple backend-description sections (PSNR/SSIM/CAMBI/LPIPS notes). |
| docs/api/gpu.md | Updates the GPU API documentation, especially Vulkan status and related lifecycle/limitations notes. |
| CHANGELOG.md | Adds an Unreleased “Changed” entry documenting the doc refresh. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+192
to
+194
| - No HIP path in this header. The HIP / AMD-ROCm backend is being | ||
| scaffolded under T7-10 (PR #200, in flight) — a future | ||
| `libvmaf_hip.h` will mirror this surface. See |
Comment on lines
+381
to
+383
| > `float_vif_vulkan`, `float_motion_vulkan`, `psnr_vulkan` (luma; | ||
| > chroma via T3-15(b) PR #204), `psnr_hvs_vulkan`, `ciede_vulkan`, | ||
| > `float_ssim_vulkan`, `float_ms_ssim_vulkan`, `float_ansnr_vulkan`, |
Comment on lines
+387
to
+388
| > (`vmaf_vulkan_state_init_external` / `_import_image` / | ||
| > `_wait_compute` / `_read_imported_pictures`) landed via T7-29 / |
Comment on lines
+463
to
+464
| - HIP / AMD-ROCm support is scaffolded under T7-10 (PR #200); | ||
| a public `libvmaf_hip.h` is planned to mirror this surface. |
Comment on lines
+58
to
+62
| (`psnr_y`). `psnr_vulkan` adds `psnr_cb` / `psnr_cr` chroma metrics | ||
| when `enable_chroma=true` (default) — see T3-15(b) work-in-progress | ||
| PR #204 / [`backends/vulkan/overview.md`](../backends/vulkan/overview.md). | ||
| The CPU `psnr` extractor emits the full luma + chroma set on every | ||
| build. CUDA / SYCL chroma support is a focused follow-up. |
| | PSNR (float) | `float_psnr` | No | `float_psnr` (luma only — the CPU extractor emits a single luma score) | AVX2, AVX-512, NEON | CUDA, SYCL, Vulkan | | ||
| | PSNR-HVS | `psnr_hvs` | No | `psnr_hvs`, `psnr_hvs_y`, `psnr_hvs_cb`, `psnr_hvs_cr` | AVX2, NEON | CUDA, SYCL, Vulkan | | ||
| | SSIM (fixed) | `ssim` | No | `ssim` | — | — | | ||
| | SSIM (fixed) | `ssim` | No | `ssim` | — | Vulkan² | |
Comment on lines
+64
to
+66
| ² SSIM (fixed-point) ships a Vulkan kernel via T7-24 (ADR-pending); | ||
| the CPU integer path is scalar-only by design. The `float_ssim` / | ||
| `float_ms_ssim` paths cover all three GPU backends. |
Comment on lines
+418
to
+420
| (`psnr_y`); `psnr_vulkan` is gaining `psnr_cb` / `psnr_cr` chroma | ||
| support via T3-15(b) (PR #204, in flight). `float_psnr` adds | ||
| CUDA / SYCL / Vulkan twins on the float pipeline. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Refresh user-facing docs to match current codebase state.
docs/metrics/features.md— de-duplicate the extractor overview table (3 leftover dupe rows removed); reflect CAMBI Vulkan (T7-36 / ADR-0210), integer-SSIM Vulkan (T7-24), SSIMULACRA 2 CUDA/SYCL twins (ADR-0206), and the in-flight PSNR Vulkan chroma path (T3-15(b) / PR feat(vulkan): T3-15(b) — psnr chroma (psnr_cb / psnr_cr) on Vulkan #204) via footnotes; rewrite the per-section Backends lines for CAMBI, SSIM, and PSNR to match.docs/api/gpu.md— flip the Vulkan section from "scaffold only as of v3.0" to "T5-1c full default-model coverage". List the live extractors, point at T7-29 image-import zero-copy API (vmaf_vulkan_state_init_external+import_image), and at the T7-10 HIP scaffold (PR feat(hip): T7-10 — HIP (AMD) backend scaffold (audit-first) #200, futurelibvmaf_hip.h).CHANGELOG.md— Unreleased § Changed entry.Doc-only refresh; no code changes. Sister agents own README/top-level + planning files; this PR scoped strictly to
docs/usage/,docs/metrics/,docs/backends/,docs/ai/,docs/mcp/,docs/api/per the parent task.Deep-dive deliverables (ADR-0108)
Test plan
Hard constraints
🤖 Generated with Claude Code