Chiensaucisse67 commited on
Commit
00e9499
·
verified ·
1 Parent(s): 4352fb5

Chess Challenge submission by Chiensaucisse67

Browse files
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-normal-BPE
11
+
12
+ Chess model submitted to the LLM Course Chess Challenge.
13
+
14
+ ## Submission Info
15
+
16
+ - **Submitted by**: [Chiensaucisse67](https://huggingface.co/Chiensaucisse67)
17
+ - **Parameters**: 198,144
18
+ - **Organization**: LLM-course
19
+
20
+ ## Model Details
21
+
22
+ - **Architecture**: Chess Transformer (GPT-style)
23
+ - **Vocab size**: 72
24
+ - **Embedding dim**: 128
25
+ - **Layers**: 4
26
+ - **Heads**: 4
config.json ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "architectures": [
3
+ "ChessForCausalLM"
4
+ ],
5
+ "auto_map": {
6
+ "AutoConfig": "model_custom.ChessConfig",
7
+ "AutoModelForCausalLM": "model_custom.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": 128,
17
+ "n_head": 4,
18
+ "n_inner": 384,
19
+ "n_layer": 4,
20
+ "pad_token_id": 0,
21
+ "tie_weights": true,
22
+ "transformers_version": "4.57.1",
23
+ "vocab_size": 72
24
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:187196d23957c3cf40e8003982a3121809aee1c6f69f092a6f647bd080cb0d74
3
+ size 793720
model_custom.py ADDED
@@ -0,0 +1,530 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ from httpx import head
19
+ import torch
20
+ import torch.nn as nn
21
+ import torch.nn.functional as F
22
+ from transformers import PretrainedConfig, PreTrainedModel
23
+ from transformers.modeling_outputs import CausalLMOutputWithPast
24
+
25
+
26
+ class ChessConfig(PretrainedConfig):
27
+ """
28
+ Configuration class for the Chess Transformer model.
29
+
30
+ This configuration is designed for a ~1M parameter model.
31
+ Students can adjust these values to explore different architectures.
32
+
33
+ Parameter budget breakdown (with default values):
34
+ - Embeddings (vocab): 1200 x 128 = 153,600
35
+ - Position Embeddings: 256 x 128 = 32,768
36
+ - Transformer Layers: 6 x ~120,000 = ~720,000
37
+ - LM Head (with weight tying): 0 (shared with embeddings)
38
+ - Total: ~906,000 parameters
39
+
40
+ Attributes:
41
+ vocab_size: Size of the vocabulary (number of unique moves).
42
+ n_embd: Embedding dimension (d_model).
43
+ n_layer: Number of transformer layers.
44
+ n_head: Number of attention heads.
45
+ n_ctx: Maximum sequence length (context window).
46
+ n_inner: Feed-forward inner dimension (default: 3 * n_embd).
47
+ dropout: Dropout probability.
48
+ layer_norm_epsilon: Epsilon for layer normalization.
49
+ tie_weights: Whether to tie embedding and output weights.
50
+ """
51
+
52
+ model_type = "chess_transformer"
53
+
54
+ def __init__(
55
+ self,
56
+ vocab_size: int = 1792,
57
+ n_embd: int = 128,
58
+ n_layer: int = 10, # increased
59
+ n_head: int = 4,
60
+ n_ctx: int = 256,
61
+ n_inner: Optional[int] = None,
62
+ dropout: float = 0.1,
63
+ layer_norm_epsilon: float = 1e-5,
64
+ tie_weights: bool = True,
65
+ pad_token_id: int = 0,
66
+ bos_token_id: int = 1,
67
+ eos_token_id: int = 2,
68
+ **kwargs,
69
+ ):
70
+ super().__init__(
71
+ pad_token_id=pad_token_id,
72
+ bos_token_id=bos_token_id,
73
+ eos_token_id=eos_token_id,
74
+ **kwargs,
75
+ )
76
+
77
+ self.vocab_size = vocab_size
78
+ self.n_embd = n_embd
79
+ self.n_layer = n_layer
80
+ self.n_head = n_head
81
+ self.n_ctx = n_ctx
82
+ self.n_inner = n_inner if n_inner is not None else 3 * n_embd # Reduced from 4x to 3x
83
+ self.dropout = dropout
84
+ self.layer_norm_epsilon = layer_norm_epsilon
85
+ self.tie_weights = tie_weights
86
+ # Inform HF base class about tying behavior
87
+ self.tie_word_embeddings = bool(tie_weights)
88
+
89
+ class RMSNorm(nn.Module):
90
+ def __init__(self, dim: int, eps: float = 1e-6):
91
+ super().__init__()
92
+ self.eps = eps
93
+ self.weight = nn.Parameter(torch.ones(dim))
94
+
95
+ def forward(self, x):
96
+ var = torch.mean(x**2, dim = -1, keepdim= True)
97
+ x = x * torch.rsqrt(var + self.eps)
98
+ return self.weight * x
99
+
100
+ class SwiGLU(nn.Module):
101
+ def __init__(self, config: ChessConfig):
102
+ super().__init__()
103
+ self.w1 = nn.Linear(config.n_embd, config.n_inner, bias = False)
104
+ self.w2 = nn.Linear(config.n_embd, config.n_inner, bias = False)
105
+ self.w3 = nn.Linear(config.n_inner, config.n_embd, bias = False)
106
+ self.dropout = nn.Dropout(config.dropout)
107
+
108
+ def forward(self, x):
109
+ x1 = self.w1(x)
110
+ x2 = self.w2(x)
111
+ hidden = F.silu(x1) * x2
112
+ return self.dropout(self.w3(hidden))
113
+
114
+ class RotaryEmbedding(nn.Module):
115
+
116
+ def __init__(self, head_dim: int, max_position_embeddings: int = 2048, base: float = 10000.0):
117
+ super().__init__()
118
+ self.head_dim = head_dim
119
+ self.max_pos = max_position_embeddings
120
+
121
+ inv_freq = 1.0 / (base ** (torch.arange(0, head_dim, 2).float() / head_dim))
122
+ self.register_buffer("inv_freq", inv_freq, persistent=False)
123
+
124
+ self.recompute_cache(max_position_embeddings)
125
+
126
+ def recompute_cache(self, max_pos):
127
+ self.max_pos = max_pos
128
+ t = torch.arange(max_pos, device=self.inv_freq.device, dtype=self.inv_freq.dtype)
129
+ freqs = torch.outer(t, self.inv_freq)
130
+
131
+ emb = torch.cat((freqs, freqs), dim=-1)
132
+
133
+ self.register_buffer("cos_cached", emb.cos()[None, None, :, :], persistent=False)
134
+ self.register_buffer("sin_cached", emb.sin()[None, None, :, :], persistent=False)
135
+
136
+ def forward(self, x, seq_len=None):
137
+ # x shape: [Batch, Heads, Seq, Dim]
138
+ if seq_len > self.max_pos:
139
+ self.recompute_cache(seq_len)
140
+
141
+ return (
142
+ self.cos_cached[..., :seq_len, :].to(dtype=x.dtype, device=x.device),
143
+ self.sin_cached[..., :seq_len, :].to(dtype=x.dtype, device=x.device)
144
+ )
145
+
146
+ def rotate_half(x):
147
+ x1 = x[..., : x.shape[-1] // 2]
148
+ x2 = x[..., x.shape[-1] // 2 :]
149
+ return torch.cat((-x2, x1), dim=-1)
150
+
151
+ def apply_rotary_emb(q, k, cos, sin):
152
+
153
+ # q, k: [Batch, Heads, Seq, Dim]
154
+ # cos, sin: [1, 1, Seq, Dim]
155
+ q_embed = (q * cos) + (rotate_half(q) * sin)
156
+ k_embed = (k * cos) + (rotate_half(k) * sin)
157
+ return q_embed, k_embed
158
+
159
+ class MultiQueryAttention(nn.Module):
160
+ """
161
+ Multi-head self-attention module.
162
+
163
+ This is a standard scaled dot-product attention implementation
164
+ with causal masking for autoregressive generation.
165
+ """
166
+
167
+ def __init__(self, config: ChessConfig):
168
+ super().__init__()
169
+
170
+ assert config.n_embd % config.n_head == 0, \
171
+ f"n_embd ({config.n_embd}) must be divisible by n_head ({config.n_head})"
172
+
173
+ self.n_head = config.n_head
174
+ self.n_embd = config.n_embd
175
+ self.head_dim = config.n_embd // config.n_head
176
+
177
+ # Combined QKV projection for efficiency
178
+ self.c_q = nn.Linear(config.n_embd, config.n_embd, bias = False)
179
+ self.c_k = nn.Linear(config.n_embd, self.head_dim, bias = False)
180
+ self.c_v = nn.Linear(config.n_embd, self.head_dim, bias = False)
181
+ self.c_proj = nn.Linear(config.n_embd, config.n_embd)
182
+
183
+ self.dropout = nn.Dropout(config.dropout)
184
+
185
+ # Causal mask (will be created on first forward pass)
186
+ self.register_buffer(
187
+ "bias",
188
+ torch.tril(torch.ones(config.n_ctx, config.n_ctx)).view(
189
+ 1, 1, config.n_ctx, config.n_ctx
190
+ ),
191
+ persistent=False,
192
+ )
193
+
194
+ def forward(
195
+ self,
196
+ x: torch.Tensor,
197
+ freqs_cos: torch.Tensor,
198
+ freqs_sin: torch.Tensor,
199
+ attention_mask: Optional[torch.Tensor] = None,
200
+ ) -> torch.Tensor:
201
+ batch_size, seq_len, _ = x.size()
202
+
203
+ q = self.c_q(x).view(batch_size, seq_len, self.n_head, self.head_dim)
204
+ k = self.c_k(x).view(batch_size, seq_len, 1, self.head_dim)
205
+ v = self.c_v(x).view(batch_size, seq_len, 1, self.head_dim)
206
+
207
+
208
+ q = q.transpose(1, 2)
209
+ k = k.transpose(1, 2)
210
+ v = v.transpose(1, 2)
211
+ q, k = apply_rotary_emb(q, k, freqs_cos, freqs_sin)
212
+
213
+ # Scaled dot-product attention
214
+ attn_weights = torch.matmul(q, k.transpose(-2, -1)) / math.sqrt(self.head_dim)
215
+
216
+ # Apply causal mask
217
+ causal_mask = self.bias[:, :, :seq_len, :seq_len]
218
+ attn_weights = attn_weights.masked_fill(causal_mask == 0, float("-inf"))
219
+
220
+ # Apply attention mask (for padding)
221
+ if attention_mask is not None:
222
+ # attention_mask shape: (batch_size, seq_len) -> (batch_size, 1, 1, seq_len)
223
+ attention_mask = attention_mask.unsqueeze(1).unsqueeze(2)
224
+ attn_weights = attn_weights.masked_fill(attention_mask == 0, float("-inf"))
225
+
226
+ attn_weights = F.softmax(attn_weights, dim=-1)
227
+ attn_weights = self.dropout(attn_weights)
228
+
229
+ # Apply attention to values
230
+ attn_output = torch.matmul(attn_weights, v)
231
+
232
+ # Reshape back
233
+ attn_output = attn_output.transpose(1, 2).contiguous().view(
234
+ batch_size, seq_len, self.n_embd
235
+ )
236
+
237
+ # Output projection
238
+ attn_output = self.c_proj(attn_output)
239
+
240
+ return attn_output
241
+
242
+
243
+ class FeedForward(nn.Module):
244
+ """
245
+ Feed-forward network (MLP) module.
246
+
247
+ Standard two-layer MLP with GELU activation.
248
+ """
249
+
250
+ def __init__(self, config: ChessConfig):
251
+ super().__init__()
252
+
253
+ self.net = nn.Sequential(
254
+ nn.Linear(config.n_embd, config.n_inner, bias = False),
255
+ nn.GELU(),
256
+ nn.Linear(config.n_inner, config.n_embd, bias = False),
257
+ nn.Dropout(config.dropout)
258
+ )
259
+
260
+ def forward(self, x: torch.Tensor) -> torch.Tensor:
261
+ return self.net(x)
262
+
263
+
264
+ class TransformerBlock(nn.Module):
265
+ """
266
+ A single transformer block with attention and feed-forward layers.
267
+
268
+ Uses pre-normalization (LayerNorm before attention/FFN) for better
269
+ training stability.
270
+ """
271
+
272
+ def __init__(self, config: ChessConfig):
273
+ super().__init__()
274
+
275
+ self.ln_1 = RMSNorm(config.n_embd)
276
+ self.attn = MultiQueryAttention(config)
277
+ self.ln_2 = RMSNorm(config.n_embd)
278
+ self.mlp = SwiGLU(config)# FeedForward(config)
279
+
280
+ def forward(
281
+ self,
282
+ x: torch.Tensor,
283
+ cos: torch.Tensor,
284
+ sin: torch.Tensor,
285
+ attention_mask: Optional[torch.Tensor] = None,
286
+ ) -> torch.Tensor:
287
+ # Pre-norm attention
288
+ x = x + self.attn(self.ln_1(x), cos, sin, attention_mask=attention_mask)
289
+ # Pre-norm FFN
290
+ x = x + self.mlp(self.ln_2(x))
291
+ return x
292
+
293
+
294
+ class ChessForCausalLM(PreTrainedModel):
295
+ """
296
+ Chess Transformer for Causal Language Modeling (next-move prediction).
297
+
298
+ This model is designed to predict the next chess move given a sequence
299
+ of previous moves. It uses a GPT-style architecture with:
300
+ - Token embeddings for chess moves
301
+ - Learned positional embeddings
302
+ - Stacked transformer blocks
303
+ - Linear head for next-token prediction
304
+
305
+ The model supports weight tying between the embedding layer and the
306
+ output projection to save parameters.
307
+
308
+ Example:
309
+ >>> config = ChessConfig(vocab_size=1200, n_embd=128, n_layer=6)
310
+ >>> model = ChessForCausalLM(config)
311
+ >>> inputs = {"input_ids": torch.tensor([[1, 42, 87]])}
312
+ >>> outputs = model(**inputs)
313
+ >>> next_move_logits = outputs.logits[:, -1, :]
314
+ """
315
+
316
+ config_class = ChessConfig
317
+ base_model_prefix = "transformer"
318
+ supports_gradient_checkpointing = True
319
+ # Suppress missing-key warning for tied lm_head when loading
320
+ keys_to_ignore_on_load_missing = ["lm_head.weight"]
321
+
322
+ def __init__(self, config: ChessConfig):
323
+ super().__init__(config)
324
+
325
+ # Token and position embeddings
326
+ self.wte = nn.Embedding(config.vocab_size, config.n_embd)
327
+ # self.wpe = nn.Embedding(config.n_ctx, config.n_embd)
328
+
329
+ self.drop = nn.Dropout(config.dropout)
330
+
331
+ # Transformer blocks
332
+ # self.h = nn.ModuleList([
333
+ # TransformerBlock(config) for _ in range(config.n_layer)
334
+ # ])
335
+ self.universal_block = TransformerBlock(config)
336
+
337
+ # Final layer norm
338
+ self.ln_f = RMSNorm(config.n_embd)
339
+
340
+ # Output head
341
+ self.lm_head = nn.Linear(config.n_embd, config.vocab_size, bias=False)
342
+
343
+ self.register_buffer("freqs_cos", torch.zeros(1), persistent = False)
344
+ self.register_buffer("freqs_sin", torch.zeros(1), persistent = False)
345
+
346
+ # Declare tied weights for proper serialization
347
+ if config.tie_weights:
348
+ self._tied_weights_keys = ["lm_head.weight"]
349
+
350
+ # Initialize weights
351
+ self.post_init()
352
+
353
+ # Tie weights if configured
354
+ if config.tie_weights:
355
+ self.tie_weights()
356
+
357
+ self.rotary = RotaryEmbedding(
358
+ config.n_embd // config.n_head
359
+ )
360
+
361
+ def get_input_embeddings(self) -> nn.Module:
362
+ return self.wte
363
+
364
+ def set_input_embeddings(self, new_embeddings: nn.Module):
365
+ self.wte = new_embeddings
366
+ if getattr(self.config, "tie_weights", False):
367
+ self.tie_weights()
368
+
369
+ def get_output_embeddings(self) -> nn.Module:
370
+ return self.lm_head
371
+
372
+ def set_output_embeddings(self, new_embeddings: nn.Module):
373
+ self.lm_head = new_embeddings
374
+
375
+ def tie_weights(self):
376
+ # Use HF helper to tie or clone depending on config
377
+ if getattr(self.config, "tie_weights", False) or getattr(self.config, "tie_word_embeddings", False):
378
+ self._tie_or_clone_weights(self.lm_head, self.wte)
379
+
380
+ def _init_weights(self, module: nn.Module):
381
+ """Initialize weights following GPT-2 style."""
382
+ if isinstance(module, nn.Linear):
383
+ torch.nn.init.normal_(module.weight, mean=0.0, std=0.02)
384
+ if module.bias is not None:
385
+ torch.nn.init.zeros_(module.bias)
386
+ elif isinstance(module, nn.Embedding):
387
+ torch.nn.init.normal_(module.weight, mean=0.0, std=0.02)
388
+ elif isinstance(module, nn.LayerNorm):
389
+ torch.nn.init.ones_(module.weight)
390
+ torch.nn.init.zeros_(module.bias)
391
+
392
+ def forward(
393
+ self,
394
+ input_ids: torch.LongTensor,
395
+ attention_mask: Optional[torch.Tensor] = None,
396
+ position_ids: Optional[torch.LongTensor] = None,
397
+ labels: Optional[torch.LongTensor] = None,
398
+ return_dict: Optional[bool] = None,
399
+ **kwargs,
400
+ ) -> Union[Tuple, CausalLMOutputWithPast]:
401
+ """
402
+ Forward pass of the model.
403
+
404
+ Args:
405
+ input_ids: Token IDs of shape (batch_size, seq_len).
406
+ attention_mask: Attention mask of shape (batch_size, seq_len).
407
+ position_ids: Position IDs of shape (batch_size, seq_len).
408
+ labels: Labels for language modeling loss.
409
+ return_dict: Whether to return a ModelOutput object.
410
+
411
+ Returns:
412
+ CausalLMOutputWithPast containing loss (if labels provided) and logits.
413
+ """
414
+ return_dict = return_dict if return_dict is not None else self.config.use_return_dict
415
+
416
+ batch_size, seq_len = input_ids.size()
417
+ device = input_ids.device
418
+
419
+ # Create position IDs if not provided
420
+ if position_ids is None:
421
+ position_ids = torch.arange(seq_len, device=device).unsqueeze(0).expand(batch_size, -1)
422
+
423
+ # Get embeddings
424
+ hidden_states = self.wte(input_ids)
425
+
426
+ cos, sin = self.rotary(hidden_states, hidden_states.size(1))
427
+
428
+ if cos.device != hidden_states.device:
429
+ cos, sin = cos.to(hidden_states.device), sin.to(hidden_states.device)
430
+
431
+ all_logits = []
432
+ # Pass through transformer blocks
433
+ for step in range(8):
434
+ hidden_states = self.universal_block(hidden_states, cos, sin, attention_mask=attention_mask)
435
+ hidden_states = self.ln_f(hidden_states)
436
+ step_logits = self.lm_head(hidden_states)
437
+ all_logits.append(step_logits)
438
+
439
+ # Final layer norm
440
+ hidden_states = self.ln_f(hidden_states)
441
+
442
+ # Get logits
443
+ logits = self.lm_head(hidden_states)
444
+
445
+ # Compute loss if labels are provided
446
+ loss = None
447
+ if labels is not None:
448
+ # Shift logits and labels for next-token prediction
449
+ shift_labels = labels[..., 1:].contiguous()
450
+ loss_fct = nn.CrossEntropyLoss(ignore_index = -100)
451
+
452
+ total_loss = 0.0
453
+ for step_logits in all_logits:
454
+ shift_logits = step_logits[..., :-1, :].contiguous()
455
+ total_loss += loss_fct(
456
+ shift_logits.view(-1, self.config.vocab_size),
457
+ shift_labels.view(-1)
458
+ )
459
+ loss = total_loss / len(all_logits)
460
+
461
+ if not return_dict:
462
+ output = (logits,)
463
+ return ((loss,) + output) if loss is not None else output
464
+
465
+ return CausalLMOutputWithPast(
466
+ loss=loss,
467
+ logits=logits,
468
+ past_key_values=None,
469
+ hidden_states=None,
470
+ attentions=None,
471
+ )
472
+
473
+ @torch.no_grad()
474
+ def generate_move(
475
+ self,
476
+ input_ids: torch.LongTensor,
477
+ temperature: float = 1.0,
478
+ top_k: Optional[int] = None,
479
+ top_p: Optional[float] = None,
480
+ ) -> int:
481
+ """
482
+ Generate the next move given a sequence of moves.
483
+
484
+ Args:
485
+ input_ids: Token IDs of shape (1, seq_len).
486
+ temperature: Sampling temperature (1.0 = no change).
487
+ top_k: If set, only sample from top k tokens.
488
+ top_p: If set, use nucleus sampling with this threshold.
489
+
490
+ Returns:
491
+ The token ID of the predicted next move.
492
+ """
493
+ self.eval()
494
+
495
+ # Get logits for the last position
496
+ outputs = self(input_ids)
497
+ logits = outputs.logits[:, -1, :] / temperature
498
+
499
+ # Apply top-k filtering
500
+ if top_k is not None:
501
+ indices_to_remove = logits < torch.topk(logits, top_k)[0][..., -1, None]
502
+ logits[indices_to_remove] = float("-inf")
503
+
504
+ # Apply top-p (nucleus) filtering
505
+ if top_p is not None:
506
+ sorted_logits, sorted_indices = torch.sort(logits, descending=True)
507
+ cumulative_probs = torch.cumsum(F.softmax(sorted_logits, dim=-1), dim=-1)
508
+
509
+ # Remove tokens with cumulative probability above the threshold
510
+ sorted_indices_to_remove = cumulative_probs > top_p
511
+ sorted_indices_to_remove[..., 1:] = sorted_indices_to_remove[..., :-1].clone()
512
+ sorted_indices_to_remove[..., 0] = 0
513
+
514
+ indices_to_remove = sorted_indices_to_remove.scatter(
515
+ dim=-1, index=sorted_indices, src=sorted_indices_to_remove
516
+ )
517
+ logits[indices_to_remove] = float("-inf")
518
+
519
+ # Sample from the distribution
520
+ probs = F.softmax(logits, dim=-1)
521
+ next_token = torch.multinomial(probs, num_samples=1)
522
+
523
+ return next_token.item()
524
+
525
+
526
+ # Register the model with Auto classes for easy loading
527
+ from transformers import AutoConfig, AutoModelForCausalLM
528
+
529
+ AutoConfig.register("chess_transformer", ChessConfig)
530
+ AutoModelForCausalLM.register(ChessConfig, ChessForCausalLM)
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_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_custom.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
+ }
tokenizer_custom.py ADDED
@@ -0,0 +1,278 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+
21
+ from transformers import PreTrainedTokenizer
22
+
23
+
24
+ class ChessTokenizer(PreTrainedTokenizer):
25
+ """
26
+ A custom tokenizer for chess moves using extended UCI notation.
27
+
28
+ This tokenizer maps each possible chess move to a unique token ID.
29
+ The vocabulary is built from the training dataset to ensure all moves
30
+ encountered during training have a corresponding token.
31
+
32
+ Example:
33
+ >>> tokenizer = ChessTokenizer()
34
+ >>> tokenizer.encode("WPe2e4 BPe7e5")
35
+ [1, 42, 87, 2] # [BOS, e2e4, e7e5, EOS]
36
+ """
37
+
38
+ model_input_names = ["input_ids", "attention_mask"]
39
+ vocab_files_names = {"vocab_file": "vocab.json"}
40
+
41
+ # Special tokens
42
+ PAD_TOKEN = "[PAD]"
43
+ BOS_TOKEN = "[BOS]"
44
+ EOS_TOKEN = "[EOS]"
45
+ UNK_TOKEN = "[UNK]"
46
+
47
+ def __init__(
48
+ self,
49
+ vocab_file: Optional[str] = None,
50
+ vocab: Optional[Dict[str, int]] = None,
51
+ **kwargs,
52
+ ):
53
+ """
54
+ Initialize the chess tokenizer.
55
+
56
+ Args:
57
+ vocab_file: Path to a JSON file containing the vocabulary mapping.
58
+ vocab: Dictionary mapping tokens to IDs (alternative to vocab_file).
59
+ **kwargs: Additional arguments passed to PreTrainedTokenizer.
60
+ """
61
+ # Initialize special tokens
62
+ self._pad_token = self.PAD_TOKEN
63
+ self._bos_token = self.BOS_TOKEN
64
+ self._eos_token = self.EOS_TOKEN
65
+ self._unk_token = self.UNK_TOKEN
66
+
67
+ # Remove any duplicate special-token entries passed through kwargs
68
+ # to avoid "multiple values for keyword" errors when loading from disk.
69
+ kwargs.pop("pad_token", None)
70
+ kwargs.pop("bos_token", None)
71
+ kwargs.pop("eos_token", None)
72
+ kwargs.pop("unk_token", None)
73
+
74
+ # Load or create vocabulary
75
+ if vocab is not None:
76
+ self._vocab = vocab
77
+ elif vocab_file is not None and os.path.exists(vocab_file):
78
+ with open(vocab_file, "r", encoding="utf-8") as f:
79
+ self._vocab = json.load(f)
80
+ else:
81
+ # Create a minimal vocabulary with just special tokens
82
+ # The full vocabulary should be built from the dataset
83
+ self._vocab = self._create_default_vocab()
84
+
85
+ # Create reverse mapping
86
+ self._ids_to_tokens = {v: k for k, v in self._vocab.items()}
87
+
88
+ # Call parent init AFTER setting up vocab
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 a minimal default vocabulary with just special tokens.
100
+
101
+ For the full vocabulary, use `build_vocab_from_dataset()`.
102
+ This minimal vocab is just a placeholder - you should build from data.
103
+ """
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
+ return vocab
107
+
108
+ @classmethod
109
+ def build_vocab_from_iterator(
110
+ cls,
111
+ iterator,
112
+ min_frequency: int = 1,
113
+ ) -> "ChessTokenizer":
114
+ """
115
+ Build a tokenizer vocabulary from an iterator of game strings.
116
+
117
+ Args:
118
+ iterator: An iterator yielding game strings (space-separated moves).
119
+ min_frequency: Minimum frequency for a token to be included.
120
+
121
+ Returns:
122
+ A ChessTokenizer with the built vocabulary.
123
+ """
124
+ from collections import Counter
125
+
126
+ token_counts = Counter()
127
+
128
+ for game in iterator:
129
+ moves = game.strip().split()
130
+ token_counts.update(moves)
131
+
132
+ # Filter by frequency
133
+ tokens = [
134
+ token for token, count in token_counts.items()
135
+ if count >= min_frequency
136
+ ]
137
+
138
+ # Sort for reproducibility
139
+ tokens = sorted(tokens)
140
+
141
+ # Build vocabulary
142
+ special_tokens = [cls.PAD_TOKEN, cls.BOS_TOKEN, cls.EOS_TOKEN, cls.UNK_TOKEN]
143
+ vocab = {token: idx for idx, token in enumerate(special_tokens + tokens)}
144
+
145
+ return cls(vocab=vocab)
146
+
147
+ @classmethod
148
+ def build_vocab_from_dataset(
149
+ cls,
150
+ dataset_name: str = "dlouapre/lichess_2025-01_1M",
151
+ split: str = "train",
152
+ column: str = "text",
153
+ min_frequency: int = 500,
154
+ max_samples: Optional[int] = 100000,
155
+ ) -> "ChessTokenizer":
156
+ """
157
+ Build a tokenizer vocabulary from a Hugging Face dataset.
158
+
159
+ Args:
160
+ dataset_name: Name of the dataset on Hugging Face Hub.
161
+ split: Dataset split to use.
162
+ column: Column containing the game strings.
163
+ min_frequency: Minimum frequency for a token to be included (default: 500).
164
+ max_samples: Maximum number of samples to process (default: 100k).
165
+
166
+ Returns:
167
+ A ChessTokenizer with the built vocabulary.
168
+ """
169
+ from datasets import load_dataset
170
+
171
+ dataset = load_dataset(dataset_name, split=split)
172
+
173
+ if max_samples is not None:
174
+ dataset = dataset.select(range(min(max_samples, len(dataset))))
175
+
176
+ def game_iterator():
177
+ for example in dataset:
178
+ yield example[column]
179
+
180
+ return cls.build_vocab_from_iterator(game_iterator(), min_frequency=min_frequency)
181
+
182
+ @property
183
+ def vocab_size(self) -> int:
184
+ """Return the size of the vocabulary."""
185
+ return len(self._vocab)
186
+
187
+ def get_vocab(self) -> Dict[str, int]:
188
+ """Return the vocabulary as a dictionary."""
189
+ return dict(self._vocab)
190
+
191
+ def _tokenize(self, text: str) -> List[str]:
192
+ """
193
+ Tokenize a string of moves into a list of tokens.
194
+
195
+ Args:
196
+ text: A string of space-separated moves.
197
+
198
+ Returns:
199
+ List of move tokens.
200
+ """
201
+ return text.strip().split()
202
+
203
+ def _convert_token_to_id(self, token: str) -> int:
204
+ """Convert a token to its ID."""
205
+ return self._vocab.get(token, self._vocab.get(self.UNK_TOKEN, 0))
206
+
207
+ def _convert_id_to_token(self, index: int) -> str:
208
+ """Convert an ID to its token."""
209
+ return self._ids_to_tokens.get(index, self.UNK_TOKEN)
210
+
211
+ def convert_tokens_to_string(self, tokens: List[str]) -> str:
212
+ """Convert a list of tokens back to a string."""
213
+ # Filter out special tokens for cleaner output
214
+ special = {self.PAD_TOKEN, self.BOS_TOKEN, self.EOS_TOKEN, self.UNK_TOKEN}
215
+ return " ".join(t for t in tokens if t not in special)
216
+
217
+ def save_vocabulary(
218
+ self,
219
+ save_directory: str,
220
+ filename_prefix: Optional[str] = None,
221
+ ) -> tuple:
222
+ """
223
+ Save the vocabulary to a JSON file.
224
+
225
+ Args:
226
+ save_directory: Directory to save the vocabulary.
227
+ filename_prefix: Optional prefix for the filename.
228
+
229
+ Returns:
230
+ Tuple containing the path to the saved vocabulary file.
231
+ """
232
+ if not os.path.isdir(save_directory):
233
+ os.makedirs(save_directory, exist_ok=True)
234
+
235
+ vocab_file = os.path.join(
236
+ save_directory,
237
+ (filename_prefix + "-" if filename_prefix else "") + "vocab.json",
238
+ )
239
+
240
+ with open(vocab_file, "w", encoding="utf-8") as f:
241
+ json.dump(self._vocab, f, ensure_ascii=False, indent=2)
242
+
243
+ return (vocab_file,)
244
+
245
+
246
+ def count_vocab_from_dataset(
247
+ dataset_name: str = "dlouapre/lichess_2025-01_1M",
248
+ split: str = "train",
249
+ column: str = "text",
250
+ max_samples: Optional[int] = 10000,
251
+ ) -> Dict[str, int]:
252
+ """
253
+ Count token frequencies in a dataset (useful for vocabulary analysis).
254
+
255
+ Args:
256
+ dataset_name: Name of the dataset on Hugging Face Hub.
257
+ split: Dataset split to use.
258
+ column: Column containing the game strings.
259
+ max_samples: Maximum number of samples to process.
260
+
261
+ Returns:
262
+ Dictionary mapping tokens to their frequencies.
263
+ """
264
+ from collections import Counter
265
+ from datasets import load_dataset
266
+
267
+ dataset = load_dataset(dataset_name, split=split)
268
+
269
+ if max_samples is not None:
270
+ dataset = dataset.select(range(min(max_samples, len(dataset))))
271
+
272
+ token_counts = Counter()
273
+
274
+ for example in dataset:
275
+ moves = example[column].strip().split()
276
+ token_counts.update(moves)
277
+
278
+ return dict(token_counts)
vocab.json ADDED
@@ -0,0 +1,74 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "[PAD]": 0,
3
+ "[BOS]": 1,
4
+ "[EOS]": 2,
5
+ "[UNK]": 3,
6
+ "a1": 4,
7
+ "a2": 5,
8
+ "a3": 6,
9
+ "a4": 7,
10
+ "a5": 8,
11
+ "a6": 9,
12
+ "a7": 10,
13
+ "a8": 11,
14
+ "b1": 12,
15
+ "b2": 13,
16
+ "b3": 14,
17
+ "b4": 15,
18
+ "b5": 16,
19
+ "b6": 17,
20
+ "b7": 18,
21
+ "b8": 19,
22
+ "c1": 20,
23
+ "c2": 21,
24
+ "c3": 22,
25
+ "c4": 23,
26
+ "c5": 24,
27
+ "c6": 25,
28
+ "c7": 26,
29
+ "c8": 27,
30
+ "d1": 28,
31
+ "d2": 29,
32
+ "d3": 30,
33
+ "d4": 31,
34
+ "d5": 32,
35
+ "d6": 33,
36
+ "d7": 34,
37
+ "d8": 35,
38
+ "e1": 36,
39
+ "e2": 37,
40
+ "e3": 38,
41
+ "e4": 39,
42
+ "e5": 40,
43
+ "e6": 41,
44
+ "e7": 42,
45
+ "e8": 43,
46
+ "f1": 44,
47
+ "f2": 45,
48
+ "f3": 46,
49
+ "f4": 47,
50
+ "f5": 48,
51
+ "f6": 49,
52
+ "f7": 50,
53
+ "f8": 51,
54
+ "g1": 52,
55
+ "g2": 53,
56
+ "g3": 54,
57
+ "g4": 55,
58
+ "g5": 56,
59
+ "g6": 57,
60
+ "g7": 58,
61
+ "g8": 59,
62
+ "h1": 60,
63
+ "h2": 61,
64
+ "h3": 62,
65
+ "h4": 63,
66
+ "h5": 64,
67
+ "h6": 65,
68
+ "h7": 66,
69
+ "h8": 67,
70
+ "q": 68,
71
+ "r": 69,
72
+ "b": 70,
73
+ "n": 71
74
+ }