docs(build): note optional setup-deepfilter.sh prereq for local DFNR#4282
Open
ten9876 wants to merge 1 commit into
Open
docs(build): note optional setup-deepfilter.sh prereq for local DFNR#4282ten9876 wants to merge 1 commit into
ten9876 wants to merge 1 commit into
Conversation
CMake gates DFNR off with "library not found" when the prebuilt libdeepfilter isn't present. CI fetches it automatically (cached) in every build workflow, so this trips up only local dev builds. Document the one-time setup step (and Windows .ps1 variant) in the Build section. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Collaborator
|
Verified the factual claims directly rather than a full review pass, since there's no logic here to test -- this is docs-only:
Everything checks out, CI is green. Nothing to request changes on. One process note, not about this PR's content: this touches |
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
2 participants
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.
What
Adds a short note to the Build section of
AGENTS.mddocumenting the optionalscripts/setup/setup-deepfilter.shstep that enables DFNR (DeepFilterNet3) noise reduction for local dev builds.Why
On a clean checkout, CMake configure reports:
CI already runs this setup step automatically (cached) in every build workflow —
ci.yml,macos-dmg.yml,appimage.yml,windows-installer.yml— so release binaries always ship DFNR. The only gap was the local dev path, where the step was undocumented inAGENTS.md/README/CONTRIBUTINGand surfaced only via the configure message. This documents it (including the Windows.ps1variant) and clarifies NR still works without it via NR4 (libspecbleach).Docs-only; no code or CI changes.
🤖 Generated with Claude Code