Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add LLMs chat template documentation for end-users #782

Merged
merged 3 commits into from
Dec 17, 2024

Conversation

rudrakshkarpe
Copy link
Contributor

@rudrakshkarpe rudrakshkarpe commented Dec 16, 2024

Reason for Change:

Requirements:

  • Starting from transformers version 4.42, a chat template must be provided for chatting service. It's a low-level configuration file in jinja format that defines the constraints for chat message input.
  • Hugging Face reference -
  • This PR explains these rules to end users in a simplified natural language.

Issue Fixed:
Fixes: #661

Notes for Reviewers:

  • This is my very first contribution to the Kaito project 🤗. Please let me know your thoughts on this documentation and how we can further streamline it for Kaito end users.
  • CC: @zhuangqh @sdesai345

@rudrakshkarpe rudrakshkarpe changed the title Add LLMs chat template documentation for end-users docs: add LLMs chat template documentation for end-users Dec 16, 2024
Copy link
Collaborator

@zhuangqh zhuangqh left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution!

@zhuangqh zhuangqh merged commit 5d5e342 into kaito-project:main Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add document to explain chat template to end users
2 participants