Skip to content

docs(voxtral_realtime): simplify and reorganize README#18186

Merged
mergennachin merged 1 commit intomainfrom
update_voxtral_readme
Mar 15, 2026
Merged

docs(voxtral_realtime): simplify and reorganize README#18186
mergennachin merged 1 commit intomainfrom
update_voxtral_readme

Conversation

@mergennachin
Copy link
Contributor

@mergennachin mergennachin commented Mar 15, 2026

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.

@mergennachin mergennachin requested a review from lucylq as a code owner March 15, 2026 00:43
Copilot AI review requested due to automatic review settings March 15, 2026 00:43
@pytorch-bot
Copy link

pytorch-bot bot commented Mar 15, 2026

🔗 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 Pending

As of commit 407996a with merge base 1b0c10b (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@meta-cla meta-cla bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Mar 15, 2026
@github-actions
Copy link

This PR needs a release notes: label

If your change should be included in the release notes (i.e. would users of this library care about this change?), please use a label starting with release notes:. This helps us keep track and include your important work in the next release notes.

To add a label, you can comment to pytorchbot, for example
@pytorchbot label "release notes: none"

For more information, see
https://github.com/pytorch/pytorch/wiki/PyTorch-AutoLabel-Bot#why-categorize-for-release-notes-and-how-does-it-work.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@mergennachin mergennachin force-pushed the update_voxtral_readme branch from ca2e515 to 9ba260d Compare March 15, 2026 00:51
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.
Copilot AI review requested due to automatic review settings March 15, 2026 00:55
@mergennachin mergennachin force-pushed the update_voxtral_readme branch from 9ba260d to 407996a Compare March 15, 2026 00:55
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@mergennachin mergennachin merged commit 5545395 into main Mar 15, 2026
155 checks passed
@mergennachin mergennachin deleted the update_voxtral_readme branch March 15, 2026 01:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants