Skip to content

Conversation

@crypdick
Copy link
Contributor

Why are these changes needed?

The audio tutorial is flaky: sometimes it runs to completion, sometimes it doesn't.

Related issue number

NA

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>
Copilot AI review requested due to automatic review settings June 18, 2025 20:48
@crypdick crypdick requested a review from a team as a code owner June 18, 2025 20:48
@crypdick crypdick added do-not-merge Do not merge this PR! docs An issue or change related to documentation labels Jun 18, 2025
@crypdick crypdick marked this pull request as draft June 18, 2025 20:48
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 aims to resolve flakiness in the e2e audio tutorial by modifying configuration values in the notebook example.

  • Updated the value of "guided_decoding_backend" from "auto" to "xgrammar"
  • Adjusted configuration in the README notebook to improve tutorial stability
Comments suppressed due to low confidence (1)

doc/source/ray-overview/examples/e2e-audio/README.ipynb:289

  • Verify that 'xgrammar' is supported by downstream components and is intended for use here. If it's experimental or subject to change, consider adding documentation notes on its usage.
    "        \"guided_decoding_backend\": \"xgrammar\",\n",

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>
@crypdick crypdick changed the title [Docs][wip] Fix issues with e2e audio tutorial [Docs] Fix issues with e2e audio tutorial Jun 18, 2025
@crypdick crypdick added go add ONLY when ready to merge, run all tests and removed do-not-merge Do not merge this PR! labels Jun 18, 2025
@crypdick crypdick marked this pull request as ready for review June 18, 2025 23:41
@crypdick
Copy link
Contributor Author

Tested both the release tests and ran the notebook manually to confirm the fix

Copy link
Contributor

@angelinalg angelinalg left a comment

Choose a reason for hiding this comment

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

stamp

@angelinalg angelinalg merged commit 701777b into master Jun 19, 2025
6 checks passed
@angelinalg angelinalg deleted the docs/audio-fixes branch June 19, 2025 04:19
minerharry pushed a commit to minerharry/ray that referenced this pull request Jun 27, 2025
elliot-barn pushed a commit that referenced this pull request Jul 2, 2025
Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs An issue or change related to documentation go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants