Skip to content

docs: update CLAUDE.md and AUDIO.md to match current code - #143

Merged
aviv1ron1 merged 2 commits into
generative-computing:mainfrom
samadarsh:claude/dreamy-bardeen-aovoj2
Oct 11, 2026
Merged

aviv1ron1 merged 2 commits into
generative-computing:mainfrom
samadarsh:claude/dreamy-bardeen-aovoj2

Conversation

@samadarsh

Copy link
Copy Markdown
Contributor

Summary

Two docs had drifted from the code.

CLAUDE.md still described the removed SingleSwitch:

  • The project tree listed hf/switch/single.py and vllm/switch/single.py; it now lists multi.py, hf/switch/codes/, conversation.py, token_exchange.py, vllm/audio/ and tests/audio/.
  • The import example and test commands pointed at SingleSwitch files that no longer exist; they now use MultiSwitch / test_multi_switch.py.
  • The "Optional Trainable Router (SingleSwitch)" section now describes the coded-memory MultiSwitch (the only engine since Refactor/multiswitch only and conversation ids #131) and links docs/MULTISWITCH_EXPLAINED.md.
  • uv sync --extra dev fails because dev is a dependency group, so it is now uv sync --group dev.
  • Dropped the nonexistent tests/regression/ entry.

docs/AUDIO.md said transformers>=5.16 was not pinned yet. The package has required it since #130, so the note now says a normal install already has it, and keeps the ImportError fallback note for older installs.

Testing

Docs only. Pre-commit hooks (including the link validator) pass on both files.

CLAUDE.md still described the removed SingleSwitch: the project tree listed
hf/switch/single.py and vllm/switch/single.py, the import example and test
commands pointed at SingleSwitch files that no longer exist, and the
architecture section described a trainable router. It now reflects the
coded-memory MultiSwitch (the only engine since generative-computing#131), links
docs/MULTISWITCH_EXPLAINED.md, and lists conversation.py, token_exchange.py,
hf/switch/codes/, vllm/audio/ and tests/audio/. The dev install command used
`--extra dev`, but `dev` is a dependency group, so it is now `--group dev`;
the nonexistent tests/regression/ entry is dropped.

docs/AUDIO.md said transformers>=5.16 was not pinned yet. The package has
required it since generative-computing#130, so the caveat now says a normal install already has
it and keeps the ImportError fallback note for older installs.

Signed-off-by: samadarsh <samadarsh14@gmail.com>
@samadarsh
samadarsh force-pushed the claude/dreamy-bardeen-aovoj2 branch from f45fdce to b9e9495 Compare October 9, 2026 10:41
The overview still listed "optional trainable switching" with a router, the
adapter section said adapters are "router-selected", and the test-directory
list still named tests/regression/, which does not exist. MultiSwitch has
no trainable router: it derives the per-token adapter index from the
control tokens. The test list now names tests/audio/ instead.

Signed-off-by: samadarsh <samadarsh14@gmail.com>
@samadarsh
samadarsh force-pushed the claude/dreamy-bardeen-aovoj2 branch from 4a74b97 to f040fe7 Compare October 9, 2026 11:40
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@aviv1ron1 aviv1ron1 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for the cleanup — we'll follow up separately with some remaining stale hiding-group content

@aviv1ron1
aviv1ron1 merged commit 86bc033 into generative-computing:main Oct 11, 2026
4 checks passed
@samadarsh
samadarsh deleted the claude/dreamy-bardeen-aovoj2 branch October 11, 2026 10:17
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.

3 participants