Skip to content

docs: add docstrings to ChatFormat class and its constructor #379

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.

Sign up for GitHub

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

Open
mshsheikh wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −0
Open

docs: add docstrings to ChatFormat class and its constructor #379

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions models/llama4/chat_format.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,12 @@ def convert_image_to_rgb(image: PIL_Image.Image, bg: Tuple[int, int, int] = (255


class ChatFormat:
"""
Encodes and decodes chat messages (with optional vision support) into token sequences.

This class helps prepare chat messages (text + images) to be sent into the model,
and it can also decode model responses back into readable messages.
"""
possible_headers: Dict[Role, str]

def __init__(
Expand All @@ -68,6 +74,14 @@ def __init__(
vision_args: Optional[VisionArgs] = None,
max_num_chunks: int = 16,
):
"""
Create a new ChatFormat instance.

Args:
tokenizer: A tokenizer used to turn text into tokens.
vision_args: Settings for image handling (optional).
max_num_chunks: Max number of image tiles allowed.
"""
self.tokenizer = tokenizer
self.vision_args = vision_args
self.max_num_chunks = max_num_chunks
Expand Down