Skip to main content

Bantam language model core

Project description

Bantam

Bantam is a configurable decoder-only transformer packaged with a CLI for tokenizer training, pre-training, SFT, and chat inference. It runs on pure PyTorch (torch>=2.1) and uses the scaled-dot-product/FlashAttention stack for grouped-query attention, sliding windows, and sink tokens without custom kernels.

Key Features

  • Flex-attention based GQA with optional sliding windows and sink tokens.
  • Per-layer overrides let you mix head counts, windows, sinks, and MoE routing per block via layer_configs.
  • SwiGLU dense blocks or Switch/Top-k MoE with router/aux loss controls.
  • Rotary embeddings with linear, NTK, and YaRN-style scaling.
  • Regex-aware BPE trainer (bantam-cli trainbpe) that isolates punctuation, chunks long numbers, and optionally prefills 0–N.
  • Unified CLI for model init, pre-training, SFT (full or LoRA), resume, and chat streaming.

Installation

python3 -m pip install bantam-cli

CLI Quick Start

bantam-cli --help          # list commands

# Train a tokenizer from JSONL
bantam-cli trainbpe --input data/pretrain.jsonl --out tokenizers/run1

# Generate starter configs (model + train + SFT)
bantam-cli define --out configs

# Initialise a model directory from split configs
bantam-cli init --mconf configs/models/pretrain_small.yaml --config configs/training/pretrain_small.yaml --out models/bantam-init

# Launch pre-training run
bantam-cli pretrain --mconf configs/models/pretrain_small.yaml --config configs/training/pretrain_small.yaml

# Resume a checkpointed run (model config auto-detected)
bantam-cli continue-pretrain --config configs/training/pretrain_small.yaml --model models/run1/checkpoints/step_20000

# Supervised fine-tuning (LoRA or full)
bantam-cli sft --config configs/training/sft_small.yaml --model models/bantam-init

# Chat with a trained checkpoint (pretrain format by default)
bantam-cli chat --model models/run1/best

# base model inference
bantam-cli chat --model Theoistic/Bantam-285m

# Conversational chat retaining the last two turns
bantam-cli chat --model Theoistic/Bantam-285m-Instruct --format chat --history-turns 2

Model configs live under configs/models/ with a bantam_config block. Training/SFT configs live under configs/training/ with training_args, optional sft_args, and a run seed. Relative paths resolve against the YAML file location.

Example per-layer tweak:

bantam_config:
  hidden_size: 1024
  num_hidden_layers: 12
  num_attention_heads: 16
  num_key_value_heads: 4
  layer_configs:
    - { window: 2048, num_attention_sinks: 2 }
    - { expert_type: switch, num_experts: 8, moe_capacity_factor: 1.0 }

More Info

Report issues or ideas via GitHub. Enjoy experimenting with Bantam!

LLaMAFactory Integration

You can fine-tune Bantam models with LLaMAFactory once bantam-cli is installed

you need to register the architecture in LLaMA-Factory/src/llamafactory/cli.py

import bantam  # lazy imports
import bantam.tokenization_bantam  # registers BantamFastTokenizer with AutoTokenizer
import bantam.modeling_bantam      # registers config/model with AutoConfig/AutoModel

and add this somewhere in the bottom of LLaMA-Factory/src/llamafactory/data/template.py

register_template(
    name="bantam_chat",
    format_user=StringFormatter(
        slots=["<|USER_START|>{{content}}<|USER_END|><|AGENT_START|>"]
    ),
    format_assistant=StringFormatter(slots=["{{content}}<|AGENT_END|>"]),
    format_system=StringFormatter(slots=["<|SYSTEM_START|>{{content}}<|SYSTEM_END|>"]),
    format_prefix=EmptyFormatter(slots=[{"bos_token"}]),
    stop_words=["<|AGENT_END|>", "<|EOS|>"],
    replace_eos=False,
)
  • Use --template bantam_chat in LLaMAFactory for both SFT and preference/DPO runs.
  • The template leaves user turns in-place but only supervises the assistant span (mirrors Bantam’s mask_user_queries=true default).
  • Set include_agent_end=true and include_eos=true in your Bantam SFT config so completions end with <|AGENT_END|><|EOS|>, giving the stop tokens above reliable cut points.
  • For LoRA vs. full SFT, follow LLaMAFactory’s standard CLI flags—Bantam checkpoints expose all weights so “full” fine-tunes work out of the box.

After training, export the adapter or merged weights from LLaMAFactory and load them with bantam-cli chat --model <path> to validate generations.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bantam_cli-0.1.3.tar.gz (66.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bantam_cli-0.1.3-py3-none-any.whl (63.9 kB view details)

Uploaded Python 3

File details

Details for the file bantam_cli-0.1.3.tar.gz.

File metadata

  • Download URL: bantam_cli-0.1.3.tar.gz
  • Upload date:
  • Size: 66.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for bantam_cli-0.1.3.tar.gz
Algorithm Hash digest
SHA256 4343dc7ca2c0679c278e80910cddc476959752fe5924dfb19aa42911f0058db6
MD5 ff4c06566885a447eb8b52bdd1e12246
BLAKE2b-256 0a2d50f0fc9c6f69902eae1abb1b7e832146ace2e87e544c4a951376a0b3f2e8

See more details on using hashes here.

File details

Details for the file bantam_cli-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: bantam_cli-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 63.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for bantam_cli-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c56a0cb173cf37576829819713274656ff427b7a4d7cbb8b856c7d2076af2046
MD5 cb82cfb319deec799ceaae93609864c7
BLAKE2b-256 60a52a5d7f8d62c0ed2487af324947b71b76adc7d691de9c70e58e6e941480e1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page