Skip to content

docs: clarify internal default values for demucs segment_size#264

Open
Madduri-Ganesh wants to merge 2 commits intonomadkaraoke:mainfrom
Madduri-Ganesh:docs/clarify-demucs-sizing
Open

docs: clarify internal default values for demucs segment_size#264
Madduri-Ganesh wants to merge 2 commits intonomadkaraoke:mainfrom
Madduri-Ganesh:docs/clarify-demucs-sizing

Conversation

@Madduri-Ganesh
Copy link

@Madduri-Ganesh Madduri-Ganesh commented Mar 13, 2026

Fixes issue #246

Added a clarification to the documentation for the --demucs_segment_size parameter.

While the parameter defaults to the string "Default", it wasn't immediately clear what numerical values this maps to for the underlying architectures. After a codebase review, I've added a note explaining that:

"Default" maps to 40 for standard Demucs models.
"Default" maps to 10 for the newer Demucs v4/htdemucs architectures.

Summary by CodeRabbit

  • Documentation
    • Clarified the default behavior of the segment_size parameter and listed typical values for different Demucs model versions (e.g., older Demucs vs. Demucs v4/htdemucs). No functional or behavioral changes were made; this update is documentation-only.

@coderabbitai
Copy link

coderabbitai bot commented Mar 13, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 844b5967-2d27-4e5e-8163-fa577100a401

📥 Commits

Reviewing files that changed from the base of the PR and between 144514e and 628dc50.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

Walkthrough

README.md updated: demucs_params' segment_size "Default" description was augmented to note it uses the model's internal default, with typical values (40 for older Demucs, 10 for Demucs v4/htdemucs). No functional or public API changes.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added clarification to demucs_params.segment_size "Default" behavior and listed typical defaults (40 for older Demucs, 10 for Demucs v4/htdemucs).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A little note I hopped to write,
"Default" follows the model's light,
Forty or ten, it chooses the tune,
I nibble docs beneath the moon,
Hoppity hops — clarity soon! 🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title clearly and accurately summarizes the main change: documentation clarification for demucs segment_size default values.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can generate a title for your PR based on the changes.

Add @coderabbitai placeholder anywhere in the title of your PR and CodeRabbit will replace it with a title based on the changes in the PR. You can change the placeholder by changing the reviews.auto_title_placeholder setting.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 526: The inline emphasis in the README note for demucs_params uses
asterisks (*) which triggers MD049; update the emphasis around the parenthetical
note after `demucs_params` (the text containing `segment_size` and the model
defaults) to use underscores (_) instead of asterisks so `_Note: ..._` (or
`_..._`) wraps that portion; ensure you only change the inline emphasis
characters and preserve the existing text, backticks (e.g., `demucs_params`,
`segment_size`), and punctuation.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3eb6dc75-08b9-4459-90fc-503d34e2fd1d

📥 Commits

Reviewing files that changed from the base of the PR and between 12f8fc6 and 144514e.

📒 Files selected for processing (1)
  • README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant