Skip to content

docs: clarify Demucs segment size help - #307

Open
be-student wants to merge 3 commits into
nomadkaraoke:mainfrom
be-student:codex/246-demucs-segment-help
Open

docs: clarify Demucs segment size help#307
be-student wants to merge 3 commits into
nomadkaraoke:mainfrom
be-student:codex/246-demucs-segment-help

Conversation

@be-student

@be-student be-student commented Sep 6, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown

Closes #246.

The Demucs segment-size help now explains that values are seconds, identifies Default as the model-configured length, and uses a valid 40-second example. The README snapshot and argparse source are updated together, with a regression check covering both.

Validation: all 550 unit tests pass (4 skipped); focused regression, compile, diff, and changed-hunk formatting checks pass. The repository's whole-file Black check remains noisy on the same two pre-existing files.

Summary by CodeRabbit

  • Documentation

    • Clarified that Demucs segment size is specified in seconds, within the supported range of 1–100 seconds.
    • Noted that smaller values use less memory.
    • Documented that Default uses the model-configured segment length.
    • Updated the example segment size to 40 seconds.

  • Tests

    • Added coverage to verify the CLI help text and README remain consistent.

@coderabbitai

coderabbitai Bot commented Sep 6, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: d1db7b29-edf1-471b-aa91-639a0c3ec9dc

📥 Commits

Reviewing files that changed from the base of the PR and between a7b159a and ce84f44.

📒 Files selected for processing (1)
  • tests/unit/test_cli.py
🚧 Files skipped from review as they are similar to previous changes (1)
  • tests/unit/test_cli.py

Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.

Walkthrough

The Demucs segment-size documentation now uses seconds, explains memory usage and the model-configured default, and replaces the invalid example. A unit test verifies consistency between CLI help and README.md.

Changes

Demucs segment-size documentation

Layer / File(s) Summary
Align segment-size help and documentation
audio_separator/utils/cli.py, README.md, tests/unit/test_cli.py		 The CLI help and README now describe segment size in seconds, note that smaller values use less memory, and document Default as the model-configured segment length. The test checks the CLI output and README text. Additional test docstrings describe existing test behavior.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other · Severity of issue fixed: Low

Merge Risk: ⚪ Minimal · up to ce84f

The documentation and CLI-help alignment change has no identified merge-blocking risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: clarifying Demucs segment-size help in the README and CLI.
Linked Issues check ✅ Passed Issue #246 requires a defined default and an example within the documented 1–100 range. The PR updates README.md and argparse help to state that Default uses the model-configured segment length, ide…
Out of Scope Changes check ✅ Passed The changes remain within issue #246. README and CLI help changes implement the clarification. The test changes verify both documentation locations and the CLI output. The added Path import and test…
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 2 files.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

A rabbit reads the help text bright
Segment seconds now fit just right
Smaller slices save memory
Default follows the model’s decree
The README and tests agree

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

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

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Confusing info in README

1 participant

@be-student