Repository navigation
docs: document the Stabilize pitch factor file format - #163
Merged
Merged
Conversation
The format of the per-frame factor file for Stabilize's "From File" pitch mode was only described in CLAUDE.md and code comments, and a user had to ask for it on PR #152. docs/PITCH_FACTOR_FILES.md now covers where the file goes (sidecar names), both line forms, the validation rules, and what a factor means, including when to tick "Factors Are Corrections". The README's Stabilize row links to it; CLAUDE.md lists it and says to keep it in step with the parser. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
The format of Stabilize's per-frame pitch factor file wasn't documented anywhere users would see it. It was only in CLAUDE.md and code comments, and a user had to ask for it on #152 (comment).
docs/PITCH_FACTOR_FILES.md(new): where the file goes and the sidecar names picked up automatically, both line forms (bare factors, orframe,factor), the validation rules, and what a factor means. That includes when to tick Factors Are Corrections, which a log written for the script proposed in Film frame size stabilizer #150 needs.README.md: the Stabilize row of the pipeline table links to the new doc.CLAUDE.md: adds the new doc to thedocs/listing, and adds a Stabilize rule to keep it in step withparse_pitch_factors,PitchFactorFile.sidecarCandidatesandinvertFactors.Every detail was checked against the merged parser (
worker/src/models/stabilize_parameters.rs),stabilize.pyand the Stabilize schema's labels.Testing
Docs only.
readme_pipeline_order_test.dartreads only each table row's number and pass name, and neither changed. I didn't run it, because Flutter isn't on PATH in this environment.🤖 Generated with Claude Code