swdo commited on
Commit
17f97be
·
verified ·
1 Parent(s): 06d4824

Chess Challenge submission by swdo

Browse files
Files changed (8) hide show
  1. README.md +26 -0
  2. config.json +24 -0
  3. model.py +437 -0
  4. model.safetensors +3 -0
  5. special_tokens_map.json +6 -0
  6. tokenizer.py +413 -0
  7. tokenizer_config.json +11 -0
  8. vocab.json +90 -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_swdo_s1
11
+
12
+ Chess model submitted to the LLM Course Chess Challenge.
13
+
14
+ ## Submission Info
15
+
16
+ - **Submitted by**: [swdo](https://huggingface.co/swdo)
17
+ - **Parameters**: 871,168
18
+ - **Organization**: LLM-course
19
+
20
+ ## Model Details
21
+
22
+ - **Architecture**: Chess Transformer (GPT-style)
23
+ - **Vocab size**: 88
24
+ - **Embedding dim**: 128
25
+ - **Layers**: 5
26
+ - **Heads**: 4
config.json ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "architectures": [
3
+ "ChessForCausalLM"
4
+ ],
5
+ "bos_token_id": 1,
6
+ "dropout": 0.1,
7
+ "dtype": "float32",
8
+ "eos_token_id": 2,
9
+ "layer_norm_epsilon": 1e-05,
10
+ "model_type": "chess_transformer",
11
+ "n_ctx": 256,
12
+ "n_embd": 128,
13
+ "n_head": 4,
14
+ "n_inner": 384,
15
+ "n_layer": 5,
16
+ "pad_token_id": 0,
17
+ "tie_weights": true,
18
+ "transformers_version": "4.57.3",
19
+ "vocab_size": 88,
20
+ "auto_map": {
21
+ "AutoConfig": "model.ChessConfig",
22
+ "AutoModelForCausalLM": "model.ChessForCausalLM"
23
+ }
24
+ }
model.py ADDED
@@ -0,0 +1,437 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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) #self.config.pad_token_id)
363
+ loss = loss_fct(
364
+ shift_logits.view(-1, shift_logits.size(-1)),
365
+ shift_labels.view(-1),
366
+ )
367
+
368
+ if not return_dict:
369
+ output = (logits,)
370
+ return ((loss,) + output) if loss is not None else output
371
+
372
+ return CausalLMOutputWithPast(
373
+ loss=loss,
374
+ logits=logits,
375
+ past_key_values=None,
376
+ hidden_states=None,
377
+ attentions=None,
378
+ )
379
+
380
+ @torch.no_grad()
381
+ def generate_move(
382
+ self,
383
+ input_ids: torch.LongTensor,
384
+ temperature: float = 1.0,
385
+ top_k: Optional[int] = None,
386
+ top_p: Optional[float] = None,
387
+ ) -> int:
388
+ """
389
+ Generate the next move given a sequence of moves.
390
+
391
+ Args:
392
+ input_ids: Token IDs of shape (1, seq_len).
393
+ temperature: Sampling temperature (1.0 = no change).
394
+ top_k: If set, only sample from top k tokens.
395
+ top_p: If set, use nucleus sampling with this threshold.
396
+
397
+ Returns:
398
+ The token ID of the predicted next move.
399
+ """
400
+ self.eval()
401
+
402
+ # Get logits for the last position
403
+ outputs = self(input_ids)
404
+ logits = outputs.logits[:, -1, :] / temperature
405
+
406
+ # Apply top-k filtering
407
+ if top_k is not None:
408
+ indices_to_remove = logits < torch.topk(logits, top_k)[0][..., -1, None]
409
+ logits[indices_to_remove] = float("-inf")
410
+
411
+ # Apply top-p (nucleus) filtering
412
+ if top_p is not None:
413
+ sorted_logits, sorted_indices = torch.sort(logits, descending=True)
414
+ cumulative_probs = torch.cumsum(F.softmax(sorted_logits, dim=-1), dim=-1)
415
+
416
+ # Remove tokens with cumulative probability above the threshold
417
+ sorted_indices_to_remove = cumulative_probs > top_p
418
+ sorted_indices_to_remove[..., 1:] = sorted_indices_to_remove[..., :-1].clone()
419
+ sorted_indices_to_remove[..., 0] = 0
420
+
421
+ indices_to_remove = sorted_indices_to_remove.scatter(
422
+ dim=-1, index=sorted_indices, src=sorted_indices_to_remove
423
+ )
424
+ logits[indices_to_remove] = float("-inf")
425
+
426
+ # Sample from the distribution
427
+ probs = F.softmax(logits, dim=-1)
428
+ next_token = torch.multinomial(probs, num_samples=1)
429
+
430
+ return next_token.item()
431
+
432
+
433
+ # Register the model with Auto classes for easy loading
434
+ from transformers import AutoConfig, AutoModelForCausalLM
435
+
436
+ AutoConfig.register("chess_transformer", ChessConfig)
437
+ AutoModelForCausalLM.register(ChessConfig, ChessForCausalLM)
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:02aaa4f1c65a9dc94d710f1071176353e932da7f89b161579755aa4c93adcc71
3
+ size 3490096
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,413 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ from __future__ import annotations
4
+
5
+ import json
6
+ import os
7
+ import re
8
+ from pathlib import Path
9
+ from typing import Dict, List, Optional, Tuple
10
+
11
+ from transformers import PreTrainedTokenizer
12
+
13
+
14
+ class ChessTokenizer(PreTrainedTokenizer):
15
+ """
16
+ A custom tokenizer
17
+
18
+ Example:
19
+ >>> tokenizer = ChessTokenizer()
20
+ >>> tokenizer.encode("WPe2e4 BPe7e5")
21
+ [1, 4, 6, 45, 47, 5, 6, 50, 48, 2] # [BOS, components..., EOS]
22
+ """
23
+
24
+ model_input_names = ["input_ids", "attention_mask"]
25
+ vocab_files_names = {"vocab_file": "vocab.json"}
26
+
27
+ # Special tokens
28
+ PAD_TOKEN = "[PAD]"
29
+ BOS_TOKEN = "[BOS]"
30
+ EOS_TOKEN = "[EOS]"
31
+ UNK_TOKEN = "[UNK]"
32
+
33
+ # Chess components
34
+ COLORS = ["[W]", "[B]"]
35
+ PIECES = ["P", "N", "B", "R", "Q", "K"]
36
+ FILES = ["a", "b", "c", "d", "e", "f", "g", "h"]
37
+ RANKS = ["1", "2", "3", "4", "5", "6", "7", "8"]
38
+ SQUARES = [f + r for f in FILES for r in ["1", "2", "3", "4", "5", "6", "7", "8"]]
39
+
40
+ MODIFIERS = [
41
+ "x", # Capture
42
+ "+", # Check
43
+ "#", # Checkmate (alternative to +*)
44
+ "+*", # Checkmate (dataset format)
45
+ "=Q", # Promotion to Queen
46
+ "=R", # Promotion to Rook
47
+ "=B", # Promotion to Bishop
48
+ "=N", # Promotion to Knight
49
+ "O-O", # Kingside castling (alternative)
50
+ "O-O-O", # Queenside castling (alternative)
51
+ "o", # Kingside castling (dataset format)
52
+ "O", # Queenside castling (dataset format)
53
+ ]
54
+
55
+ MOVE_PATTERN = re.compile(
56
+ r'^([WB])' # Color
57
+ r'([PNBRQK])' # Piece
58
+ r'([a-h][1-8])' # From square
59
+ r'([a-h][1-8])' # To square
60
+ r'(=[QRBN])?' # Promotion (optional)
61
+ r'(\([xoO+*]+\))?$' # Suffixes in parentheses (optional)
62
+ )
63
+
64
+ def __init__(
65
+ self,
66
+ vocab_file: Optional[str] = None,
67
+ vocab: Optional[Dict[str, int]] = None,
68
+ **kwargs,
69
+ ):
70
+
71
+
72
+ self._pad_token = self.PAD_TOKEN
73
+ self._bos_token = self.BOS_TOKEN
74
+ self._eos_token = self.EOS_TOKEN
75
+ self._unk_token = self.UNK_TOKEN
76
+
77
+ # Remove any duplicate
78
+ kwargs.pop("pad_token", None)
79
+ kwargs.pop("bos_token", None)
80
+ kwargs.pop("eos_token", None)
81
+ kwargs.pop("unk_token", None)
82
+
83
+ # Load or create vocabulary
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
+ # Create the fixed decomposed vocabulary
91
+ self._vocab = self._create_default_vocab()
92
+
93
+ # Create reverse mapping
94
+ self._ids_to_tokens = {v: k for k, v in self._vocab.items()}
95
+
96
+ super().__init__(
97
+ pad_token=self._pad_token,
98
+ bos_token=self._bos_token,
99
+ eos_token=self._eos_token,
100
+ unk_token=self._unk_token,
101
+ **kwargs,
102
+ )
103
+
104
+ def _create_default_vocab(self) -> Dict[str, int]:
105
+ """
106
+ Create the fixed vocabulary from chess components.
107
+
108
+ Unlike the standard tokenizer, this creates a small fixed vocab
109
+ of ~88 tokens for decomposed move representation.
110
+ """
111
+ tokens = []
112
+
113
+ # Special tokens first
114
+ tokens.extend([self.PAD_TOKEN, self.BOS_TOKEN, self.EOS_TOKEN, self.UNK_TOKEN])
115
+
116
+ # Colors
117
+ tokens.extend(self.COLORS)
118
+
119
+ # Pieces
120
+ tokens.extend(self.PIECES)
121
+
122
+ # Squares (64)
123
+ tokens.extend(self.SQUARES)
124
+
125
+ # Modifiers
126
+ tokens.extend(self.MODIFIERS)
127
+
128
+ return {token: idx for idx, token in enumerate(tokens)}
129
+
130
+ @classmethod
131
+ def build_vocab_from_iterator(
132
+ cls,
133
+ iterator,
134
+ min_frequency: int = 1,
135
+ ) -> "ChessTokenizer":
136
+ """
137
+ Build a tokenizer vocabulary from an iterator of game strings.
138
+
139
+ Note: For decomposed tokenizer, this ignores the iterator and
140
+ creates the fixed vocabulary. Provided for API compatibility.
141
+
142
+ Args:
143
+ iterator: An iterator yielding game strings (ignored).
144
+ min_frequency: Minimum frequency for a token (ignored).
145
+
146
+ Returns:
147
+ A ChessTokenizer with the fixed decomposed vocabulary.
148
+ """
149
+ # Decomposed tokenizer uses fixed vocabulary
150
+ return cls()
151
+
152
+ @classmethod
153
+ def build_vocab_from_dataset(
154
+ cls,
155
+ dataset_name: str = "dlouapre/lichess_2025-01_1M",
156
+ split: str = "train",
157
+ column: str = "moves",
158
+ min_frequency: int = 1,
159
+ max_samples: Optional[int] = None,
160
+ ) -> "ChessTokenizer":
161
+ """
162
+ Build a tokenizer vocabulary from a Hugging Face dataset.
163
+
164
+ Note: For decomposed tokenizer, this ignores the dataset and
165
+ creates the fixed vocabulary. Provided for API compatibility.
166
+
167
+ Args:
168
+ dataset_name: Name of the dataset on Hugging Face Hub (ignored).
169
+ split: Dataset split to use (ignored).
170
+ column: Column containing move strings (ignored).
171
+ min_frequency: Minimum frequency for inclusion (ignored).
172
+ max_samples: Maximum samples to process (ignored).
173
+
174
+ Returns:
175
+ A ChessTokenizer with the fixed decomposed vocabulary.
176
+ """
177
+ print(f"Note: Decomposed tokenizer uses fixed vocabulary (~88 tokens)")
178
+ return cls()
179
+
180
+ @property
181
+ def vocab_size(self) -> int:
182
+ return len(self._vocab)
183
+
184
+ def get_vocab(self) -> Dict[str, int]:
185
+ return dict(self._vocab)
186
+
187
+ def _parse_move(self, move: str) -> List[str]:
188
+ """
189
+ Parse a single move into component tokens.
190
+
191
+ Args:
192
+ move: Move in extended UCI format (e.g., "WPe2e4", "BNg8f6(x+)")
193
+
194
+ Returns:
195
+ List of component tokens.
196
+ """
197
+ match = self.MOVE_PATTERN.match(move)
198
+
199
+ if not match:
200
+ return [self.UNK_TOKEN]
201
+
202
+ tokens = []
203
+
204
+ # Color - map 'W' -> '[W]' and 'B' -> '[B]'
205
+ color = match.group(1)
206
+ tokens.append(f"[{color}]")
207
+
208
+ # Piece
209
+ tokens.append(match.group(2))
210
+
211
+ # From square
212
+ tokens.append(match.group(3))
213
+
214
+ # To square
215
+ tokens.append(match.group(4))
216
+
217
+ # Promotion (optional)
218
+ if match.group(5):
219
+ tokens.append(match.group(5))
220
+
221
+ # Parse suffixes (optional)
222
+ if match.group(6):
223
+ suffix = match.group(6)
224
+ suffix_content = suffix[1:-1]
225
+
226
+ if "x" in suffix_content:
227
+ tokens.append("x")
228
+ if "+*" in suffix_content:
229
+ tokens.append("+*")
230
+ elif "+" in suffix_content:
231
+ tokens.append("+")
232
+ if suffix_content == "o":
233
+ tokens.append("o")
234
+ elif suffix_content == "O":
235
+ tokens.append("O")
236
+
237
+ return tokens
238
+
239
+ def _tokenize(self, text: str) -> List[str]:
240
+ """
241
+ Tokenize a string of moves into component tokens.
242
+
243
+ Args:
244
+ text: Space-separated moves in extended UCI format.
245
+
246
+ Returns:
247
+ List of component tokens.
248
+ """
249
+ tokens = []
250
+ moves = text.strip().split()
251
+
252
+ for move in moves:
253
+ move_tokens = self._parse_move(move)
254
+ tokens.extend(move_tokens)
255
+
256
+ return tokens
257
+
258
+ def _convert_token_to_id(self, token: str) -> int:
259
+ return self._vocab.get(token, self._vocab.get(self.UNK_TOKEN, 0))
260
+
261
+ def _convert_id_to_token(self, index: int) -> str:
262
+ return self._ids_to_tokens.get(index, self.UNK_TOKEN)
263
+
264
+ def convert_tokens_to_string(self, tokens: List[str]) -> str:
265
+ """
266
+ Convert tokens back to move string.
267
+
268
+ Reconstructs moves from component tokens.
269
+ """
270
+ special = {self.PAD_TOKEN, self.BOS_TOKEN, self.EOS_TOKEN, self.UNK_TOKEN}
271
+
272
+ result = []
273
+ current_move = []
274
+
275
+ for token in tokens:
276
+ if token in special:
277
+ if current_move:
278
+ result.append(self._reconstruct_move(current_move))
279
+ current_move = []
280
+ continue
281
+
282
+ current_move.append(token)
283
+
284
+ # Check if we have a complete move
285
+ if self._is_complete_move(current_move):
286
+ result.append(self._reconstruct_move(current_move))
287
+ current_move = []
288
+
289
+ # Handle remaining tokens
290
+ if current_move:
291
+ result.append(self._reconstruct_move(current_move))
292
+
293
+ return " ".join(result)
294
+
295
+ def _is_complete_move(self, tokens: List[str]) -> bool:
296
+ """Check if tokens form a complete move."""
297
+ if len(tokens) < 4:
298
+ return False
299
+
300
+ # Basic move: Color + Piece + From + To
301
+ if (tokens[0] in self.COLORS and
302
+ tokens[1] in self.PIECES and
303
+ tokens[2] in self.SQUARES and
304
+ tokens[3] in self.SQUARES):
305
+
306
+ if len(tokens) == 4:
307
+ return True
308
+
309
+ # Check for modifiers
310
+ remaining = tokens[4:]
311
+ for t in remaining:
312
+ if t in self.COLORS:
313
+ return True
314
+ if t not in self.MODIFIERS and not t.startswith("="):
315
+ return True
316
+
317
+ return True
318
+
319
+ return False
320
+
321
+ def _reconstruct_move(self, tokens: List[str]) -> str:
322
+ """Reconstruct a move string from component tokens."""
323
+ if not tokens:
324
+ return ""
325
+
326
+ if len(tokens) >= 4:
327
+ # Convert [W] -> W and [B] -> B for colors
328
+ color = tokens[0]
329
+ if color in self.COLORS:
330
+ color = color[1]
331
+
332
+ move = color + "".join(tokens[1:4])
333
+
334
+ # Add modifiers
335
+ suffixes = []
336
+ for t in tokens[4:]:
337
+ if t.startswith("="):
338
+ move += t
339
+ elif t in ["x", "+", "+*", "o", "O"]:
340
+ suffixes.append(t)
341
+
342
+ if suffixes:
343
+ move += "(" + "".join(suffixes) + ")"
344
+
345
+ return move
346
+
347
+ return "".join(tokens)
348
+
349
+ def save_vocabulary(
350
+ self,
351
+ save_directory: str,
352
+ filename_prefix: Optional[str] = None,
353
+ ) -> Tuple[str]:
354
+ """
355
+ Save the vocabulary to a file.
356
+
357
+ Args:
358
+ save_directory: Directory to save the vocabulary.
359
+ filename_prefix: Optional prefix for the vocabulary file.
360
+
361
+ Returns:
362
+ Tuple containing the path to the saved vocabulary file.
363
+ """
364
+ if not os.path.isdir(save_directory):
365
+ os.makedirs(save_directory, exist_ok=True)
366
+
367
+ vocab_file = os.path.join(
368
+ save_directory,
369
+ (filename_prefix + "-" if filename_prefix else "") + "vocab.json",
370
+ )
371
+
372
+ with open(vocab_file, "w", encoding="utf-8") as f:
373
+ json.dump(self._vocab, f, ensure_ascii=False, indent=2)
374
+
375
+ return (vocab_file,)
376
+
377
+
378
+ def count_vocab_from_dataset(
379
+ dataset_name: str = "dlouapre/lichess_2025-01_1M",
380
+ split: str = "train",
381
+ column: str = "moves",
382
+ max_samples: Optional[int] = None,
383
+ ) -> Dict[str, int]:
384
+ """
385
+ Count token frequencies in a dataset.
386
+
387
+ Note: For decomposed tokenizer, this counts component frequencies
388
+ rather than whole-move frequencies.
389
+
390
+ Args:
391
+ dataset_name: Name of the dataset.
392
+ split: Dataset split.
393
+ column: Column with moves.
394
+ max_samples: Max samples to process.
395
+
396
+ Returns:
397
+ Dictionary of token frequencies.
398
+ """
399
+ from collections import Counter
400
+ from datasets import load_dataset
401
+
402
+ tokenizer = ChessTokenizer()
403
+
404
+ dataset = load_dataset(dataset_name, split=split)
405
+ if max_samples:
406
+ dataset = dataset.select(range(min(max_samples, len(dataset))))
407
+
408
+ counts = Counter()
409
+ for example in dataset:
410
+ tokens = tokenizer.tokenize(example[column])
411
+ counts.update(tokens)
412
+
413
+ return dict(counts)
tokenizer_config.json ADDED
@@ -0,0 +1,11 @@
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "tokenizer_class": "ChessTokenizer",
3
+ "auto_map": {
4
+ "AutoTokenizer": [
5
+ "tokenizer.ChessTokenizer",
6
+ null
7
+ ]
8
+ },
9
+ "add_move_separator": false,
10
+ "vocab_size": 88
11
+ }
vocab.json ADDED
@@ -0,0 +1,90 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ "B": 8,
11
+ "R": 9,
12
+ "Q": 10,
13
+ "K": 11,
14
+ "a1": 12,
15
+ "a2": 13,
16
+ "a3": 14,
17
+ "a4": 15,
18
+ "a5": 16,
19
+ "a6": 17,
20
+ "a7": 18,
21
+ "a8": 19,
22
+ "b1": 20,
23
+ "b2": 21,
24
+ "b3": 22,
25
+ "b4": 23,
26
+ "b5": 24,
27
+ "b6": 25,
28
+ "b7": 26,
29
+ "b8": 27,
30
+ "c1": 28,
31
+ "c2": 29,
32
+ "c3": 30,
33
+ "c4": 31,
34
+ "c5": 32,
35
+ "c6": 33,
36
+ "c7": 34,
37
+ "c8": 35,
38
+ "d1": 36,
39
+ "d2": 37,
40
+ "d3": 38,
41
+ "d4": 39,
42
+ "d5": 40,
43
+ "d6": 41,
44
+ "d7": 42,
45
+ "d8": 43,
46
+ "e1": 44,
47
+ "e2": 45,
48
+ "e3": 46,
49
+ "e4": 47,
50
+ "e5": 48,
51
+ "e6": 49,
52
+ "e7": 50,
53
+ "e8": 51,
54
+ "f1": 52,
55
+ "f2": 53,
56
+ "f3": 54,
57
+ "f4": 55,
58
+ "f5": 56,
59
+ "f6": 57,
60
+ "f7": 58,
61
+ "f8": 59,
62
+ "g1": 60,
63
+ "g2": 61,
64
+ "g3": 62,
65
+ "g4": 63,
66
+ "g5": 64,
67
+ "g6": 65,
68
+ "g7": 66,
69
+ "g8": 67,
70
+ "h1": 68,
71
+ "h2": 69,
72
+ "h3": 70,
73
+ "h4": 71,
74
+ "h5": 72,
75
+ "h6": 73,
76
+ "h7": 74,
77
+ "h8": 75,
78
+ "x": 76,
79
+ "+": 77,
80
+ "#": 78,
81
+ "+*": 79,
82
+ "=Q": 80,
83
+ "=R": 81,
84
+ "=B": 82,
85
+ "=N": 83,
86
+ "O-O": 84,
87
+ "O-O-O": 85,
88
+ "o": 86,
89
+ "O": 87
90
+ }