Mtanre commited on
Commit
dd62012
·
verified ·
1 Parent(s): 3adb514

Chess Challenge submission by Mtanre

Browse files
Files changed (8) hide show
  1. README.md +26 -0
  2. config.json +24 -0
  3. model.py +438 -0
  4. model.safetensors +3 -0
  5. special_tokens_map.json +6 -0
  6. tokenizer.py +346 -0
  7. tokenizer_config.json +50 -0
  8. vocab.json +87 -0
README.md ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ library_name: transformers
3
+ tags:
4
+ - chess
5
+ - llm-course
6
+ - chess-challenge
7
+ license: mit
8
+ ---
9
+
10
+ # chess-mtanre-v2
11
+
12
+ Chess model submitted to the LLM Course Chess Challenge.
13
+
14
+ ## Submission Info
15
+
16
+ - **Submitted by**: [Mtanre](https://huggingface.co/Mtanre)
17
+ - **Parameters**: 1,003,900
18
+ - **Organization**: LLM-course
19
+
20
+ ## Model Details
21
+
22
+ - **Architecture**: Chess Transformer (GPT-style)
23
+ - **Vocab size**: 85
24
+ - **Embedding dim**: 124
25
+ - **Layers**: 6
26
+ - **Heads**: 4
config.json ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
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",
12
+ "eos_token_id": 2,
13
+ "layer_norm_epsilon": 1e-05,
14
+ "model_type": "chess_transformer",
15
+ "n_ctx": 256,
16
+ "n_embd": 124,
17
+ "n_head": 4,
18
+ "n_inner": 392,
19
+ "n_layer": 6,
20
+ "pad_token_id": 0,
21
+ "tie_weights": true,
22
+ "transformers_version": "4.57.3",
23
+ "vocab_size": 85
24
+ }
model.py ADDED
@@ -0,0 +1,438 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ if labels is not None:
357
+ # Shift logits and labels for next-token prediction
358
+ shift_logits = logits[..., :-1, :].contiguous()
359
+ shift_labels = labels[..., 1:].contiguous()
360
+
361
+ # Flatten for cross-entropy
362
+ loss_fct = nn.CrossEntropyLoss(ignore_index=-100)
363
+ # loss_fct = nn.CrossEntropyLoss(ignore_index=self.config.pad_token_id)
364
+ loss = loss_fct(
365
+ shift_logits.view(-1, shift_logits.size(-1)),
366
+ shift_labels.view(-1),
367
+ )
368
+
369
+ if not return_dict:
370
+ output = (logits,)
371
+ return ((loss,) + output) if loss is not None else output
372
+
373
+ return CausalLMOutputWithPast(
374
+ loss=loss,
375
+ logits=logits,
376
+ past_key_values=None,
377
+ hidden_states=None,
378
+ attentions=None,
379
+ )
380
+
381
+ @torch.no_grad()
382
+ def generate_move(
383
+ self,
384
+ input_ids: torch.LongTensor,
385
+ temperature: float = 1.0,
386
+ top_k: Optional[int] = None,
387
+ top_p: Optional[float] = None,
388
+ ) -> int:
389
+ """
390
+ Generate the next move given a sequence of moves.
391
+
392
+ Args:
393
+ input_ids: Token IDs of shape (1, seq_len).
394
+ temperature: Sampling temperature (1.0 = no change).
395
+ top_k: If set, only sample from top k tokens.
396
+ top_p: If set, use nucleus sampling with this threshold.
397
+
398
+ Returns:
399
+ The token ID of the predicted next move.
400
+ """
401
+ self.eval()
402
+
403
+ # Get logits for the last position
404
+ outputs = self(input_ids)
405
+ logits = outputs.logits[:, -1, :] / temperature
406
+
407
+ # Apply top-k filtering
408
+ if top_k is not None:
409
+ indices_to_remove = logits < torch.topk(logits, top_k)[0][..., -1, None]
410
+ logits[indices_to_remove] = float("-inf")
411
+
412
+ # Apply top-p (nucleus) filtering
413
+ if top_p is not None:
414
+ sorted_logits, sorted_indices = torch.sort(logits, descending=True)
415
+ cumulative_probs = torch.cumsum(F.softmax(sorted_logits, dim=-1), dim=-1)
416
+
417
+ # Remove tokens with cumulative probability above the threshold
418
+ sorted_indices_to_remove = cumulative_probs > top_p
419
+ sorted_indices_to_remove[..., 1:] = sorted_indices_to_remove[..., :-1].clone()
420
+ sorted_indices_to_remove[..., 0] = 0
421
+
422
+ indices_to_remove = sorted_indices_to_remove.scatter(
423
+ dim=-1, index=sorted_indices, src=sorted_indices_to_remove
424
+ )
425
+ logits[indices_to_remove] = float("-inf")
426
+
427
+ # Sample from the distribution
428
+ probs = F.softmax(logits, dim=-1)
429
+ next_token = torch.multinomial(probs, num_samples=1)
430
+
431
+ return next_token.item()
432
+
433
+
434
+ # Register the model with Auto classes for easy loading
435
+ from transformers import AutoConfig, AutoModelForCausalLM
436
+
437
+ AutoConfig.register("chess_transformer", ChessConfig)
438
+ AutoModelForCausalLM.register(ChessConfig, ChessForCausalLM)
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:f78e205e32d0d78ddca94ab3ae67b46f60ed99ec9e6679c28057ee6ee51f3e38
3
+ size 4022048
special_tokens_map.json ADDED
@@ -0,0 +1,6 @@
 
 
 
 
 
 
 
1
+ {
2
+ "bos_token": "[BOS]",
3
+ "eos_token": "[EOS]",
4
+ "pad_token": "[PAD]",
5
+ "unk_token": "[UNK]"
6
+ }
tokenizer.py ADDED
@@ -0,0 +1,346 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ """
2
+ Chess Move Tokenizer - Component-based approach.
3
+
4
+ This tokenizer decomposes chess moves into atomic components for efficient
5
+ representation. Each move is broken down into: color, piece type, source square,
6
+ destination square, and optional annotations (capture, check, promotion, etc.).
7
+
8
+ The vocabulary is built from atomic components rather than full moves, which
9
+ allows for better generalization and a smaller vocabulary size.
10
+ """
11
+
12
+ from __future__ import annotations
13
+
14
+ import json
15
+ import os
16
+ from pathlib import Path
17
+ from typing import Dict, List, Optional
18
+
19
+ import re
20
+ from transformers import PreTrainedTokenizer
21
+
22
+
23
+ # Regular expression to parse extended UCI move notation
24
+ # Format: [W|B][Piece][from_square][to_square][optional_suffixes]
25
+ MOVE_PATTERN = re.compile(
26
+ r"^(?P<side>[WB])"
27
+ r"(?P<piece>[PNBRQK])"
28
+ r"(?P<src>[a-h][1-8])"
29
+ r"(?P<dst>[a-h][1-8])"
30
+ r"(?P<suffix>.*)$"
31
+ )
32
+
33
+
34
+ class ChessTokenizer(PreTrainedTokenizer):
35
+ """
36
+ Component-based chess move tokenizer.
37
+
38
+ Instead of treating each complete move as a single token, this tokenizer
39
+ breaks down moves into atomic components (color, piece, squares, annotations).
40
+ This approach results in a much smaller vocabulary while maintaining
41
+ the ability to represent all possible chess moves.
42
+
43
+ Example usage:
44
+ >>> tokenizer = ChessTokenizer()
45
+ >>> tokens = tokenizer._tokenize("WPe2e4 BPe7e5")
46
+ >>> # Returns: ['[W]', '[P]', '[e2]', '[e4]', '[B]', '[P]', '[e7]', '[e5]']
47
+ """
48
+
49
+ model_input_names = ["input_ids", "attention_mask"]
50
+ vocab_files_names = {"vocab_file": "vocab.json"}
51
+
52
+ # Special tokens
53
+ PAD_TOKEN = "[PAD]"
54
+ BOS_TOKEN = "[BOS]"
55
+ EOS_TOKEN = "[EOS]"
56
+ UNK_TOKEN = "[UNK]"
57
+
58
+ def __init__(
59
+ self,
60
+ vocab_file: Optional[str] = None,
61
+ vocab: Optional[Dict[str, int]] = None,
62
+ **kwargs,
63
+ ):
64
+ """
65
+ Initialize the chess tokenizer.
66
+
67
+ Args:
68
+ vocab_file: Path to a JSON file containing the vocabulary mapping.
69
+ vocab: Dictionary mapping tokens to IDs (alternative to vocab_file).
70
+ **kwargs: Additional arguments passed to PreTrainedTokenizer.
71
+ """
72
+ # Set up special token strings
73
+ self._pad_token = self.PAD_TOKEN
74
+ self._bos_token = self.BOS_TOKEN
75
+ self._eos_token = self.EOS_TOKEN
76
+ self._unk_token = self.UNK_TOKEN
77
+
78
+ # Clean kwargs to prevent conflicts with special tokens
79
+ # This avoids errors when loading saved tokenizers
80
+ for token_key in ["pad_token", "bos_token", "eos_token", "unk_token"]:
81
+ kwargs.pop(token_key, None)
82
+
83
+ # Initialize vocabulary from provided source or create default
84
+ if vocab is not None:
85
+ self._vocab = vocab
86
+ elif vocab_file is not None and os.path.exists(vocab_file):
87
+ with open(vocab_file, "r", encoding="utf-8") as f:
88
+ self._vocab = json.load(f)
89
+ else:
90
+ # Fallback: create minimal vocabulary with component tokens
91
+ self._vocab = self._create_default_vocab()
92
+
93
+ # Build reverse lookup: token_id -> token_string
94
+ self._ids_to_tokens = {v: k for k, v in self._vocab.items()}
95
+
96
+ # Call parent init AFTER setting up vocab
97
+ super().__init__(
98
+ pad_token=self._pad_token,
99
+ bos_token=self._bos_token,
100
+ eos_token=self._eos_token,
101
+ unk_token=self._unk_token,
102
+ **kwargs,
103
+ )
104
+
105
+ def _create_default_vocab(self) -> Dict[str, int]:
106
+ """
107
+ Construct the default component-based vocabulary.
108
+
109
+ Creates a vocabulary from atomic chess move components:
110
+ - Special tokens (padding, start, end, unknown)
111
+ - Color indicators (White/Black)
112
+ - Piece types (Pawn, Knight, Bishop, Rook, Queen, King)
113
+ - Board squares (64 squares: a1-h8)
114
+ - Move annotations (capture, check, checkmate, castling, promotions)
115
+ """
116
+ # Core special tokens
117
+ special_tokens = [self.PAD_TOKEN, self.BOS_TOKEN, self.EOS_TOKEN, self.UNK_TOKEN]
118
+
119
+ # Player color indicators
120
+ color_tokens = ["[W]", "[B]"]
121
+
122
+ # Chess piece types (note: Bishop uses [BISHOP] to avoid conflict with [B])
123
+ piece_tokens = ["[P]", "[N]", "[BISHOP]", "[R]", "[Q]", "[K]"]
124
+
125
+ # All 64 chess board squares
126
+ square_tokens = [f"[{file}{rank}]" for rank in "12345678" for file in "abcdefgh"]
127
+
128
+ # Move annotations: capture, check, checkmate, castling, promotions
129
+ annotation_tokens = ["[x]", "[+]", "[#]", "[O-O]", "[O-O-O]",
130
+ "[prom_Q]", "[prom_R]", "[prom_B]", "[prom_N]"]
131
+
132
+ # Combine all components into vocabulary
133
+ all_tokens = special_tokens + color_tokens + piece_tokens + square_tokens + annotation_tokens
134
+ vocab = {token: idx for idx, token in enumerate(all_tokens)}
135
+ return vocab
136
+
137
+ @classmethod
138
+ def build_vocab_from_iterator(
139
+ cls,
140
+ iterator,
141
+ min_frequency: int = 1,
142
+ ) -> "ChessTokenizer":
143
+ """
144
+ Build a tokenizer vocabulary from an iterator of game strings.
145
+
146
+ Args:
147
+ iterator: An iterator yielding game strings (space-separated moves).
148
+ min_frequency: Minimum frequency for a token to be included.
149
+
150
+ Returns:
151
+ A ChessTokenizer with the built vocabulary.
152
+ """
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
+ Build a tokenizer vocabulary from a Hugging Face dataset.
166
+
167
+ Args:
168
+ dataset_name: Name of the dataset on Hugging Face Hub.
169
+ split: Dataset split to use.
170
+ column: Column containing the game strings.
171
+ min_frequency: Minimum frequency for a token to be included (default: 500).
172
+ max_samples: Maximum number of samples to process (default: 100k).
173
+
174
+ Returns:
175
+ A ChessTokenizer with the built vocabulary.
176
+ """
177
+ return cls()
178
+
179
+ @property
180
+ def vocab_size(self) -> int:
181
+ """Return the size of the vocabulary."""
182
+ return len(self._vocab)
183
+
184
+ def get_vocab(self) -> Dict[str, int]:
185
+ """Return the vocabulary as a dictionary."""
186
+ return dict(self._vocab)
187
+
188
+ def _tokenize(self, text: str) -> List[str]:
189
+ """
190
+ Decompose chess moves into component tokens.
191
+
192
+ Parses each move and breaks it down into atomic components:
193
+ color, piece, source square, destination square, and annotations.
194
+
195
+ Args:
196
+ text: Space-separated sequence of moves in extended UCI format.
197
+
198
+ Returns:
199
+ List of component tokens representing the moves.
200
+ """
201
+ token_list: List[str] = []
202
+ move_sequence = text.strip().split()
203
+
204
+ for move_str in move_sequence:
205
+ # Handle queenside castling (long castling)
206
+ if "O-O-O" in move_str:
207
+ player_color = "[W]" if move_str.startswith("W") else "[B]"
208
+ token_list.append(player_color)
209
+ token_list.append("[O-O-O]")
210
+ continue
211
+
212
+ # Handle kingside castling (short castling)
213
+ if "O-O" in move_str:
214
+ player_color = "[W]" if move_str.startswith("W") else "[B]"
215
+ token_list.append(player_color)
216
+ token_list.append("[O-O]")
217
+ continue
218
+
219
+ # Parse standard moves using regex
220
+ match = MOVE_PATTERN.match(move_str)
221
+ if not match:
222
+ token_list.append(self.UNK_TOKEN)
223
+ continue
224
+
225
+ # Extract move components
226
+ player_color = "[W]" if match.group("side") == "W" else "[B]"
227
+ piece_type = match.group("piece")
228
+ from_square = match.group("src")
229
+ to_square = match.group("dst")
230
+ move_annotations = match.group("suffix") or ""
231
+
232
+ # Add color and piece
233
+ token_list.append(player_color)
234
+
235
+ # Handle Bishop separately (B conflicts with Black)
236
+ if piece_type == "B":
237
+ token_list.append("[BISHOP]")
238
+ else:
239
+ token_list.append(f"[{piece_type}]")
240
+
241
+ # Add squares
242
+ token_list.append(f"[{from_square}]")
243
+ token_list.append(f"[{to_square}]")
244
+
245
+ # Process annotations
246
+ if "x" in move_annotations:
247
+ token_list.append("[x]") # Capture
248
+
249
+ # Check/checkmate (checkmate takes priority)
250
+ if "*" in move_annotations:
251
+ token_list.append("[#]") # Checkmate
252
+ elif "+" in move_annotations:
253
+ token_list.append("[+]") # Check
254
+
255
+ # Promotion
256
+ if "=" in move_annotations:
257
+ promo_idx = move_annotations.find("=")
258
+ if promo_idx != -1 and promo_idx + 1 < len(move_annotations):
259
+ promoted_piece = move_annotations[promo_idx + 1].upper()
260
+ if promoted_piece in ("Q", "R", "B", "N"):
261
+ token_list.append(f"[prom_{promoted_piece}]")
262
+
263
+ return token_list
264
+
265
+ def _convert_token_to_id(self, token: str) -> int:
266
+ """Map token string to its vocabulary ID."""
267
+ return self._vocab.get(token, self._vocab.get(self.UNK_TOKEN, 0))
268
+
269
+ def _convert_id_to_token(self, index: int) -> str:
270
+ """Map vocabulary ID back to token string."""
271
+ return self._ids_to_tokens.get(index, self.UNK_TOKEN)
272
+
273
+ def convert_tokens_to_string(self, tokens: List[str]) -> str:
274
+ """Reconstruct string from token list, filtering special tokens."""
275
+ special_token_set = {self.PAD_TOKEN, self.BOS_TOKEN, self.EOS_TOKEN, self.UNK_TOKEN}
276
+ return " ".join(t for t in tokens if t not in special_token_set)
277
+
278
+ def save_vocabulary(
279
+ self,
280
+ save_directory: str,
281
+ filename_prefix: Optional[str] = None,
282
+ ) -> tuple:
283
+ """
284
+ Save the vocabulary to a JSON file.
285
+
286
+ Args:
287
+ save_directory: Directory to save the vocabulary.
288
+ filename_prefix: Optional prefix for the filename.
289
+
290
+ Returns:
291
+ Tuple containing the path to the saved vocabulary file.
292
+ """
293
+ if not os.path.isdir(save_directory):
294
+ os.makedirs(save_directory, exist_ok=True)
295
+
296
+ vocab_file = os.path.join(
297
+ save_directory,
298
+ (filename_prefix + "-" if filename_prefix else "") + "vocab.json",
299
+ )
300
+
301
+ with open(vocab_file, "w", encoding="utf-8") as f:
302
+ json.dump(self._vocab, f, ensure_ascii=False, indent=2)
303
+
304
+ return (vocab_file,)
305
+
306
+
307
+ def count_vocab_from_dataset(
308
+ dataset_name: str = "dlouapre/lichess_2025-01_1M",
309
+ split: str = "train",
310
+ column: str = "text",
311
+ max_samples: Optional[int] = 10000,
312
+ ) -> Dict[str, int]:
313
+ """
314
+ Analyze token frequency distribution in the dataset.
315
+
316
+ Useful for understanding which components appear most frequently
317
+ and for vocabulary size planning.
318
+
319
+ Args:
320
+ dataset_name: HuggingFace dataset identifier.
321
+ split: Which dataset split to analyze.
322
+ column: Column name containing the game sequences.
323
+ max_samples: Limit number of samples for faster analysis.
324
+
325
+ Returns:
326
+ Frequency dictionary: token -> count.
327
+ """
328
+ from collections import Counter
329
+ from datasets import load_dataset
330
+
331
+ # Load dataset
332
+ dataset = load_dataset(dataset_name, split=split)
333
+
334
+ # Limit samples if requested
335
+ if max_samples is not None:
336
+ dataset = dataset.select(range(min(max_samples, len(dataset))))
337
+
338
+ # Count component frequencies
339
+ tokenizer = ChessTokenizer()
340
+ frequency_counter = Counter()
341
+
342
+ for sample in dataset:
343
+ component_tokens = tokenizer._tokenize(sample[column])
344
+ frequency_counter.update(component_tokens)
345
+
346
+ return dict(frequency_counter)
tokenizer_config.json ADDED
@@ -0,0 +1,50 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "added_tokens_decoder": {
3
+ "0": {
4
+ "content": "[PAD]",
5
+ "lstrip": false,
6
+ "normalized": false,
7
+ "rstrip": false,
8
+ "single_word": false,
9
+ "special": true
10
+ },
11
+ "1": {
12
+ "content": "[BOS]",
13
+ "lstrip": false,
14
+ "normalized": false,
15
+ "rstrip": false,
16
+ "single_word": false,
17
+ "special": true
18
+ },
19
+ "2": {
20
+ "content": "[EOS]",
21
+ "lstrip": false,
22
+ "normalized": false,
23
+ "rstrip": false,
24
+ "single_word": false,
25
+ "special": true
26
+ },
27
+ "3": {
28
+ "content": "[UNK]",
29
+ "lstrip": false,
30
+ "normalized": false,
31
+ "rstrip": false,
32
+ "single_word": false,
33
+ "special": true
34
+ }
35
+ },
36
+ "auto_map": {
37
+ "AutoTokenizer": [
38
+ "tokenizer.ChessTokenizer",
39
+ null
40
+ ]
41
+ },
42
+ "bos_token": "[BOS]",
43
+ "clean_up_tokenization_spaces": false,
44
+ "eos_token": "[EOS]",
45
+ "extra_special_tokens": {},
46
+ "model_max_length": 1000000000000000019884624838656,
47
+ "pad_token": "[PAD]",
48
+ "tokenizer_class": "ChessTokenizer",
49
+ "unk_token": "[UNK]"
50
+ }
vocab.json ADDED
@@ -0,0 +1,87 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "[PAD]": 0,
3
+ "[BOS]": 1,
4
+ "[EOS]": 2,
5
+ "[UNK]": 3,
6
+ "[W]": 4,
7
+ "[B]": 5,
8
+ "[P]": 6,
9
+ "[N]": 7,
10
+ "[BISHOP]": 8,
11
+ "[R]": 9,
12
+ "[Q]": 10,
13
+ "[K]": 11,
14
+ "[a1]": 12,
15
+ "[b1]": 13,
16
+ "[c1]": 14,
17
+ "[d1]": 15,
18
+ "[e1]": 16,
19
+ "[f1]": 17,
20
+ "[g1]": 18,
21
+ "[h1]": 19,
22
+ "[a2]": 20,
23
+ "[b2]": 21,
24
+ "[c2]": 22,
25
+ "[d2]": 23,
26
+ "[e2]": 24,
27
+ "[f2]": 25,
28
+ "[g2]": 26,
29
+ "[h2]": 27,
30
+ "[a3]": 28,
31
+ "[b3]": 29,
32
+ "[c3]": 30,
33
+ "[d3]": 31,
34
+ "[e3]": 32,
35
+ "[f3]": 33,
36
+ "[g3]": 34,
37
+ "[h3]": 35,
38
+ "[a4]": 36,
39
+ "[b4]": 37,
40
+ "[c4]": 38,
41
+ "[d4]": 39,
42
+ "[e4]": 40,
43
+ "[f4]": 41,
44
+ "[g4]": 42,
45
+ "[h4]": 43,
46
+ "[a5]": 44,
47
+ "[b5]": 45,
48
+ "[c5]": 46,
49
+ "[d5]": 47,
50
+ "[e5]": 48,
51
+ "[f5]": 49,
52
+ "[g5]": 50,
53
+ "[h5]": 51,
54
+ "[a6]": 52,
55
+ "[b6]": 53,
56
+ "[c6]": 54,
57
+ "[d6]": 55,
58
+ "[e6]": 56,
59
+ "[f6]": 57,
60
+ "[g6]": 58,
61
+ "[h6]": 59,
62
+ "[a7]": 60,
63
+ "[b7]": 61,
64
+ "[c7]": 62,
65
+ "[d7]": 63,
66
+ "[e7]": 64,
67
+ "[f7]": 65,
68
+ "[g7]": 66,
69
+ "[h7]": 67,
70
+ "[a8]": 68,
71
+ "[b8]": 69,
72
+ "[c8]": 70,
73
+ "[d8]": 71,
74
+ "[e8]": 72,
75
+ "[f8]": 73,
76
+ "[g8]": 74,
77
+ "[h8]": 75,
78
+ "[x]": 76,
79
+ "[+]": 77,
80
+ "[#]": 78,
81
+ "[O-O]": 79,
82
+ "[O-O-O]": 80,
83
+ "[prom_Q]": 81,
84
+ "[prom_R]": 82,
85
+ "[prom_B]": 83,
86
+ "[prom_N]": 84
87
+ }