Add a section on writing tool templates to the chat template docs #33924
Conversation
This file contains 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
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
pcuenca
approved these changes
Oct 4, 2024
docs/source/en/chat_templating.md
Outdated
| ``` | ||
|
|
||
| A common pattern for handling tools in chat templates would be something like this: |
There was a problem hiding this comment.
It is clear that these are examples and there's also a mention at the end, but maybe we can reinforce even more and explicitly state it here.
|
I'm happy with this now - merging without core maintainer review since it's a pure documentation change |
NielsRogge
pushed a commit
to NielsRogge/transformers
that referenced
this pull request
Oct 21, 2024
…ggingface#33924) * Add a section on writing tool templates to the chat template docs * Small cleanups
BernardZach
pushed a commit
to BernardZach/transformers
that referenced
this pull request
Dec 5, 2024
…ggingface#33924) * Add a section on writing tool templates to the chat template docs * Small cleanups
BernardZach
pushed a commit
to innovationcore/transformers
that referenced
this pull request
Dec 6, 2024
…ggingface#33924) * Add a section on writing tool templates to the chat template docs * Small cleanups
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 chat template docs have an extensive section on using tool templates, but they're missing good guidance to template authors. I added a section to help them, and also so there's a point of reference for the API we expect tool templates to follow.