[Doc] Emphasize the importance of the prompts and update BatchGrammarMatcher. #468
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Yuchuan <[email protected]>
Seven-Streams
force-pushed
the
docs/2025-11-04/emph_prompt
branch
from
0a6c982 to
3127e00
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR adds a best practices notice to the Quick Start documentation, recommending that users describe the expected output structure in their prompts when using constrained decoding.
- Adds a new section highlighting the importance of prompt engineering when using constrained decoding
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Ubospica
approved these changes
Nov 7, 2025
Signed-off-by: Yuchuan <[email protected]>
Signed-off-by: Yuchuan <[email protected]>
Seven-Streams
force-pushed
the
docs/2025-11-04/emph_prompt
branch
from
e1c7804 to
fcf3828
Compare
Signed-off-by: Yuchuan <[email protected]>
Seven-Streams
force-pushed
the
docs/2025-11-04/emph_prompt
branch
from
fcf3828 to
bcd8ca8
Compare
Seven-Streams
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The PR emphasizes the importance of describing the constraint in the prompts. It adds a notice about it in the
Quick Startsection, and adds the introduction toBatchGrammarMatcher.