Skip to content

Commit 9e2c9c0

Browse files
ebsmothersjoecummings
authored andcommitted
update chat format docstrings (#769)
1 parent 7003fb3 commit 9e2c9c0

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

torchtune/data/_chat_formats.py

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,15 @@ class Llama2ChatFormat(ChatFormat):
4747
repository <https://github.com/meta-llama/llama/blob/main/llama/generation.py>`_.
4848
4949
Example:
50-
"[INST] <<SYS>>
51-
You are a helpful, respectful and honest assistant.
52-
<</SYS>>
50+
.. code-block:: text
51+
52+
"[INST] <<SYS>>
53+
You are a helpful, respectful and honest assistant.
54+
<</SYS>>"
55+
56+
I am going to Paris, what should I see? [/INST] Paris, the capital of France, is known for its stunning architecture..."
57+
5358
54-
I am going to Paris, what should I see? [/INST] Paris, the capital of France, is known for its stunning architecture..."
5559
"""
5660

5761
B_INST, E_INST = "[INST]", "[/INST]"
@@ -110,8 +114,10 @@ class MistralChatFormat(ChatFormat):
110114
prompts.
111115
112116
Example:
113-
"[INST] I am going to Paris, what should I see? [/INST] Paris, the capital
114-
of France, is known for its stunning architecture..."
117+
.. code-block:: text
118+
119+
"[INST] I am going to Paris, what should I see? [/INST] Paris, the capital
120+
of France, is known for its stunning architecture..."
115121
116122
"""
117123

@@ -162,7 +168,7 @@ def format(
162168
class ChatMLFormat(ChatFormat):
163169
"""
164170
OpenAI's `Chat Markup Language
165-
<https://github.com/MicrosoftDocs/azure-docs/blob/main/articles/ai-services/openai/includes/chat-markup-language.md>`_
171+
<https://github.com/MicrosoftDocs/azure-docs/blob/772c14eeabfa0c0c561d5c2d34ef19341f528b7b/articles/ai-services/openai/how-to/chat-markup-language.md>`_
166172
used by their chat models.
167173
168174
It is the default chat format used by HuggingFace models.

0 commit comments

Comments
 (0)