Update chat template docs and bump Jinja version #31455
Merged
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
amyeroberts
approved these changes
Jun 17, 2024
| @@ -441,8 +441,8 @@ def compile_jinja_template(template): | |||
| except ImportError: | |||
| raise ImportError("template requires jinja2 to be installed.") | |||
|
|
|||
| if version.parse(jinja2.__version__) <= version.parse("3.0.0"): | |||
| raise ImportError("template requires jinja2>=3.0.0 to be installed. Your version is " f"{jinja2.__version__}.") | |||
| if version.parse(jinja2.__version__) < version.parse("3.1.0"): | |||
There was a problem hiding this comment.
Does this match with jinja specified in the library e.g. setup.py?
There was a problem hiding this comment.
We don't actually make Jinja a library requirement - chat templates were a somewhat peripheral feature, so I didn't want to add an forced dependency for them at first, plus they're already a dependency for torch.
However, given that they're becoming a lot more core, maybe I should consider doing that in a separate PR!
xenova
approved these changes
Jun 17, 2024
docs/source/en/chat_templating.md
Outdated
|
|
||
| By default, Jinja will print any whitespace that comes before or after a block. This can be a problem for chat | ||
| templates, which generally want to be very precise with whitespace! To avoid this, we strongly recommend writing | ||
| your templates with `{{-` and `{%-` blocks instead of `{{` and `{%`. This will strip any whitespace that comes |
There was a problem hiding this comment.
Mentioned above in the Tip already, but not opposed to having it mentioned again!
There was a problem hiding this comment.
Yep, I know it went in twice - at least that one was deliberate!
|
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. |
Co-authored-by: Joshua Lochner <admin@xenova.com>
Co-authored-by: Joshua Lochner <admin@xenova.com>
Co-authored-by: Joshua Lochner <admin@xenova.com>
Rocketknight1
force-pushed
the
chat_template_doc_update
branch
from
693e77e to
ee919ec
Compare
itazap
pushed a commit
that referenced
this pull request
Jun 18, 2024
* Update chat template docs * Minor bug in the version check * Update docs/source/en/chat_templating.md Co-authored-by: Joshua Lochner <admin@xenova.com> * Update docs/source/en/chat_templating.md Co-authored-by: Joshua Lochner <admin@xenova.com> * Update docs/source/en/chat_templating.md Co-authored-by: Joshua Lochner <admin@xenova.com> * Replace backticks with bolding because the doc builder was trying to parse them * Replace backticks with bolding because the doc builder was trying to parse them * Replace backticks with bolding because the doc builder was trying to parse them * More cleanups to avoid upsetting the doc builder * Add one more tip at the end --------- Co-authored-by: Joshua Lochner <admin@xenova.com>
itazap
pushed a commit
that referenced
this pull request
Jun 20, 2024
* Update chat template docs * Minor bug in the version check * Update docs/source/en/chat_templating.md Co-authored-by: Joshua Lochner <admin@xenova.com> * Update docs/source/en/chat_templating.md Co-authored-by: Joshua Lochner <admin@xenova.com> * Update docs/source/en/chat_templating.md Co-authored-by: Joshua Lochner <admin@xenova.com> * Replace backticks with bolding because the doc builder was trying to parse them * Replace backticks with bolding because the doc builder was trying to parse them * Replace backticks with bolding because the doc builder was trying to parse them * More cleanups to avoid upsetting the doc builder * Add one more tip at the end --------- Co-authored-by: Joshua Lochner <admin@xenova.com>
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.
This PR makes some updates to the chat template docs. Specifically, I put much more emphasis on using trimming blocks like
{{-and{%-to let you write neater, indented code, and I also add a section on making your template compatible with non-Python implementations of Jinja. This PR also bumps the minimum Jinja version to 3.1, which is the earliest version that supports the filters we recommend in these docs (and have started to use in our templates), such as|items.