Skip to content

docs(upstream): record what this fork has open against Netflix/vmaf - #1495

Merged
lusoris merged 1 commit into
masterfrom
docs/upstream-pr-links
Sep 19, 2026
Merged

lusoris merged 1 commit into
masterfrom
docs/upstream-pr-links

Conversation

@lusoris

@lusoris lusoris commented Sep 19, 2026

Copy link
Copy Markdown
Contributor

Summary

The fork has eight pull requests open against Netflix/vmaf and nothing in the tree said so. That matters at the next sync, because two of them fix bugs a fork PR also fixes, and one fixes it a different way.

docs/development/known-upstream-bugs.md gains two sections:

The part worth acting on. Upstream #1601 fixes the 16-bit DWT overflow by starting the sum from the normalization offset rather than widening the accumulator to int64, which is what the fork's #1477 does. Upstream measured the int64 form at 3.5 to 6 % of throughput. The offset form adds no operation and measures within noise, so it is worth bringing back here, and a sync must not resolve that conflict by keeping both. Upstream #1602 makes SIMD follow scalar as the fork does, and says plainly that float_adm is closer to the unwrapped vector value, so the wrap is an artefact of the scalar reference; if upstream removes the int16 cast instead, the fork's #1474 needs revisiting.

Three docs/state.md rows now cite the upstream pull request carrying their fix. The Netflix#1109 row records that the reporter's clips return 404 and that the frame-alignment diagnosis lived only in the fork's own docs, so there is nothing to retract upstream.

One correction is recorded against the fork's own upstream work: #1589 as first submitted appended four values to the pooling enum while upstream's report writers index a four-entry name table, so every report's pooled_metrics got garbage keys. The fork has that guard; it was lost in the adaptation, and the first round validated with unit tests but never ran the tool. Corrected upstream on 2026-09-19.

Type

  • docs — documentation only

Checklist

  • Commits follow Conventional Commits (the commit-msg hook enforces this).
  • make format && make lint is green locally.
  • I did not modify any assertAlmostEqual(...) score in the Netflix golden Python tests.
  • docs/state.md updated in this PR: three rows now cite the upstream pull request that carries their fix.

Deep-dive deliverables (ADR-0108)

  • Research digest — no digest needed: trivial. The evidence is the engagement ledger this summarises, kept out of tree under .workingdir/evidence/.
  • Decision matrix — no alternatives: only-one-way fix. Recording what exists upstream is not a choice between designs.
  • AGENTS.md invariant note — carried in docs/rebase-notes.md, the cross-package invariant index the harness imports; it names the files whose conflicts this changes.
  • Reproducer / smoke-test command — below.
  • CHANGELOG fragment — changelog.d/changed/upstream-pr-links.md.
  • Rebase note — docs/rebase-notes.md.

Reproducer

python3 -m mkdocs build --strict
bash scripts/ci/check-state-md-rows.sh

Every upstream pull request number in the new section resolves to an open pull request on Netflix/vmaf.

Known follow-ups

Eight pull requests are open upstream and nothing in the tree said so, which
matters at the next sync: two of them fix the same bug a fork PR fixes, and one
fixes it a different way. Upstream #1601 starts the 16-bit DWT sum from the
normalization offset instead of widening the accumulator to int64 as the fork's
#1477 does, because the int64 form costs 3.5 to 6 % of throughput upstream. That
approach is worth bringing back here, and a merge must not keep both.

docs/development/known-upstream-bugs.md gains the list, each entry tied to the
fork's own bug id, plus six upstream defects found while validating and not
reported, so the fork does not rediscover them. Three docs/state.md rows cite
the upstream pull request carrying their fix; the Netflix#1109 row records that
the reporter's clips now return 404 and that nothing was asserted upstream, so
there is nothing to retract.

No CI has run on any of the eight: every workflow upstream waits on a
maintainer approving a first-time contributor's run.
@github-actions github-actions Bot added the type:docs Documentation updates label Sep 19, 2026
@lusoris
lusoris merged commit 22af6e7 into master Sep 19, 2026
72 checks passed
@lusoris
lusoris deleted the docs/upstream-pr-links branch September 19, 2026 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs Documentation updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant