Chess Challenge submission by hamonk

README.md

@@ -0,0 +1,26 @@
+---
+library_name: transformers
+tags:
+- chess
+- llm-course
+- chess-challenge
+license: mit
+---
+
+# chess-hamonk-v7
+
+Chess model submitted to the LLM Course Chess Challenge.
+
+## Submission Info
+
+- **Submitted by**: [hamonk](https://huggingface.co/hamonk)
+- **Parameters**: 874,368
+- **Organization**: LLM-course
+
+## Model Details
+
+- **Architecture**: Chess Transformer (GPT-style)
+- **Vocab size**: 113
+- **Embedding dim**: 128
+- **Layers**: 5
+- **Heads**: 4

config.json

@@ -0,0 +1,24 @@
+{
+  "architectures": [
+    "ChessForCausalLM"
+  ],
+  "auto_map": {
+    "AutoConfig": "model.ChessConfig",
+    "AutoModelForCausalLM": "model.ChessForCausalLM"
+  },
+  "bos_token_id": 1,
+  "dropout": 0.1,
+  "dtype": "float32",
+  "eos_token_id": 2,
+  "layer_norm_epsilon": 1e-05,
+  "model_type": "chess_transformer",
+  "n_ctx": 256,
+  "n_embd": 128,
+  "n_head": 4,
+  "n_inner": 384,
+  "n_layer": 5,
+  "pad_token_id": 0,
+  "tie_weights": true,
+  "transformers_version": "4.57.6",
+  "vocab_size": 113
+}

model.py

@@ -0,0 +1,438 @@
+"""
+Chess Transformer Model for the Chess Challenge.
+
+This module provides a simple GPT-style transformer architecture
+designed to fit within the 1M parameter constraint.
+
+Key components:
+- ChessConfig: Configuration class for model hyperparameters
+- ChessForCausalLM: The main model class for next-move prediction
+"""
+
+from __future__ import annotations
+
+import math
+from dataclasses import dataclass
+from typing import Optional, Tuple, Union
+
+import torch
+import torch.nn as nn
+import torch.nn.functional as F
+from transformers import PretrainedConfig, PreTrainedModel
+from transformers.modeling_outputs import CausalLMOutputWithPast
+
+
+class ChessConfig(PretrainedConfig):
+    """
+    Configuration class for the Chess Transformer model.
+    
+    This configuration is designed for a ~1M parameter model.
+    Students can adjust these values to explore different architectures.
+    
+    Parameter budget breakdown (with default values):
+    - Embeddings (vocab): 1200 x 128 = 153,600
+    - Position Embeddings: 256 x 128 = 32,768
+    - Transformer Layers: 6 x ~120,000 = ~720,000
+    - LM Head (with weight tying): 0 (shared with embeddings)
+    - Total: ~906,000 parameters
+    
+    Attributes:
+        vocab_size: Size of the vocabulary (number of unique moves).
+        n_embd: Embedding dimension (d_model).
+        n_layer: Number of transformer layers.
+        n_head: Number of attention heads.
+        n_ctx: Maximum sequence length (context window).
+        n_inner: Feed-forward inner dimension (default: 3 * n_embd).
+        dropout: Dropout probability.
+        layer_norm_epsilon: Epsilon for layer normalization.
+        tie_weights: Whether to tie embedding and output weights.
+    """
+    
+    model_type = "chess_transformer"
+    
+    def __init__(
+        self,
+        vocab_size: int = 1200,
+        n_embd: int = 128,
+        n_layer: int = 6,
+        n_head: int = 4,
+        n_ctx: int = 256,
+        n_inner: Optional[int] = None,
+        dropout: float = 0.1,
+        layer_norm_epsilon: float = 1e-5,
+        tie_weights: bool = True,
+        pad_token_id: int = 0,
+        bos_token_id: int = 1,
+        eos_token_id: int = 2,
+        **kwargs,
+    ):
+        super().__init__(
+            pad_token_id=pad_token_id,
+            bos_token_id=bos_token_id,
+            eos_token_id=eos_token_id,
+            **kwargs,
+        )
+        
+        self.vocab_size = vocab_size
+        self.n_embd = n_embd
+        self.n_layer = n_layer
+        self.n_head = n_head
+        self.n_ctx = n_ctx
+        self.n_inner = n_inner if n_inner is not None else 3 * n_embd  # Reduced from 4x to 3x
+        self.dropout = dropout
+        self.layer_norm_epsilon = layer_norm_epsilon
+        self.tie_weights = tie_weights
+        # Inform HF base class about tying behavior
+        self.tie_word_embeddings = bool(tie_weights)
+
+
+class MultiHeadAttention(nn.Module):
+    """
+    Multi-head self-attention module.
+    
+    This is a standard scaled dot-product attention implementation
+    with causal masking for autoregressive generation.
+    """
+    
+    def __init__(self, config: ChessConfig):
+        super().__init__()
+        
+        assert config.n_embd % config.n_head == 0, \
+            f"n_embd ({config.n_embd}) must be divisible by n_head ({config.n_head})"
+        
+        self.n_head = config.n_head
+        self.n_embd = config.n_embd
+        self.head_dim = config.n_embd // config.n_head
+        
+        # Combined QKV projection for efficiency
+        self.c_attn = nn.Linear(config.n_embd, 3 * config.n_embd)
+        self.c_proj = nn.Linear(config.n_embd, config.n_embd)
+        
+        self.dropout = nn.Dropout(config.dropout)
+        
+        # Causal mask (will be created on first forward pass)
+        self.register_buffer(
+            "bias",
+            torch.tril(torch.ones(config.n_ctx, config.n_ctx)).view(
+                1, 1, config.n_ctx, config.n_ctx
+            ),
+            persistent=False,
+        )
+    
+    def forward(
+        self,
+        x: torch.Tensor,
+        attention_mask: Optional[torch.Tensor] = None,
+    ) -> torch.Tensor:
+        batch_size, seq_len, _ = x.size()
+        
+        # Compute Q, K, V
+        qkv = self.c_attn(x)
+        q, k, v = qkv.split(self.n_embd, dim=2)
+        
+        # Reshape for multi-head attention
+        q = q.view(batch_size, seq_len, self.n_head, self.head_dim).transpose(1, 2)
+        k = k.view(batch_size, seq_len, self.n_head, self.head_dim).transpose(1, 2)
+        v = v.view(batch_size, seq_len, self.n_head, self.head_dim).transpose(1, 2)
+        
+        # Scaled dot-product attention
+        attn_weights = torch.matmul(q, k.transpose(-2, -1)) / math.sqrt(self.head_dim)
+        
+        # Apply causal mask
+        causal_mask = self.bias[:, :, :seq_len, :seq_len]
+        attn_weights = attn_weights.masked_fill(causal_mask == 0, float("-inf"))
+        
+        # Apply attention mask (for padding)
+        if attention_mask is not None:
+            # attention_mask shape: (batch_size, seq_len) -> (batch_size, 1, 1, seq_len)
+            attention_mask = attention_mask.unsqueeze(1).unsqueeze(2)
+            attn_weights = attn_weights.masked_fill(attention_mask == 0, float("-inf"))
+        
+        attn_weights = F.softmax(attn_weights, dim=-1)
+        attn_weights = self.dropout(attn_weights)
+        
+        # Apply attention to values
+        attn_output = torch.matmul(attn_weights, v)
+        
+        # Reshape back
+        attn_output = attn_output.transpose(1, 2).contiguous().view(
+            batch_size, seq_len, self.n_embd
+        )
+        
+        # Output projection
+        attn_output = self.c_proj(attn_output)
+        
+        return attn_output
+
+
+class FeedForward(nn.Module):
+    """
+    Feed-forward network (MLP) module.
+    
+    Standard two-layer MLP with GELU activation.
+    """
+    
+    def __init__(self, config: ChessConfig):
+        super().__init__()
+        
+        self.c_fc = nn.Linear(config.n_embd, config.n_inner)
+        self.c_proj = nn.Linear(config.n_inner, config.n_embd)
+        self.dropout = nn.Dropout(config.dropout)
+    
+    def forward(self, x: torch.Tensor) -> torch.Tensor:
+        x = self.c_fc(x)
+        x = F.gelu(x)
+        x = self.c_proj(x)
+        x = self.dropout(x)
+        return x
+
+
+class TransformerBlock(nn.Module):
+    """
+    A single transformer block with attention and feed-forward layers.
+    
+    Uses pre-normalization (LayerNorm before attention/FFN) for better
+    training stability.
+    """
+    
+    def __init__(self, config: ChessConfig):
+        super().__init__()
+        
+        self.ln_1 = nn.LayerNorm(config.n_embd, eps=config.layer_norm_epsilon)
+        self.attn = MultiHeadAttention(config)
+        self.ln_2 = nn.LayerNorm(config.n_embd, eps=config.layer_norm_epsilon)
+        self.mlp = FeedForward(config)
+    
+    def forward(
+        self,
+        x: torch.Tensor,
+        attention_mask: Optional[torch.Tensor] = None,
+    ) -> torch.Tensor:
+        # Pre-norm attention
+        x = x + self.attn(self.ln_1(x), attention_mask=attention_mask)
+        # Pre-norm FFN
+        x = x + self.mlp(self.ln_2(x))
+        return x
+
+
+class ChessForCausalLM(PreTrainedModel):
+    """
+    Chess Transformer for Causal Language Modeling (next-move prediction).
+    
+    This model is designed to predict the next chess move given a sequence
+    of previous moves. It uses a GPT-style architecture with:
+    - Token embeddings for chess moves
+    - Learned positional embeddings
+    - Stacked transformer blocks
+    - Linear head for next-token prediction
+    
+    The model supports weight tying between the embedding layer and the
+    output projection to save parameters.
+    
+    Example:
+        >>> config = ChessConfig(vocab_size=1200, n_embd=128, n_layer=6)
+        >>> model = ChessForCausalLM(config)
+        >>> inputs = {"input_ids": torch.tensor([[1, 42, 87]])}
+        >>> outputs = model(**inputs)
+        >>> next_move_logits = outputs.logits[:, -1, :]
+    """
+    
+    config_class = ChessConfig
+    base_model_prefix = "transformer"
+    supports_gradient_checkpointing = True
+    # Suppress missing-key warning for tied lm_head when loading
+    keys_to_ignore_on_load_missing = ["lm_head.weight"]
+    
+    def __init__(self, config: ChessConfig):
+        super().__init__(config)
+        
+        # Token and position embeddings
+        self.wte = nn.Embedding(config.vocab_size, config.n_embd)
+        self.wpe = nn.Embedding(config.n_ctx, config.n_embd)
+        
+        self.drop = nn.Dropout(config.dropout)
+        
+        # Transformer blocks
+        self.h = nn.ModuleList([
+            TransformerBlock(config) for _ in range(config.n_layer)
+        ])
+        
+        # Final layer norm
+        self.ln_f = nn.LayerNorm(config.n_embd, eps=config.layer_norm_epsilon)
+        
+        # Output head
+        self.lm_head = nn.Linear(config.n_embd, config.vocab_size, bias=False)
+        
+        # Declare tied weights for proper serialization
+        if config.tie_weights:
+            self._tied_weights_keys = ["lm_head.weight"]
+        
+        # Initialize weights
+        self.post_init()
+        
+        # Tie weights if configured
+        if config.tie_weights:
+            self.tie_weights()
+
+    def get_input_embeddings(self) -> nn.Module:
+        return self.wte
+
+    def set_input_embeddings(self, new_embeddings: nn.Module):
+        self.wte = new_embeddings
+        if getattr(self.config, "tie_weights", False):
+            self.tie_weights()
+
+    def get_output_embeddings(self) -> nn.Module:
+        return self.lm_head
+
+    def set_output_embeddings(self, new_embeddings: nn.Module):
+        self.lm_head = new_embeddings
+
+    def tie_weights(self):
+        # Use HF helper to tie or clone depending on config
+        if getattr(self.config, "tie_weights", False) or getattr(self.config, "tie_word_embeddings", False):
+            self._tie_or_clone_weights(self.lm_head, self.wte)
+    
+    def _init_weights(self, module: nn.Module):
+        """Initialize weights following GPT-2 style."""
+        if isinstance(module, nn.Linear):
+            torch.nn.init.normal_(module.weight, mean=0.0, std=0.02)
+            if module.bias is not None:
+                torch.nn.init.zeros_(module.bias)
+        elif isinstance(module, nn.Embedding):
+            torch.nn.init.normal_(module.weight, mean=0.0, std=0.02)
+        elif isinstance(module, nn.LayerNorm):
+            torch.nn.init.ones_(module.weight)
+            torch.nn.init.zeros_(module.bias)
+    
+    def forward(
+        self,
+        input_ids: torch.LongTensor,
+        attention_mask: Optional[torch.Tensor] = None,
+        position_ids: Optional[torch.LongTensor] = None,
+        labels: Optional[torch.LongTensor] = None,
+        return_dict: Optional[bool] = None,
+        **kwargs,
+    ) -> Union[Tuple, CausalLMOutputWithPast]:
+        """
+        Forward pass of the model.
+        
+        Args:
+            input_ids: Token IDs of shape (batch_size, seq_len).
+            attention_mask: Attention mask of shape (batch_size, seq_len).
+            position_ids: Position IDs of shape (batch_size, seq_len).
+            labels: Labels for language modeling loss.
+            return_dict: Whether to return a ModelOutput object.
+        
+        Returns:
+            CausalLMOutputWithPast containing loss (if labels provided) and logits.
+        """
+        return_dict = return_dict if return_dict is not None else self.config.use_return_dict
+        
+        batch_size, seq_len = input_ids.size()
+        device = input_ids.device
+        
+        # Create position IDs if not provided
+        if position_ids is None:
+            position_ids = torch.arange(seq_len, device=device).unsqueeze(0).expand(batch_size, -1)
+        
+        # Get embeddings
+        token_embeds = self.wte(input_ids)
+        position_embeds = self.wpe(position_ids)
+        hidden_states = self.drop(token_embeds + position_embeds)
+        
+        # Pass through transformer blocks
+        for block in self.h:
+            hidden_states = block(hidden_states, attention_mask=attention_mask)
+        
+        # Final layer norm
+        hidden_states = self.ln_f(hidden_states)
+        
+        # Get logits
+        logits = self.lm_head(hidden_states)
+        
+        # Compute loss if labels are provided
+        loss = None
+        if labels is not None:
+            # Shift logits and labels for next-token prediction
+            shift_logits = logits[..., :-1, :].contiguous()
+            shift_labels = labels[..., 1:].contiguous()
+            
+            # Flatten for cross-entropy
+            loss_fct = nn.CrossEntropyLoss(ignore_index=-100)
+            # loss_fct = nn.CrossEntropyLoss(ignore_index=self.config.pad_token_id)
+            loss = loss_fct(
+                shift_logits.view(-1, shift_logits.size(-1)),
+                shift_labels.view(-1),
+            )
+        
+        if not return_dict:
+            output = (logits,)
+            return ((loss,) + output) if loss is not None else output
+        
+        return CausalLMOutputWithPast(
+            loss=loss,
+            logits=logits,
+            past_key_values=None,
+            hidden_states=None,
+            attentions=None,
+        )
+    
+    @torch.no_grad()
+    def generate_move(
+        self,
+        input_ids: torch.LongTensor,
+        temperature: float = 1.0,
+        top_k: Optional[int] = None,
+        top_p: Optional[float] = None,
+    ) -> int:
+        """
+        Generate the next move given a sequence of moves.
+        
+        Args:
+            input_ids: Token IDs of shape (1, seq_len).
+            temperature: Sampling temperature (1.0 = no change).
+            top_k: If set, only sample from top k tokens.
+            top_p: If set, use nucleus sampling with this threshold.
+        
+        Returns:
+            The token ID of the predicted next move.
+        """
+        self.eval()
+        
+        # Get logits for the last position
+        outputs = self(input_ids)
+        logits = outputs.logits[:, -1, :] / temperature
+        
+        # Apply top-k filtering
+        if top_k is not None:
+            indices_to_remove = logits < torch.topk(logits, top_k)[0][..., -1, None]
+            logits[indices_to_remove] = float("-inf")
+        
+        # Apply top-p (nucleus) filtering
+        if top_p is not None:
+            sorted_logits, sorted_indices = torch.sort(logits, descending=True)
+            cumulative_probs = torch.cumsum(F.softmax(sorted_logits, dim=-1), dim=-1)
+            
+            # Remove tokens with cumulative probability above the threshold
+            sorted_indices_to_remove = cumulative_probs > top_p
+            sorted_indices_to_remove[..., 1:] = sorted_indices_to_remove[..., :-1].clone()
+            sorted_indices_to_remove[..., 0] = 0
+            
+            indices_to_remove = sorted_indices_to_remove.scatter(
+                dim=-1, index=sorted_indices, src=sorted_indices_to_remove
+            )
+            logits[indices_to_remove] = float("-inf")
+        
+        # Sample from the distribution
+        probs = F.softmax(logits, dim=-1)
+        next_token = torch.multinomial(probs, num_samples=1)
+        
+        return next_token.item()
+
+
+# Register the model with Auto classes for easy loading
+from transformers import AutoConfig, AutoModelForCausalLM
+
+AutoConfig.register("chess_transformer", ChessConfig)
+AutoModelForCausalLM.register(ChessConfig, ChessForCausalLM)

model.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:85661e063f9a78f1b8b9b45f6bfa9c3111fcec969624fa53a1852df311d26ac3
+size 3502896

tokenizer.py

@@ -0,0 +1,427 @@
+"""
+Custom Chess Tokenizer for the Chess Challenge.
+
+We build a vocabulary with:
+- W/B prefix for White/Black
+- Piece letter: P=Pawn, N=Knight, B=Bishop, R=Rook, Q=Queen, K=King
+- Source and rank and file: e.g e 2
+- Destination and rank and file: e.g e 4
+- Special suffixes: (x)=capture, (+)=check, (+*)=checkmate, (o)/(O)=castling
+
+"""
+
+from __future__ import annotations
+
+import json
+import os
+from pathlib import Path
+import shutil
+import inspect
+from typing import Dict, List, Optional
+
+from transformers import PreTrainedTokenizer
+
+
+class ChessTokenizer(PreTrainedTokenizer):
+    """
+    A custom tokenizer for chess moves.
+    
+    Example:
+        >>> tokenizer = ChessTokenizer()
+        >>> tokenizer.encode("WPe2e4 BPe7e5")
+        # [BOS, W, P, e, 2, e, 4, B, P, e, 7, e, 5, EOS]
+    """
+    
+    model_input_names = ["input_ids", "attention_mask"]
+    vocab_files_names = {"vocab_file": "vocab.json"}
+    
+    # Special tokens
+    PAD_TOKEN = "[PAD]"
+    BOS_TOKEN = "[BOS]"
+    EOS_TOKEN = "[EOS]"
+    UNK_TOKEN = "[UNK]"
+    SEP_TOKEN = "[SEP]"
+    
+    def __init__(
+        self,
+        vocab_file: Optional[str] = None,
+        vocab: Optional[Dict[str, int]] = None,
+        **kwargs,
+    ):
+        """
+        Initialize the chess tokenizer.
+        
+        Args:
+            vocab_file: Path to a JSON file containing the vocabulary mapping.
+            vocab: Dictionary mapping tokens to IDs (alternative to vocab_file).
+            **kwargs: Additional arguments passed to PreTrainedTokenizer.
+        """
+        # Initialize special tokens
+        self._pad_token = self.PAD_TOKEN
+        self._bos_token = self.BOS_TOKEN
+        self._eos_token = self.EOS_TOKEN
+        self._unk_token = self.UNK_TOKEN
+        self._sep_token = self.SEP_TOKEN
+
+        # Remove any duplicate special-token entries passed through kwargs
+        # to avoid "multiple values for keyword" errors when loading from disk.
+        kwargs.pop("pad_token", None)
+        kwargs.pop("bos_token", None)
+        kwargs.pop("eos_token", None)
+        kwargs.pop("unk_token", None)
+        kwargs.pop("sep_token", None)
+        
+        # Load or create vocabulary
+        if vocab is not None:
+            self._vocab = vocab
+        elif vocab_file is not None and os.path.exists(vocab_file):
+            with open(vocab_file, "r", encoding="utf-8") as f:
+                self._vocab = json.load(f)
+        else:
+            # Create a minimal vocabulary with just special tokens
+            # The full vocabulary should be built from the dataset
+            self._vocab = self._create_default_vocab()
+        
+        # Create reverse mapping
+        self._ids_to_tokens = {v: k for k, v in self._vocab.items()}
+        
+        # Call parent init AFTER setting up vocab
+        super().__init__(
+            pad_token=self._pad_token,
+            bos_token=self._bos_token,
+            eos_token=self._eos_token,
+            unk_token=self._unk_token,
+            sep_token=self._sep_token,
+            **kwargs,
+        )
+    
+    def _create_default_vocab(self) -> Dict[str, int]:
+        """
+        Create a minimal default vocabulary with just special tokens.
+        
+        For the full vocabulary, use `build_vocab_from_dataset()`.
+        This minimal vocab is just a placeholder - you should build from data.
+        """
+        special_tokens = [self.PAD_TOKEN, self.BOS_TOKEN, self.EOS_TOKEN, self.UNK_TOKEN, self.SEP_TOKEN]
+        vocab = {token: idx for idx, token in enumerate(special_tokens)}
+        return vocab
+    
+    
+    @classmethod
+    def build_vocab_from_dataset(
+        cls,
+        dataset_name: str = "dlouapre/lichess_2025-01_1M",
+        split: str = "train",
+        column: str = "text",
+        save_path: Optional[str] = None,
+    ) -> "ChessTokenizer":
+        """
+        Build a tokenizer vocabulary from a Hugging Face dataset.
+        
+        Args:
+            dataset_name: Name of the dataset on Hugging Face Hub.
+            split: Dataset split to use.
+            column: Column containing the game strings.
+        
+        Returns:
+            A ChessTokenizer with the built vocabulary.
+
+        Args:
+            save_path: Optional path to write the generated vocab JSON. If not
+                provided, the vocab will be saved to ``./chess_tokenizer_vocab.json``.
+        """
+        from datasets import load_dataset
+
+        # If a saved vocab exists at `save_path`, load it and return a tokenizer
+        if save_path is None:
+            cwd = os.getcwd()
+            save_path = os.path.join(cwd, "chess_tokenizer_vocab.json")
+
+        if os.path.exists(save_path):
+            try:
+                with open(save_path, "r", encoding="utf-8") as f:
+                    print("Loading existing tokenizer vocab from", save_path)
+                    vocab = json.load(f)
+                return cls(vocab=vocab)
+            except Exception:
+                # If loading fails, fall through to rebuild the vocab.
+                pass
+
+        dataset = load_dataset(dataset_name, split=split)
+
+        # Iterator over games (respect max_samples if provided)
+        samples = dataset[column]
+
+        tokens = set()
+
+        for game in samples:
+            if not isinstance(game, str):
+                continue
+            moves = game.strip().split()
+            for move in moves:
+                # Basic parsing of move token components
+                if len(move) < 2:
+                    continue
+                color = move[0]
+                piece = move[1]
+                from_square = move[2:4] if len(move) >= 4 else ''
+                to_square = move[4:6] if len(move) >= 6 else ''
+                suffix = move[6:] if len(move) > 6 else ''
+                
+                tokens.add(color)
+                tokens.add(piece)
+                tokens.add(from_square)
+                tokens.add(to_square)
+                if suffix:
+                    tokens.add(suffix)   
+
+        # Sort tokens
+        tokens = sorted(tokens)
+
+        # Ensure special tokens are present at fixed ids
+        special_tokens = [cls.PAD_TOKEN, cls.BOS_TOKEN, cls.EOS_TOKEN, cls.UNK_TOKEN, cls.SEP_TOKEN]
+
+        # Build vocab mapping: special tokens first, then tokens
+        vocab: Dict[str, int] = {}
+        idx = 0
+        for st in special_tokens:
+            vocab[st] = idx
+            idx += 1
+
+        for t in tokens:
+            if t in vocab:
+                continue
+            vocab[t] = idx
+            idx += 1
+
+        # Create tokenizer instance with this vocab
+        tokenizer = cls(vocab=vocab)
+
+        # Save vocab to disk. Use provided `save_path` or default file name.
+        try:
+            if save_path is None:
+                cwd = os.getcwd()
+                save_path = os.path.join(cwd, "chess_tokenizer_vocab.json")
+
+            # Write to a temporary file first and atomically replace final file.
+            tmp_path = save_path + ".tmp"
+            with open(tmp_path, "w", encoding="utf-8") as f:
+                json.dump(vocab, f, ensure_ascii=False, indent=2)
+            os.replace(tmp_path, save_path)
+        except Exception:
+            # Non-fatal: ignore save errors but don't leave temp files behind.
+            try:
+                if 'tmp_path' in locals() and os.path.exists(tmp_path):
+                    os.remove(tmp_path)
+            except Exception:
+                pass
+
+        return tokenizer
+    
+    @property
+    def vocab_size(self) -> int:
+        """Return the size of the vocabulary."""
+        return len(self._vocab)
+    
+    def get_vocab(self) -> Dict[str, int]:
+        """Return the vocabulary as a dictionary."""
+        return dict(self._vocab)
+    
+    def _tokenize(self, text: str) -> List[str]:
+        """
+        Tokenize a string of moves into a list of tokens.
+        
+        Args:
+            text: A string of space-separated moves.
+        
+        Returns:
+            List of move tokens.
+        """
+        tokens: List[str] = []
+        for move in text.strip().split():
+            if len(move) < 2:
+                continue
+            color, piece, from_square, to_square, suffix = self._decompose_move(move)
+            tokens.append(color)
+            tokens.append(piece)
+            tokens.append(from_square)
+            tokens.append(to_square)
+            if suffix:
+                tokens.append(suffix)
+
+            tokens.append(self._sep_token)
+
+        return tokens[:-1]  # Remove last SEP token
+
+    @staticmethod
+    def _decompose_move(move: str):
+        """Decompose a move string into components: color, piece, from_square, to_square, suffix.
+
+        Returns a 5-tuple of strings (empty strings for missing parts).
+        """
+        color = move[0]
+        piece = move[1] if len(move) >= 2 else ''
+        from_square = move[2:4] if len(move) >= 4 else ''
+        to_square = move[4:6] if len(move) >= 6 else ''
+        suffix = move[6:] if len(move) > 6 else ''
+        return color, piece, from_square, to_square, suffix
+    
+    def _convert_token_to_id(self, token: str) -> int:
+        """Convert a token to its ID."""
+        return self._vocab.get(token, self._vocab.get(self.UNK_TOKEN, 0))
+    
+    def _convert_id_to_token(self, index: int) -> str:
+        """Convert an ID to its token."""
+        return self._ids_to_tokens.get(index, self.UNK_TOKEN)
+    
+    def convert_tokens_to_string(self, tokens: List[str]) -> str:
+        """Convert a list of tokens back to a string."""
+        # Filter out special tokens for cleaner output
+        special = {self.PAD_TOKEN, self.BOS_TOKEN, self.EOS_TOKEN, self.UNK_TOKEN}
+        return " ".join(t for t in tokens if t not in special)
+
+    def decode(self, token_ids: List[int], skip_special_tokens: bool = True) -> str:
+        """Decode a list of token IDs back to a string."""
+        tokens = [self._convert_id_to_token(int(tid)) for tid in token_ids]
+        if skip_special_tokens:
+            special = {self.PAD_TOKEN, self.BOS_TOKEN, self.EOS_TOKEN, self.UNK_TOKEN}
+            # SEP token should be replace by space
+            tokens = [t if t != self.SEP_TOKEN else " " for t in tokens if t not in special]
+        return "".join(tokens)
+
+    def save_vocabulary(
+        self,
+        save_directory: str,
+        filename_prefix: Optional[str] = None,
+    ) -> tuple:
+        """
+        Save the vocabulary to a JSON file.
+        
+        Args:
+            save_directory: Directory to save the vocabulary.
+            filename_prefix: Optional prefix for the filename.
+        
+        Returns:
+            Tuple containing the path to the saved vocabulary file.
+        """
+        if not os.path.isdir(save_directory):
+            os.makedirs(save_directory, exist_ok=True)
+        
+        vocab_file = os.path.join(
+            save_directory,
+            (filename_prefix + "-" if filename_prefix else "") + "vocab.json",
+        )
+        
+        with open(vocab_file, "w", encoding="utf-8") as f:
+            json.dump(self._vocab, f, ensure_ascii=False, indent=2)
+        
+        return (vocab_file,)
+
+    def save_pretrained(
+        self,
+        save_directory: str,
+        filename_prefix: Optional[str] = None,
+        save_tokenizer_code: bool = True,
+    ) -> None:
+        """Save tokenizer files to a directory in a HF-compatible layout.
+
+        This writes the vocab JSON (via `save_vocabulary`), a small
+        `tokenizer_config.json` describing special tokens and the vocab
+        filename, and optionally copies the tokenizer module source file
+        into the directory so others can import the implementation.
+        """
+        if not os.path.isdir(save_directory):
+            os.makedirs(save_directory, exist_ok=True)
+
+        # Save the vocabulary file
+        vocab_file_tuple = self.save_vocabulary(save_directory, filename_prefix)
+        vocab_file = vocab_file_tuple[0]
+
+        # Write a minimal tokenizer config
+        config = {
+            "tokenizer_class": self.__class__.__name__,
+            "vocab_file": os.path.basename(vocab_file),
+            "pad_token": self.PAD_TOKEN,
+            "bos_token": self.BOS_TOKEN,
+            "eos_token": self.EOS_TOKEN,
+            "unk_token": self.UNK_TOKEN,
+        }
+        config_path = os.path.join(save_directory, "tokenizer_config.json")
+        with open(config_path, "w", encoding="utf-8") as f:
+            json.dump(config, f, ensure_ascii=False, indent=2)
+
+        # Optionally copy this module file so the tokenizer class implementation
+        # is available alongside the saved vocab/config. This helps when
+        # transferring the saved tokenizer to another environment.
+        if save_tokenizer_code:
+            try:
+                src_file = Path(inspect.getsourcefile(self.__class__))
+                dst_file = Path(save_directory) / src_file.name
+                shutil.copy2(src_file, dst_file)
+            except Exception:
+                # Non-fatal; we still saved vocab and config
+                pass
+
+    @classmethod
+    def from_pretrained(cls, load_directory: str) -> "ChessTokenizer":
+        """Load tokenizer from a directory previously written with `save_pretrained`.
+
+        This primarily reads the vocab file and constructs the tokenizer.
+        If a `tokenizer_config.json` exists it will be consulted for the
+        vocab filename and special tokens (but we still instantiate using
+        the provided class).
+        """
+        config_path = os.path.join(load_directory, "tokenizer_config.json")
+        vocab_file = None
+        if os.path.exists(config_path):
+            try:
+                with open(config_path, "r", encoding="utf-8") as f:
+                    cfg = json.load(f)
+                vocab_file = os.path.join(load_directory, cfg.get("vocab_file", "vocab.json"))
+            except Exception:
+                pass
+
+        if vocab_file is None:
+            # Fallback: look for a vocab file in the directory
+            candidates = [p for p in os.listdir(load_directory) if p.endswith("vocab.json")]
+            if candidates:
+                vocab_file = os.path.join(load_directory, candidates[0])
+
+        if vocab_file is None or not os.path.exists(vocab_file):
+            raise FileNotFoundError(f"No vocab file found in {load_directory}")
+
+        return cls(vocab_file=vocab_file)
+
+def count_vocab_from_dataset(
+    dataset_name: str = "dlouapre/lichess_2025-01_1M",
+    split: str = "train",
+    column: str = "text",
+    max_samples: Optional[int] = 10000,
+) -> Dict[str, int]:
+    """
+    Count token frequencies in a dataset (useful for vocabulary analysis).
+    
+    Args:
+        dataset_name: Name of the dataset on Hugging Face Hub.
+        split: Dataset split to use.
+        column: Column containing the game strings.
+        max_samples: Maximum number of samples to process.
+    
+    Returns:
+        Dictionary mapping tokens to their frequencies.
+    """
+    from collections import Counter
+    from datasets import load_dataset
+    
+    dataset = load_dataset(dataset_name, split=split)
+    
+    if max_samples is not None:
+        dataset = dataset.select(range(min(max_samples, len(dataset))))
+    
+    tokenizer = ChessTokenizer()
+    token_counts = Counter()
+    
+    for example in dataset:
+        token_counts.update(tokenizer._tokenize(example[column]))
+    
+    return dict(token_counts)

tokenizer_config.json

@@ -0,0 +1,8 @@
+{
+  "tokenizer_class": "ChessTokenizer",
+  "vocab_file": "vocab.json",
+  "pad_token": "[PAD]",
+  "bos_token": "[BOS]",
+  "eos_token": "[EOS]",
+  "unk_token": "[UNK]"
+}

vocab.json

@@ -0,0 +1,115 @@
+{
+  "[PAD]": 0,
+  "[BOS]": 1,
+  "[EOS]": 2,
+  "[UNK]": 3,
+  "[SEP]": 4,
+  "(+)": 5,
+  "(+*)": 6,
+  "(+*B)": 7,
+  "(+*N)": 8,
+  "(+*Q)": 9,
+  "(+*R)": 10,
+  "(+B)": 11,
+  "(+N)": 12,
+  "(+Q)": 13,
+  "(+R)": 14,
+  "(B)": 15,
+  "(N)": 16,
+  "(O)": 17,
+  "(O+)": 18,
+  "(O+*)": 19,
+  "(Q)": 20,
+  "(R)": 21,
+  "(o)": 22,
+  "(o+)": 23,
+  "(o+*)": 24,
+  "(x)": 25,
+  "(x+)": 26,
+  "(x+*)": 27,
+  "(x+*B)": 28,
+  "(x+*Q)": 29,
+  "(x+*R)": 30,
+  "(x+B)": 31,
+  "(x+N)": 32,
+  "(x+Q)": 33,
+  "(x+R)": 34,
+  "(xB)": 35,
+  "(xE)": 36,
+  "(xE+)": 37,
+  "(xE+*)": 38,
+  "(xN)": 39,
+  "(xQ)": 40,
+  "(xR)": 41,
+  "B": 42,
+  "K": 43,
+  "N": 44,
+  "P": 45,
+  "Q": 46,
+  "R": 47,
+  "W": 48,
+  "a1": 49,
+  "a2": 50,
+  "a3": 51,
+  "a4": 52,
+  "a5": 53,
+  "a6": 54,
+  "a7": 55,
+  "a8": 56,
+  "b1": 57,
+  "b2": 58,
+  "b3": 59,
+  "b4": 60,
+  "b5": 61,
+  "b6": 62,
+  "b7": 63,
+  "b8": 64,
+  "c1": 65,
+  "c2": 66,
+  "c3": 67,
+  "c4": 68,
+  "c5": 69,
+  "c6": 70,
+  "c7": 71,
+  "c8": 72,
+  "d1": 73,
+  "d2": 74,
+  "d3": 75,
+  "d4": 76,
+  "d5": 77,
+  "d6": 78,
+  "d7": 79,
+  "d8": 80,
+  "e1": 81,
+  "e2": 82,
+  "e3": 83,
+  "e4": 84,
+  "e5": 85,
+  "e6": 86,
+  "e7": 87,
+  "e8": 88,
+  "f1": 89,
+  "f2": 90,
+  "f3": 91,
+  "f4": 92,
+  "f5": 93,
+  "f6": 94,
+  "f7": 95,
+  "f8": 96,
+  "g1": 97,
+  "g2": 98,
+  "g3": 99,
+  "g4": 100,
+  "g5": 101,
+  "g6": 102,
+  "g7": 103,
+  "g8": 104,
+  "h1": 105,
+  "h2": 106,
+  "h3": 107,
+  "h4": 108,
+  "h5": 109,
+  "h6": 110,
+  "h7": 111,
+  "h8": 112
+}