Metadata-Version: 2.4
Name: chat-bricks
Version: 0.1.2
Summary: A helper library for LLM/VLM chat templates.
License: MIT
Keywords: chat,template
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: transformers
Provides-Extra: docs
Requires-Dist: mkdocs>=1.6; extra == "docs"
Requires-Dist: mkdocs-material>=9.5; extra == "docs"
Requires-Dist: mkdocs-git-revision-date-localized-plugin>=1.2; extra == "docs"
Requires-Dist: mkdocs-git-authors-plugin>=0.7; extra == "docs"
Requires-Dist: mkdocs-macros-plugin>=1.2; extra == "docs"
Requires-Dist: mkdocstrings[python]>=0.27; extra == "docs"
Requires-Dist: mkdocs-autorefs>=1.0; extra == "docs"
Requires-Dist: mike>=2.1; extra == "docs"

# 🧩 Chat Bricks

*Jinja Template is Not You Need!*

Chat Bricks is a powerful and flexible template system inspired by building block toys, designed to support various LLM and VLM chat templates for training and inference.

## Key Features

- **Training and Inference**: Chat template formatted prompts, with tokenized inputs and masks.
- **Modular design**: Templates are built from configurable components.
- **Multi-modal support**: Built-in vision-language templates.
- **Jinja template generation**: Automatic HuggingFace-compatible template generation.
- **HuggingFace Integration**: Directly supports using an HF repo id as template.
- **Advanced configuration**: Fine-grained control over template behavior.

## Installation

```bash
pip install chat-bricks
```


## Quick Start

### Basic Usage

Create a chat object with a built-in template and render the prompt:

```python
from chat_bricks import Chat

# Create a chat object with template and messages
chat = Chat(
    template="qwen3",
    messages=[
        {"role": "user", "content": "Hello, how are you?"},
        {"role": "assistant", "content": "I am fine, thank you."}
    ],
)

# Render the final prompt
prompt = chat.prompt()
print(prompt)
```

### Tokenization for Training/Inference

You can easily tokenize messages for model input:

```python
from transformers import AutoTokenizer
from chat_bricks import Chat

tokenizer = AutoTokenizer.from_pretrained("Qwen/Qwen2.5-3B-Instruct")
chat = Chat(template="qwen2.5", messages=[{"role": "user", "content": "Hello!"}])

inputs = chat.tokenize(
    tokenizer,
    add_generation_prompt=True,  # keep generation token for inference
)

print(inputs["input_ids"])
```

### Custom Templates

Define your own template format using the `Template` class:

```python
from chat_bricks import Chat, Template

custom = Template(
    name="my-template",
    system_template="<|im_start|>system\n{system_message}<|im_end|>\n",
    system_message="You are a concise assistant.",
    user_template="<|im_start|>user\n{content}<|im_end|>\n",
    assistant_template="<|im_start|>assistant\n{content}<|im_end|>\n",
    stop_words=["<|im_end|>"],
)

chat = Chat(template=custom, messages=[{"role": "user", "content": "Hi!"}])
print(chat.prompt())
```

### Using HuggingFace Repo ID as Template

You can directly use any HuggingFace model repository ID as a template. Chat Bricks will automatically load the tokenizer's chat template:

```python
from chat_bricks import Chat

# Use a HuggingFace repo id directly
chat = Chat(
    template="Qwen/Qwen2.5-3B-Instruct",
    messages=[
        {"role": "user", "content": "Hello, how are you?"},
        {"role": "assistant", "content": "I am fine, thank you."}
    ],
)

# Render the prompt using the model's native chat template
prompt = chat.prompt()
print(prompt)
prompt_with_mask = chat.prompt_with_mask()
print(prompt_with_mask)

# Tokenize with proper masking for training
from transformers import AutoTokenizer
tokenizer = AutoTokenizer.from_pretrained("Qwen/Qwen2.5-3B-Instruct")
inputs = chat.tokenize(tokenizer, add_generation_prompt=True)
```

This feature automatically detects if the repo ID is not a built-in template and creates an `HFTemplate` that uses the tokenizer's chat template. It supports tools, generation prompts, and proper masking for training. See the [HuggingFace Templates Guide](docs/how_to_use/huggingface_templates.md) for more details.

## Documentation

For full documentation, please visit our [docs](docs/index.md) (or run `mkdocs serve` locally).

## Community

| WeChat | Discord |
| :---: | :---: |
|  
 Scan to join wechat group |  
 [Join our discord channel](https://discord.gg/Ze5Z9QhhJ3) |
