docs(voxtral_realtime): simplify and reorganize README#18186
docs(voxtral_realtime): simplify and reorganize README#18186mergennachin merged 1 commit intomainfrom
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/18186
Note: Links to docs will display an error until the docs builds have been completed. ⏳ No Failures, 41 PendingAs of commit 407996a with merge base 1b0c10b ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
This PR needs a
|
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the Voxtral Realtime example README to reduce duplication and make streaming the default workflow across export and runtime instructions, while keeping non-default backends tucked away for readability.
Changes:
- Reordered the “modes” explanation and updated examples to default to streaming (
--streaming) with offline as an opt-out. - Simplified export instructions to one example per backend, collapsing Metal/CUDA/CUDA-Windows behind
<details>sections. - Restored a Linux/macOS “Basic usage” run example and moved Windows commands into a dedicated subsection.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
ca2e515 to
9ba260d
Compare
Reduce duplication by showing one export/run example per backend instead of separate offline and streaming blocks. Make streaming the default mode in all examples. Collapse non-default backends (Metal, CUDA, CUDA-Windows) behind <details> tags in the Export section. Restore the Linux/macOS run example that was accidentally replaced by Windows-only commands in 1b0c10b.
9ba260d to
407996a
Compare
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the Voxtral Realtime README to reduce duplicated instructions while making streaming the default across examples, and restores a Linux/macOS run example that had been replaced by Windows-only commands.
Changes:
- Reorders the mode explanation and standardizes all examples to streaming by default, with offline guidance via “omit
--streaming”. - Collapses non-default backend export examples (Metal/CUDA/CUDA-Windows) behind
<details>blocks. - Updates build/run sections to present a basic POSIX usage path plus a focused Windows PowerShell example.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Reduce duplication by showing one export/run example per backend instead
of separate offline and streaming blocks. Make streaming the default mode
in all examples. Collapse non-default backends (Metal, CUDA, CUDA-Windows)
behind details tags in the Export section. Restore the Linux/macOS run
example that was accidentally replaced by Windows-only commands in
1b0c10b.