raphael-mathiot commited on
Commit
3984c38
·
verified ·
1 Parent(s): 8d64ce2

Chess Challenge submission by raphael-mathiot

Browse files
Files changed (3) hide show
  1. config.json +4 -0
  2. model.py +441 -0
  3. tokenizer.py +310 -0
config.json CHANGED
@@ -2,6 +2,10 @@
2
  "architectures": [
3
  "ChessForCausalLM"
4
  ],
 
 
 
 
5
  "bos_token_id": 1,
6
  "dropout": 0.1,
7
  "dtype": "float32",
 
2
  "architectures": [
3
  "ChessForCausalLM"
4
  ],
5
+ "auto_map": {
6
+ "AutoConfig": "model.ChessConfig",
7
+ "AutoModelForCausalLM": "model.ChessForCausalLM"
8
+ },
9
  "bos_token_id": 1,
10
  "dropout": 0.1,
11
  "dtype": "float32",
model.py ADDED
@@ -0,0 +1,441 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ """
2
+ Chess Transformer Model for the Chess Challenge.
3
+
4
+ This module provides a simple GPT-style transformer architecture
5
+ designed to fit within the 1M parameter constraint.
6
+
7
+ Key components:
8
+ - ChessConfig: Configuration class for model hyperparameters
9
+ - ChessForCausalLM: The main model class for next-move prediction
10
+ """
11
+
12
+ from __future__ import annotations
13
+
14
+ import math
15
+ from dataclasses import dataclass
16
+ from typing import Optional, Tuple, Union
17
+
18
+ import torch
19
+ import torch.nn as nn
20
+ import torch.nn.functional as F
21
+ from transformers import PretrainedConfig, PreTrainedModel
22
+ from transformers.modeling_outputs import CausalLMOutputWithPast
23
+
24
+
25
+ class ChessConfig(PretrainedConfig):
26
+ """
27
+ Configuration class for the Chess Transformer model.
28
+
29
+ This configuration is designed for a ~1M parameter model.
30
+ Students can adjust these values to explore different architectures.
31
+
32
+ Parameter budget breakdown (with default values):
33
+ - Embeddings (vocab): 1200 x 128 = 153,600
34
+ - Position Embeddings: 256 x 128 = 32,768
35
+ - Transformer Layers: 6 x ~120,000 = ~720,000
36
+ - LM Head (with weight tying): 0 (shared with embeddings)
37
+ - Total: ~906,000 parameters
38
+
39
+ Attributes:
40
+ vocab_size: Size of the vocabulary (number of unique moves).
41
+ n_embd: Embedding dimension (d_model).
42
+ n_layer: Number of transformer layers.
43
+ n_head: Number of attention heads.
44
+ n_ctx: Maximum sequence length (context window).
45
+ n_inner: Feed-forward inner dimension (default: 3 * n_embd).
46
+ dropout: Dropout probability.
47
+ layer_norm_epsilon: Epsilon for layer normalization.
48
+ tie_weights: Whether to tie embedding and output weights.
49
+ """
50
+
51
+ model_type = "chess_transformer"
52
+
53
+ def __init__(
54
+ self,
55
+ vocab_size: int = 1200,
56
+ n_embd: int = 128,
57
+ n_layer: int = 6,
58
+ n_head: int = 4,
59
+ n_ctx: int = 256,
60
+ n_inner: Optional[int] = None,
61
+ dropout: float = 0.1,
62
+ layer_norm_epsilon: float = 1e-5,
63
+ tie_weights: bool = True,
64
+ pad_token_id: int = 0,
65
+ bos_token_id: int = 1,
66
+ eos_token_id: int = 2,
67
+ **kwargs,
68
+ ):
69
+ super().__init__(
70
+ pad_token_id=pad_token_id,
71
+ bos_token_id=bos_token_id,
72
+ eos_token_id=eos_token_id,
73
+ **kwargs,
74
+ )
75
+
76
+ self.vocab_size = vocab_size
77
+ self.n_embd = n_embd
78
+ self.n_layer = n_layer
79
+ self.n_head = n_head
80
+ self.n_ctx = n_ctx
81
+ self.n_inner = n_inner if n_inner is not None else 3 * n_embd # Reduced from 4x to 3x
82
+ self.dropout = dropout
83
+ self.layer_norm_epsilon = layer_norm_epsilon
84
+ self.tie_weights = tie_weights
85
+ # Inform HF base class about tying behavior
86
+ self.tie_word_embeddings = bool(tie_weights)
87
+
88
+
89
+ class MultiHeadAttention(nn.Module):
90
+ """
91
+ Multi-head self-attention module.
92
+
93
+ This is a standard scaled dot-product attention implementation
94
+ with causal masking for autoregressive generation.
95
+ """
96
+
97
+ def __init__(self, config: ChessConfig):
98
+ super().__init__()
99
+
100
+ assert config.n_embd % config.n_head == 0, \
101
+ f"n_embd ({config.n_embd}) must be divisible by n_head ({config.n_head})"
102
+
103
+ self.n_head = config.n_head
104
+ self.n_embd = config.n_embd
105
+ self.head_dim = config.n_embd // config.n_head
106
+
107
+ # Combined QKV projection for efficiency
108
+ self.c_attn = nn.Linear(config.n_embd, 3 * config.n_embd)
109
+ self.c_proj = nn.Linear(config.n_embd, config.n_embd)
110
+
111
+ self.dropout = nn.Dropout(config.dropout)
112
+
113
+ # Causal mask (will be created on first forward pass)
114
+ self.register_buffer(
115
+ "bias",
116
+ torch.tril(torch.ones(config.n_ctx, config.n_ctx)).view(
117
+ 1, 1, config.n_ctx, config.n_ctx
118
+ ),
119
+ persistent=False,
120
+ )
121
+
122
+ def forward(
123
+ self,
124
+ x: torch.Tensor,
125
+ attention_mask: Optional[torch.Tensor] = None,
126
+ ) -> torch.Tensor:
127
+ batch_size, seq_len, _ = x.size()
128
+
129
+ # Compute Q, K, V
130
+ qkv = self.c_attn(x)
131
+ q, k, v = qkv.split(self.n_embd, dim=2)
132
+
133
+ # Reshape for multi-head attention
134
+ q = q.view(batch_size, seq_len, self.n_head, self.head_dim).transpose(1, 2)
135
+ k = k.view(batch_size, seq_len, self.n_head, self.head_dim).transpose(1, 2)
136
+ v = v.view(batch_size, seq_len, self.n_head, self.head_dim).transpose(1, 2)
137
+
138
+ # Scaled dot-product attention
139
+ attn_weights = torch.matmul(q, k.transpose(-2, -1)) / math.sqrt(self.head_dim)
140
+
141
+ # Apply causal mask
142
+ causal_mask = self.bias[:, :, :seq_len, :seq_len]
143
+ attn_weights = attn_weights.masked_fill(causal_mask == 0, float("-inf"))
144
+
145
+ # Apply attention mask (for padding)
146
+ if attention_mask is not None:
147
+ # attention_mask shape: (batch_size, seq_len) -> (batch_size, 1, 1, seq_len)
148
+ attention_mask = attention_mask.unsqueeze(1).unsqueeze(2)
149
+ attn_weights = attn_weights.masked_fill(attention_mask == 0, float("-inf"))
150
+
151
+ attn_weights = F.softmax(attn_weights, dim=-1)
152
+ attn_weights = self.dropout(attn_weights)
153
+
154
+ # Apply attention to values
155
+ attn_output = torch.matmul(attn_weights, v)
156
+
157
+ # Reshape back
158
+ attn_output = attn_output.transpose(1, 2).contiguous().view(
159
+ batch_size, seq_len, self.n_embd
160
+ )
161
+
162
+ # Output projection
163
+ attn_output = self.c_proj(attn_output)
164
+
165
+ return attn_output
166
+
167
+
168
+ class FeedForward(nn.Module):
169
+ """
170
+ Feed-forward network (MLP) module.
171
+
172
+ Standard two-layer MLP with GELU activation.
173
+ """
174
+
175
+ def __init__(self, config: ChessConfig):
176
+ super().__init__()
177
+
178
+ self.c_fc = nn.Linear(config.n_embd, config.n_inner)
179
+ self.c_proj = nn.Linear(config.n_inner, config.n_embd)
180
+ self.dropout = nn.Dropout(config.dropout)
181
+
182
+ def forward(self, x: torch.Tensor) -> torch.Tensor:
183
+ x = self.c_fc(x)
184
+ x = F.gelu(x)
185
+ x = self.c_proj(x)
186
+ x = self.dropout(x)
187
+ return x
188
+
189
+
190
+ class TransformerBlock(nn.Module):
191
+ """
192
+ A single transformer block with attention and feed-forward layers.
193
+
194
+ Uses pre-normalization (LayerNorm before attention/FFN) for better
195
+ training stability.
196
+ """
197
+
198
+ def __init__(self, config: ChessConfig):
199
+ super().__init__()
200
+
201
+ self.ln_1 = nn.LayerNorm(config.n_embd, eps=config.layer_norm_epsilon)
202
+ self.attn = MultiHeadAttention(config)
203
+ self.ln_2 = nn.LayerNorm(config.n_embd, eps=config.layer_norm_epsilon)
204
+ self.mlp = FeedForward(config)
205
+
206
+ def forward(
207
+ self,
208
+ x: torch.Tensor,
209
+ attention_mask: Optional[torch.Tensor] = None,
210
+ ) -> torch.Tensor:
211
+ # Pre-norm attention
212
+ x = x + self.attn(self.ln_1(x), attention_mask=attention_mask)
213
+ # Pre-norm FFN
214
+ x = x + self.mlp(self.ln_2(x))
215
+ return x
216
+
217
+
218
+ class ChessForCausalLM(PreTrainedModel):
219
+ """
220
+ Chess Transformer for Causal Language Modeling (next-move prediction).
221
+
222
+ This model is designed to predict the next chess move given a sequence
223
+ of previous moves. It uses a GPT-style architecture with:
224
+ - Token embeddings for chess moves
225
+ - Learned positional embeddings
226
+ - Stacked transformer blocks
227
+ - Linear head for next-token prediction
228
+
229
+ The model supports weight tying between the embedding layer and the
230
+ output projection to save parameters.
231
+
232
+ Example:
233
+ >>> config = ChessConfig(vocab_size=1200, n_embd=128, n_layer=6)
234
+ >>> model = ChessForCausalLM(config)
235
+ >>> inputs = {"input_ids": torch.tensor([[1, 42, 87]])}
236
+ >>> outputs = model(**inputs)
237
+ >>> next_move_logits = outputs.logits[:, -1, :]
238
+ """
239
+
240
+ config_class = ChessConfig
241
+ base_model_prefix = "transformer"
242
+ supports_gradient_checkpointing = True
243
+ # Suppress missing-key warning for tied lm_head when loading
244
+ keys_to_ignore_on_load_missing = ["lm_head.weight"]
245
+
246
+ def __init__(self, config: ChessConfig):
247
+ super().__init__(config)
248
+
249
+ # Token and position embeddings
250
+ self.wte = nn.Embedding(config.vocab_size, config.n_embd)
251
+ self.wpe = nn.Embedding(config.n_ctx, config.n_embd)
252
+
253
+ self.drop = nn.Dropout(config.dropout)
254
+
255
+ # Transformer blocks
256
+ self.h = nn.ModuleList([
257
+ TransformerBlock(config) for _ in range(config.n_layer)
258
+ ])
259
+
260
+ # Final layer norm
261
+ self.ln_f = nn.LayerNorm(config.n_embd, eps=config.layer_norm_epsilon)
262
+
263
+ # Output head
264
+ self.lm_head = nn.Linear(config.n_embd, config.vocab_size, bias=False)
265
+
266
+ # Declare tied weights for proper serialization
267
+ if config.tie_weights:
268
+ self._tied_weights_keys = ["lm_head.weight"]
269
+
270
+ # Initialize weights
271
+ self.post_init()
272
+
273
+ # Tie weights if configured
274
+ if config.tie_weights:
275
+ self.tie_weights()
276
+
277
+ def get_input_embeddings(self) -> nn.Module:
278
+ return self.wte
279
+
280
+ def set_input_embeddings(self, new_embeddings: nn.Module):
281
+ self.wte = new_embeddings
282
+ if getattr(self.config, "tie_weights", False):
283
+ self.tie_weights()
284
+
285
+ def get_output_embeddings(self) -> nn.Module:
286
+ return self.lm_head
287
+
288
+ def set_output_embeddings(self, new_embeddings: nn.Module):
289
+ self.lm_head = new_embeddings
290
+
291
+ def tie_weights(self):
292
+ # Use HF helper to tie or clone depending on config
293
+ if getattr(self.config, "tie_weights", False) or getattr(self.config, "tie_word_embeddings", False):
294
+ self._tie_or_clone_weights(self.lm_head, self.wte)
295
+
296
+ def _init_weights(self, module: nn.Module):
297
+ """Initialize weights following GPT-2 style."""
298
+ if isinstance(module, nn.Linear):
299
+ torch.nn.init.normal_(module.weight, mean=0.0, std=0.02)
300
+ if module.bias is not None:
301
+ torch.nn.init.zeros_(module.bias)
302
+ elif isinstance(module, nn.Embedding):
303
+ torch.nn.init.normal_(module.weight, mean=0.0, std=0.02)
304
+ elif isinstance(module, nn.LayerNorm):
305
+ torch.nn.init.ones_(module.weight)
306
+ torch.nn.init.zeros_(module.bias)
307
+
308
+ def forward(
309
+ self,
310
+ input_ids: torch.LongTensor,
311
+ attention_mask: Optional[torch.Tensor] = None,
312
+ position_ids: Optional[torch.LongTensor] = None,
313
+ labels: Optional[torch.LongTensor] = None,
314
+ return_dict: Optional[bool] = None,
315
+ **kwargs,
316
+ ) -> Union[Tuple, CausalLMOutputWithPast]:
317
+ """
318
+ Forward pass of the model.
319
+
320
+ Args:
321
+ input_ids: Token IDs of shape (batch_size, seq_len).
322
+ attention_mask: Attention mask of shape (batch_size, seq_len).
323
+ position_ids: Position IDs of shape (batch_size, seq_len).
324
+ labels: Labels for language modeling loss.
325
+ return_dict: Whether to return a ModelOutput object.
326
+
327
+ Returns:
328
+ CausalLMOutputWithPast containing loss (if labels provided) and logits.
329
+ """
330
+ return_dict = return_dict if return_dict is not None else self.config.use_return_dict
331
+
332
+ batch_size, seq_len = input_ids.size()
333
+ device = input_ids.device
334
+
335
+ # Create position IDs if not provided
336
+ if position_ids is None:
337
+ position_ids = torch.arange(seq_len, device=device).unsqueeze(0).expand(batch_size, -1)
338
+
339
+ # Get embeddings
340
+ token_embeds = self.wte(input_ids)
341
+ position_embeds = self.wpe(position_ids)
342
+ hidden_states = self.drop(token_embeds + position_embeds)
343
+
344
+ # Pass through transformer blocks
345
+ for block in self.h:
346
+ hidden_states = block(hidden_states, attention_mask=attention_mask)
347
+
348
+ # Final layer norm
349
+ hidden_states = self.ln_f(hidden_states)
350
+
351
+ # Get logits
352
+ logits = self.lm_head(hidden_states)
353
+
354
+ # Compute loss if labels are provided
355
+ loss = None
356
+
357
+ if labels is not None:
358
+ # Shift logits and labels for next-token prediction
359
+ shift_logits = logits[..., :-1, :].contiguous()
360
+ shift_labels = labels[..., 1:].contiguous()
361
+
362
+ #print(shift_labels[0, 32].item(), torch.argmax(shift_logits[0, 33]).item())
363
+
364
+ # Flatten for cross-entropy
365
+ #loss_fct = nn.CrossEntropyLoss(ignore_index=self.config.pad_token_id)
366
+ loss_fct = nn.CrossEntropyLoss(ignore_index=-100)
367
+ loss = loss_fct(
368
+ shift_logits.view(-1, shift_logits.size(-1)),
369
+ shift_labels.view(-1),
370
+ )
371
+
372
+ if not return_dict:
373
+ output = (logits,)
374
+ return ((loss,) + output) if loss is not None else output
375
+
376
+ return CausalLMOutputWithPast(
377
+ loss=loss,
378
+ logits=logits,
379
+ past_key_values=None,
380
+ hidden_states=None,
381
+ attentions=None,
382
+ )
383
+
384
+ @torch.no_grad()
385
+ def generate_move(
386
+ self,
387
+ input_ids: torch.LongTensor,
388
+ temperature: float = 1.0,
389
+ top_k: Optional[int] = None,
390
+ top_p: Optional[float] = None,
391
+ ) -> int:
392
+ """
393
+ Generate the next move given a sequence of moves.
394
+
395
+ Args:
396
+ input_ids: Token IDs of shape (1, seq_len).
397
+ temperature: Sampling temperature (1.0 = no change).
398
+ top_k: If set, only sample from top k tokens.
399
+ top_p: If set, use nucleus sampling with this threshold.
400
+
401
+ Returns:
402
+ The token ID of the predicted next move.
403
+ """
404
+ self.eval()
405
+
406
+ # Get logits for the last position
407
+ outputs = self(input_ids)
408
+ logits = outputs.logits[:, -1, :] / temperature
409
+
410
+ # Apply top-k filtering
411
+ if top_k is not None:
412
+ indices_to_remove = logits < torch.topk(logits, top_k)[0][..., -1, None]
413
+ logits[indices_to_remove] = float("-inf")
414
+
415
+ # Apply top-p (nucleus) filtering
416
+ if top_p is not None:
417
+ sorted_logits, sorted_indices = torch.sort(logits, descending=True)
418
+ cumulative_probs = torch.cumsum(F.softmax(sorted_logits, dim=-1), dim=-1)
419
+
420
+ # Remove tokens with cumulative probability above the threshold
421
+ sorted_indices_to_remove = cumulative_probs > top_p
422
+ sorted_indices_to_remove[..., 1:] = sorted_indices_to_remove[..., :-1].clone()
423
+ sorted_indices_to_remove[..., 0] = 0
424
+
425
+ indices_to_remove = sorted_indices_to_remove.scatter(
426
+ dim=-1, index=sorted_indices, src=sorted_indices_to_remove
427
+ )
428
+ logits[indices_to_remove] = float("-inf")
429
+
430
+ # Sample from the distribution
431
+ probs = F.softmax(logits, dim=-1)
432
+ next_token = torch.multinomial(probs, num_samples=1)
433
+
434
+ return next_token.item()
435
+
436
+
437
+ # Register the model with Auto classes for easy loading
438
+ from transformers import AutoConfig, AutoModelForCausalLM
439
+
440
+ AutoConfig.register("chess_transformer", ChessConfig)
441
+ AutoModelForCausalLM.register(ChessConfig, ChessForCausalLM)
tokenizer.py ADDED
@@ -0,0 +1,310 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ """
2
+ Custom Chess Tokenizer for the Chess Challenge.
3
+
4
+ This tokenizer treats each move as a single token using the extended UCI notation
5
+ from the Lichess dataset (e.g., WPe2e4, BNg8f6).
6
+
7
+ The dataset format uses:
8
+ - W/B prefix for White/Black
9
+ - Piece letter: P=Pawn, N=Knight, B=Bishop, R=Rook, Q=Queen, K=King
10
+ - Source and destination squares (e.g., e2e4)
11
+ - Special suffixes: (x)=capture, (+)=check, (+*)=checkmate, (o)/(O)=castling
12
+ """
13
+
14
+ from __future__ import annotations
15
+
16
+ import json
17
+ import os
18
+ from pathlib import Path
19
+ from typing import Dict, List, Optional
20
+ import re
21
+
22
+ from transformers import PreTrainedTokenizer
23
+
24
+
25
+ class ChessTokenizer(PreTrainedTokenizer):
26
+ """
27
+ A custom tokenizer for chess moves using extended UCI notation.
28
+
29
+ This tokenizer splits moves into semantic components (Pieces, Squares, Metadata).
30
+ Example: "WPe2e4" -> ["WP", "e2", "e4"]
31
+ """
32
+
33
+ model_input_names = ["input_ids", "attention_mask"]
34
+ vocab_files_names = {"vocab_file": "vocab.json"}
35
+
36
+ # Special tokens
37
+ PAD_TOKEN = "[PAD]"
38
+ BOS_TOKEN = "[BOS]"
39
+ EOS_TOKEN = "[EOS]"
40
+ UNK_TOKEN = "[UNK]"
41
+
42
+ def __init__(
43
+ self,
44
+ vocab_file: Optional[str] = None,
45
+ vocab: Optional[Dict[str, int]] = None,
46
+ **kwargs,
47
+ ):
48
+ """
49
+ Initialize the chess tokenizer.
50
+ """
51
+ # Initialize special tokens
52
+ self._pad_token = self.PAD_TOKEN
53
+ self._bos_token = self.BOS_TOKEN
54
+ self._eos_token = self.EOS_TOKEN
55
+ self._unk_token = self.UNK_TOKEN
56
+
57
+ # Clean kwargs
58
+ kwargs.pop("pad_token", None)
59
+ kwargs.pop("bos_token", None)
60
+ kwargs.pop("eos_token", None)
61
+ kwargs.pop("unk_token", None)
62
+
63
+ # Regex for splitting moves into:
64
+ # 1. Castling: (O), (o)
65
+ # 2. Metadata: (x), (+*), (+)
66
+ # 3. Pieces: WP, BR, etc.
67
+ # 4. Squares: a1, h8, etc.
68
+ self.token_pattern = re.compile(
69
+ r'\(O\)|\(o\)|' # Castling
70
+ r'\(x\)|\(\+\*\)|\(\+\)|' # Metadata (Capture, Mate, Check)
71
+ r'[WB][PRNBQK]|' # Pieces (Color + Type)
72
+ r'[a-h][1-8]' # Squares
73
+ )
74
+
75
+ # Load or create vocabulary
76
+ if vocab is not None:
77
+ self._vocab = vocab
78
+ elif vocab_file is not None and os.path.exists(vocab_file):
79
+ with open(vocab_file, "r", encoding="utf-8") as f:
80
+ self._vocab = json.load(f)
81
+ else:
82
+ # In this version, the default vocab is the FULL vocab
83
+ # because chess rules are static.
84
+ self._vocab = self._create_default_vocab()
85
+
86
+ # Create reverse mapping
87
+ self._ids_to_tokens = {v: k for k, v in self._vocab.items()}
88
+
89
+ super().__init__(
90
+ pad_token=self._pad_token,
91
+ bos_token=self._bos_token,
92
+ eos_token=self._eos_token,
93
+ unk_token=self._unk_token,
94
+ **kwargs,
95
+ )
96
+
97
+ def _create_default_vocab(self) -> Dict[str, int]:
98
+ """
99
+ Create the full static vocabulary for Chess.
100
+ Since the 'rules' of the tokens are known (squares a1-h8, pieces),
101
+ we generate the full map here instead of learning it.
102
+ """
103
+ # 1. Special Tokens
104
+ special_tokens = [self.PAD_TOKEN, self.BOS_TOKEN, self.EOS_TOKEN, self.UNK_TOKEN]
105
+ vocab = {token: idx for idx, token in enumerate(special_tokens)}
106
+ idx = len(vocab)
107
+
108
+ # 2. Pieces (White/Black + Pawn/Rook/Knight/Bishop/Queen/King)
109
+ colors = ['W', 'B']
110
+ pieces = ['P', 'R', 'N', 'B', 'Q', 'K']
111
+ for c in colors:
112
+ for p in pieces:
113
+ token = f"{c}{p}"
114
+ if token not in vocab:
115
+ vocab[token] = idx
116
+ idx += 1
117
+
118
+ # 3. Squares (a1 to h8)
119
+ files = 'abcdefgh'
120
+ ranks = '12345678'
121
+ for f in files:
122
+ for r in ranks:
123
+ token = f"{f}{r}"
124
+ if token not in vocab:
125
+ vocab[token] = idx
126
+ idx += 1
127
+
128
+ # 4. Special Move Suffixes
129
+ # Note: Order is handled by regex, but we just need them in vocab here
130
+ specials = ['(O)', '(o)', '(x)', '(+)', '(+*)']
131
+ for s in specials:
132
+ if s not in vocab:
133
+ vocab[s] = idx
134
+ idx += 1
135
+
136
+ return vocab
137
+
138
+ @classmethod
139
+ def build_vocab_from_iterator(
140
+ cls,
141
+ iterator: Iterator,
142
+ min_frequency: int = 1,
143
+ ) -> "ChessTokenizer":
144
+ """
145
+ API Compatibility Method.
146
+
147
+ Since this tokenizer uses a static vocabulary based on Chess rules,
148
+ scanning the iterator is not necessary. We simply consume the iterator
149
+ (optional) and return the standard tokenizer.
150
+ """
151
+ # We explicitly ignore the iterator data because our vocab
152
+ # is pre-defined by the rules of the game.
153
+ return cls()
154
+
155
+ @classmethod
156
+ def build_vocab_from_dataset(
157
+ cls,
158
+ dataset_name: str = "dlouapre/lichess_2025-01_1M",
159
+ split: str = "train",
160
+ column: str = "text",
161
+ min_frequency: int = 500,
162
+ max_samples: Optional[int] = 100000,
163
+ ) -> "ChessTokenizer":
164
+ """
165
+ API Compatibility Method.
166
+
167
+ Returns a tokenizer with the standard chess vocabulary.
168
+ Does not download the dataset as the vocabulary is static.
169
+ """
170
+ return cls()
171
+
172
+ @property
173
+ def vocab_size(self) -> int:
174
+ """Return the size of the vocabulary."""
175
+ return len(self._vocab)
176
+
177
+ def get_vocab(self) -> Dict[str, int]:
178
+ """Return the vocabulary as a dictionary."""
179
+ return dict(self._vocab)
180
+
181
+ def _tokenize(self, text: str) -> List[str]:
182
+ """
183
+ Tokenize a string of moves into semantic components using Regex.
184
+
185
+ Args:
186
+ text: A string of space-separated moves (e.g., "WPe2e4 BPe7e5")
187
+
188
+ Returns:
189
+ List of components (e.g., ["WP", "e2", "e4", "BP", "e7", "e5"])
190
+ """
191
+ # findall will ignore spaces and return only the matching components
192
+ return self.token_pattern.findall(text)
193
+
194
+ def _convert_token_to_id(self, token: str) -> int:
195
+ """Convert a token to its ID."""
196
+ return self._vocab.get(token, self._vocab.get(self.UNK_TOKEN))
197
+
198
+ def _convert_id_to_token(self, index: int) -> str:
199
+ """Convert an ID to its token."""
200
+ return self._ids_to_tokens.get(index, self.UNK_TOKEN)
201
+
202
+ def _is_start_of_move(self, token: str) -> bool:
203
+ """
204
+ Helper to determine if a token represents the start of a new move.
205
+ Moves start with a Piece (e.g., 'WP') or Castling (e.g., '(O)').
206
+ """
207
+ # 1. Check for Castling (Short or Long)
208
+ if token in ['(O)', '(o)']:
209
+ return True
210
+
211
+ # 2. Check for Pieces (Length 2, starts with W/B, ends with Piece type)
212
+ # We check specific characters to avoid confusion with squares or suffixes
213
+ if len(token) == 2 and token[0] in 'WB' and token[1] in 'PRNBQK':
214
+ return True
215
+
216
+ return False
217
+
218
+ def convert_tokens_to_string(self, tokens: List[str]) -> str:
219
+ """
220
+ Converts a list of tokens back to a string, respecting Chess notation rules.
221
+
222
+ Logic:
223
+ - Spaces are inserted BEFORE a token ONLY if that token marks the start of a new move.
224
+ - Squares (e2, e4) and Suffixes (x, +) are concatenated to the previous token.
225
+ """
226
+ output = []
227
+ special_tokens = {self.PAD_TOKEN, self.BOS_TOKEN, self.EOS_TOKEN, self.UNK_TOKEN}
228
+
229
+ for i, token in enumerate(tokens):
230
+ # 1. Handle Special Tokens (keep them, surround with spaces if needed)
231
+ if token in special_tokens:
232
+ if output and output[-1] != " ":
233
+ output.append(" ")
234
+ output.append(token)
235
+
236
+ # 2. Handle Start of New Move (Insert space before)
237
+ elif self._is_start_of_move(token):
238
+ # Add a space if we aren't at the very start and the previous char isn't already a space
239
+ if output and output[-1] != " ":
240
+ output.append(" ")
241
+ output.append(token)
242
+
243
+ # 3. Handle Continuations (Squares 'e2', Suffixes '(x)') -> Concatenate
244
+ else:
245
+ output.append(token)
246
+
247
+ return "".join(output).strip()
248
+
249
+ def save_vocabulary(
250
+ self,
251
+ save_directory: str,
252
+ filename_prefix: Optional[str] = None,
253
+ ) -> tuple:
254
+ """
255
+ Save the vocabulary to a JSON file.
256
+
257
+ Args:
258
+ save_directory: Directory to save the vocabulary.
259
+ filename_prefix: Optional prefix for the filename.
260
+
261
+ Returns:
262
+ Tuple containing the path to the saved vocabulary file.
263
+ """
264
+ if not os.path.isdir(save_directory):
265
+ os.makedirs(save_directory, exist_ok=True)
266
+
267
+ vocab_file = os.path.join(
268
+ save_directory,
269
+ (filename_prefix + "-" if filename_prefix else "") + "vocab.json",
270
+ )
271
+
272
+ with open(vocab_file, "w", encoding="utf-8") as f:
273
+ json.dump(self._vocab, f, ensure_ascii=False, indent=2)
274
+
275
+ return (vocab_file,)
276
+
277
+
278
+ def count_vocab_from_dataset(
279
+ dataset_name: str = "dlouapre/lichess_2025-01_1M",
280
+ split: str = "train",
281
+ column: str = "text",
282
+ max_samples: Optional[int] = 10000,
283
+ ) -> Dict[str, int]:
284
+ """
285
+ Count token frequencies in a dataset (useful for vocabulary analysis).
286
+
287
+ Args:
288
+ dataset_name: Name of the dataset on Hugging Face Hub.
289
+ split: Dataset split to use.
290
+ column: Column containing the game strings.
291
+ max_samples: Maximum number of samples to process.
292
+
293
+ Returns:
294
+ Dictionary mapping tokens to their frequencies.
295
+ """
296
+ from collections import Counter
297
+ from datasets import load_dataset
298
+
299
+ dataset = load_dataset(dataset_name, split=split)
300
+
301
+ if max_samples is not None:
302
+ dataset = dataset.select(range(min(max_samples, len(dataset))))
303
+
304
+ token_counts = Counter()
305
+
306
+ for example in dataset:
307
+ moves = example[column].strip().split()
308
+ token_counts.update(moves)
309
+
310
+ return dict(token_counts)