From 9037892127cf01707cc92a4a242f79e3b9fbffa4 Mon Sep 17 00:00:00 2001 From: HanishKVC Date: Sat, 20 Apr 2024 23:42:25 +0530 Subject: [PATCH] ChatON: Add a note --- common/chaton.hpp | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/common/chaton.hpp b/common/chaton.hpp index b33027669..9616dea40 100644 --- a/common/chaton.hpp +++ b/common/chaton.hpp @@ -1,5 +1,21 @@ #pragma once +/** + * + * Provides a simple and dumb helpers which help chat with llm chat/instruct models + * using the chat template expected by them. + * + * Normally used to tag system prompt and user messages. + * Currently used by example/main programs. + * + * This builds on the llama_chat_apply_template. When adding support for new chat templates + * remember to update llama_chat_apply_template_internal as well as llama_chat_reverse_prompt. + * + * example/main program uses this when --chaton TEMPLATE_ID is passed to it along with -i + * sample TEMPLATE_ID's include chatml, llama2, llama3, ... + * + */ + #include #include