OpenAIToMessages

class torchtune.data.OpenAIToMessages(train_on_input: bool = False, column_map: Optional[Dict[str, str]] = None, new_system_prompt: Optional[str] = None)

将符合 OpenAI 聊天完成 JSON 结构的单个聊天样本转换为 torchtune 的 Message 结构。这支持文本和图像消息。

单个样本通常包含单个可选的系统提示以及一轮或多轮用户和助手消息。

例如

{
    "messages": [
        {
            "role": <system|user|assistant>,
            "content": [
                {
                    "type": "text",
                    "text": "What'''s in this image?",
                },
                {
                    "type": "image_url",
                    "image_url": {
                        "url": <url>,
                    },
                },
        },
        ...
    ]
}

Message 遵循

[
    {
        "role": <system|user|assistant>,
        "content": [
            {
                "type": "text",
                "content": "What'''s in this image?",
            },
            {
                "type": "image",
                "content": <PIL.Image.Image>,
            },
        ],
    },
    ...
]

参数:

• train_on_input (bool) – 提示是否应保持未屏蔽状态。默认值：False

• column_map (Optional[Dict[str, str]]) – 从预期列 (“messages”) 到数据集中的新列名的映射。键应为 “messages”，值应为新列名。如果为 None，则保留默认的 “messages”。默认值为 None。

• new_system_prompt (Optional[str]) – 如果指定，则预先添加系统消息。这可以用作指导模型响应的指令。设置此项将覆盖数据集中已存在的任何系统消息。默认值为 None。

Raises:

ValueError – 如果提供了 column_map 并且 messages 不在 column_map 中。