pultch commited on
Commit
b1c0751
·
verified ·
1 Parent(s): ecacb41

Chess Challenge submission by pultch

Browse files
Files changed (7) hide show
  1. README.md +12 -7
  2. config.json +7 -3
  3. model.py +438 -0
  4. model.safetensors +2 -2
  5. tokenizer.py +45 -45
  6. tokenizer_config.json +8 -8
  7. training_args.bin +3 -0
README.md CHANGED
@@ -14,13 +14,18 @@ Chess model submitted to the LLM Course Chess Challenge.
14
  ## Submission Info
15
 
16
  - **Submitted by**: [pultch](https://huggingface.co/pultch)
17
- - **Parameters**: 852,992
18
  - **Organization**: LLM-course
19
 
20
- ## Model Details
21
 
22
- - **Architecture**: Chess Transformer (GPT-style)
23
- - **Vocab size**: 74
24
- - **Embedding dim**: 128
25
- - **Layers**: 5
26
- - **Heads**: 8
 
 
 
 
 
 
14
  ## Submission Info
15
 
16
  - **Submitted by**: [pultch](https://huggingface.co/pultch)
17
+ - **Parameters**: 861,184
18
  - **Organization**: LLM-course
19
 
20
+ ## Usage
21
 
22
+ ```python
23
+ from transformers import AutoModelForCausalLM, AutoTokenizer
24
+
25
+ model = AutoModelForCausalLM.from_pretrained("LLM-course/simple_tokenizer", trust_remote_code=True)
26
+ tokenizer = AutoTokenizer.from_pretrained("LLM-course/simple_tokenizer", trust_remote_code=True)
27
+ ```
28
+
29
+ ## Evaluation
30
+
31
+ This model is evaluated at the [Chess Challenge Arena](https://huggingface.co/spaces/LLM-course/Chess1MChallenge).
config.json CHANGED
@@ -8,7 +8,7 @@
8
  "eos_token_id": 2,
9
  "layer_norm_epsilon": 1e-05,
10
  "model_type": "chess_transformer",
11
- "n_ctx": 128,
12
  "n_embd": 128,
13
  "n_head": 8,
14
  "n_inner": 384,
@@ -16,5 +16,9 @@
16
  "pad_token_id": 0,
17
  "tie_weights": true,
18
  "transformers_version": "4.57.6",
19
- "vocab_size": 74
20
- }
 
 
 
 
 
8
  "eos_token_id": 2,
9
  "layer_norm_epsilon": 1e-05,
10
  "model_type": "chess_transformer",
11
+ "n_ctx": 192,
12
  "n_embd": 128,
13
  "n_head": 8,
14
  "n_inner": 384,
 
16
  "pad_token_id": 0,
17
  "tie_weights": true,
18
  "transformers_version": "4.57.6",
19
+ "vocab_size": 74,
20
+ "auto_map": {
21
+ "AutoConfig": "model.ChessConfig",
22
+ "AutoModelForCausalLM": "model.ChessForCausalLM"
23
+ }
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 CHANGED
@@ -1,3 +1,3 @@
1
  version https://git-lfs.github.com/spec/v1
2
- oid sha256:6185731b28f686833e495232d80a8be24f5c3dbad31752396b5cfc2f4cd413f4
3
- size 3417392
 
1
  version https://git-lfs.github.com/spec/v1
2
+ oid sha256:bdba2c9107ce95c2cae9977558f734b4293fb4d7ae68b0015cedf5c668d9b115
3
+ size 3450160
tokenizer.py CHANGED
@@ -25,26 +25,26 @@ from transformers import PreTrainedTokenizer
25
  class ChessTokenizer(PreTrainedTokenizer):
26
  """
27
  A custom tokenizer for chess moves using extended UCI notation.
28
-
29
  This tokenizer maps each possible chess move to a unique token ID.
30
  The vocabulary is built from the training dataset to ensure all moves
31
  encountered during training have a corresponding token.
32
-
33
  Example:
34
  >>> tokenizer = ChessTokenizer()
35
  >>> tokenizer.encode("WPe2e4 BPe7e5")
36
  [1, 42, 87, 2] # [BOS, e2e4, e7e5, EOS]
37
  """
38
-
39
  model_input_names = ["input_ids", "attention_mask"]
40
  vocab_files_names = {"vocab_file": "vocab.json"}
41
-
42
  # Special tokens
43
  PAD_TOKEN = "[PAD]"
44
  BOS_TOKEN = "[BOS]"
45
  EOS_TOKEN = "[EOS]"
46
  UNK_TOKEN = "[UNK]"
47
-
48
  def __init__(
49
  self,
50
  vocab_file: Optional[str] = None,
@@ -53,7 +53,7 @@ class ChessTokenizer(PreTrainedTokenizer):
53
  ):
54
  """
55
  Initialize the chess tokenizer.
56
-
57
  Args:
58
  vocab_file: Path to a JSON file containing the vocabulary mapping.
59
  vocab: Dictionary mapping tokens to IDs (alternative to vocab_file).
@@ -71,7 +71,7 @@ class ChessTokenizer(PreTrainedTokenizer):
71
  kwargs.pop("bos_token", None)
72
  kwargs.pop("eos_token", None)
73
  kwargs.pop("unk_token", None)
74
-
75
  # Load or create vocabulary
76
  if vocab is not None:
77
  self._vocab = vocab
@@ -82,10 +82,10 @@ class ChessTokenizer(PreTrainedTokenizer):
82
  # Create a minimal vocabulary with just special tokens
83
  # The full vocabulary should be built from the dataset
84
  self._vocab = self._create_default_vocab()
85
-
86
  # Create reverse mapping
87
  self._ids_to_tokens = {v: k for k, v in self._vocab.items()}
88
-
89
  # Call parent init AFTER setting up vocab
90
  super().__init__(
91
  pad_token=self._pad_token,
@@ -94,18 +94,18 @@ class ChessTokenizer(PreTrainedTokenizer):
94
  unk_token=self._unk_token,
95
  **kwargs,
96
  )
97
-
98
  def _create_default_vocab(self) -> Dict[str, int]:
99
  """
100
  Create a minimal default vocabulary with just special tokens.
101
-
102
  For the full vocabulary, use `build_vocab_from_dataset()`.
103
  This minimal vocab is just a placeholder - you should build from data.
104
  """
105
  special_tokens = [self.PAD_TOKEN, self.BOS_TOKEN, self.EOS_TOKEN, self.UNK_TOKEN]
106
  vocab = {token: idx for idx, token in enumerate(special_tokens)}
107
  return vocab
108
-
109
  @classmethod
110
  def build_vocab_from_iterator(
111
  cls,
@@ -114,11 +114,11 @@ class ChessTokenizer(PreTrainedTokenizer):
114
  ) -> "ChessTokenizer":
115
  """
116
  Build a tokenizer vocabulary from an iterator of game strings.
117
-
118
  Args:
119
  iterator: An iterator yielding game strings (space-separated moves).
120
  min_frequency: Minimum frequency for a token to be included.
121
-
122
  Returns:
123
  A ChessTokenizer with the built vocabulary.
124
  """
@@ -127,7 +127,7 @@ class ChessTokenizer(PreTrainedTokenizer):
127
  # from collections import Counter
128
  #
129
  # token_counts = Counter()
130
-
131
  # for game in iterator:
132
  # moves = game.strip().split()
133
  # token_counts.update(moves)
@@ -141,7 +141,7 @@ class ChessTokenizer(PreTrainedTokenizer):
141
  #
142
  # # Sort for reproducibility
143
  # tokens = sorted(tokens)
144
-
145
  # Build vocabulary
146
  special_tokens = [cls.PAD_TOKEN, cls.BOS_TOKEN, cls.EOS_TOKEN, cls.UNK_TOKEN]
147
  piece = ['K', 'Q', 'R', 'B', 'N', 'P']
@@ -149,9 +149,9 @@ class ChessTokenizer(PreTrainedTokenizer):
149
 
150
  # vocab = {token: idx for idx, token in enumerate(special_tokens + tokens)}
151
  vocab = {token: idx for idx, token in enumerate(special_tokens + piece + move)}
152
-
153
  return cls(vocab=vocab)
154
-
155
  @classmethod
156
  def build_vocab_from_dataset(
157
  cls,
@@ -163,46 +163,46 @@ class ChessTokenizer(PreTrainedTokenizer):
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
  from datasets import load_dataset
178
-
179
  dataset = load_dataset(dataset_name, split=split)
180
-
181
  if max_samples is not None:
182
  dataset = dataset.select(range(min(max_samples, len(dataset))))
183
-
184
  def game_iterator():
185
  for example in dataset:
186
  yield example[column]
187
-
188
  return cls.build_vocab_from_iterator(game_iterator(), min_frequency=min_frequency)
189
-
190
  @property
191
  def vocab_size(self) -> int:
192
  """Return the size of the vocabulary."""
193
  return len(self._vocab)
194
-
195
  def get_vocab(self) -> Dict[str, int]:
196
  """Return the vocabulary as a dictionary."""
197
  return dict(self._vocab)
198
-
199
  def _tokenize(self, text: str) -> List[str]:
200
  """
201
  Tokenize a string of moves into a list of tokens.
202
-
203
  Args:
204
  text: A string of space-separated moves.
205
-
206
  Returns:
207
  List of move tokens.
208
  """
@@ -218,21 +218,21 @@ class ChessTokenizer(PreTrainedTokenizer):
218
  tokens += self.UNK_TOKEN
219
 
220
  return tokens
221
-
222
  def _convert_token_to_id(self, token: str) -> int:
223
  """Convert a token to its ID."""
224
  return self._vocab.get(token, self._vocab.get(self.UNK_TOKEN, 0))
225
-
226
  def _convert_id_to_token(self, index: int) -> str:
227
  """Convert an ID to its token."""
228
  return self._ids_to_tokens.get(index, self.UNK_TOKEN)
229
-
230
  def convert_tokens_to_string(self, tokens: List[str]) -> str:
231
  """Convert a list of tokens back to a string."""
232
  # Filter out special tokens for cleaner output
233
  special = {self.PAD_TOKEN, self.BOS_TOKEN, self.EOS_TOKEN, self.UNK_TOKEN}
234
  return " ".join(t for t in tokens if t not in special)
235
-
236
  def save_vocabulary(
237
  self,
238
  save_directory: str,
@@ -240,25 +240,25 @@ class ChessTokenizer(PreTrainedTokenizer):
240
  ) -> tuple:
241
  """
242
  Save the vocabulary to a JSON file.
243
-
244
  Args:
245
  save_directory: Directory to save the vocabulary.
246
  filename_prefix: Optional prefix for the filename.
247
-
248
  Returns:
249
  Tuple containing the path to the saved vocabulary file.
250
  """
251
  if not os.path.isdir(save_directory):
252
  os.makedirs(save_directory, exist_ok=True)
253
-
254
  vocab_file = os.path.join(
255
  save_directory,
256
  (filename_prefix + "-" if filename_prefix else "") + "vocab.json",
257
  )
258
-
259
  with open(vocab_file, "w", encoding="utf-8") as f:
260
  json.dump(self._vocab, f, ensure_ascii=False, indent=2)
261
-
262
  return (vocab_file,)
263
 
264
 
@@ -270,28 +270,28 @@ def count_vocab_from_dataset(
270
  ) -> Dict[str, int]:
271
  """
272
  Count token frequencies in a dataset (useful for vocabulary analysis).
273
-
274
  Args:
275
  dataset_name: Name of the dataset on Hugging Face Hub.
276
  split: Dataset split to use.
277
  column: Column containing the game strings.
278
  max_samples: Maximum number of samples to process.
279
-
280
  Returns:
281
  Dictionary mapping tokens to their frequencies.
282
  """
283
  from collections import Counter
284
  from datasets import load_dataset
285
-
286
  dataset = load_dataset(dataset_name, split=split)
287
-
288
  if max_samples is not None:
289
  dataset = dataset.select(range(min(max_samples, len(dataset))))
290
-
291
  token_counts = Counter()
292
-
293
  for example in dataset:
294
  moves = example[column].strip().split()
295
  token_counts.update(moves)
296
-
297
  return dict(token_counts)
 
25
  class ChessTokenizer(PreTrainedTokenizer):
26
  """
27
  A custom tokenizer for chess moves using extended UCI notation.
28
+
29
  This tokenizer maps each possible chess move to a unique token ID.
30
  The vocabulary is built from the training dataset to ensure all moves
31
  encountered during training have a corresponding token.
32
+
33
  Example:
34
  >>> tokenizer = ChessTokenizer()
35
  >>> tokenizer.encode("WPe2e4 BPe7e5")
36
  [1, 42, 87, 2] # [BOS, e2e4, e7e5, EOS]
37
  """
38
+
39
  model_input_names = ["input_ids", "attention_mask"]
40
  vocab_files_names = {"vocab_file": "vocab.json"}
41
+
42
  # Special tokens
43
  PAD_TOKEN = "[PAD]"
44
  BOS_TOKEN = "[BOS]"
45
  EOS_TOKEN = "[EOS]"
46
  UNK_TOKEN = "[UNK]"
47
+
48
  def __init__(
49
  self,
50
  vocab_file: Optional[str] = None,
 
53
  ):
54
  """
55
  Initialize the chess tokenizer.
56
+
57
  Args:
58
  vocab_file: Path to a JSON file containing the vocabulary mapping.
59
  vocab: Dictionary mapping tokens to IDs (alternative to vocab_file).
 
71
  kwargs.pop("bos_token", None)
72
  kwargs.pop("eos_token", None)
73
  kwargs.pop("unk_token", None)
74
+
75
  # Load or create vocabulary
76
  if vocab is not None:
77
  self._vocab = vocab
 
82
  # Create a minimal vocabulary with just special tokens
83
  # The full vocabulary should be built from the dataset
84
  self._vocab = self._create_default_vocab()
85
+
86
  # Create reverse mapping
87
  self._ids_to_tokens = {v: k for k, v in self._vocab.items()}
88
+
89
  # Call parent init AFTER setting up vocab
90
  super().__init__(
91
  pad_token=self._pad_token,
 
94
  unk_token=self._unk_token,
95
  **kwargs,
96
  )
97
+
98
  def _create_default_vocab(self) -> Dict[str, int]:
99
  """
100
  Create a minimal default vocabulary with just special tokens.
101
+
102
  For the full vocabulary, use `build_vocab_from_dataset()`.
103
  This minimal vocab is just a placeholder - you should build from data.
104
  """
105
  special_tokens = [self.PAD_TOKEN, self.BOS_TOKEN, self.EOS_TOKEN, self.UNK_TOKEN]
106
  vocab = {token: idx for idx, token in enumerate(special_tokens)}
107
  return vocab
108
+
109
  @classmethod
110
  def build_vocab_from_iterator(
111
  cls,
 
114
  ) -> "ChessTokenizer":
115
  """
116
  Build a tokenizer vocabulary from an iterator of game strings.
117
+
118
  Args:
119
  iterator: An iterator yielding game strings (space-separated moves).
120
  min_frequency: Minimum frequency for a token to be included.
121
+
122
  Returns:
123
  A ChessTokenizer with the built vocabulary.
124
  """
 
127
  # from collections import Counter
128
  #
129
  # token_counts = Counter()
130
+
131
  # for game in iterator:
132
  # moves = game.strip().split()
133
  # token_counts.update(moves)
 
141
  #
142
  # # Sort for reproducibility
143
  # tokens = sorted(tokens)
144
+
145
  # Build vocabulary
146
  special_tokens = [cls.PAD_TOKEN, cls.BOS_TOKEN, cls.EOS_TOKEN, cls.UNK_TOKEN]
147
  piece = ['K', 'Q', 'R', 'B', 'N', 'P']
 
149
 
150
  # vocab = {token: idx for idx, token in enumerate(special_tokens + tokens)}
151
  vocab = {token: idx for idx, token in enumerate(special_tokens + piece + move)}
152
+
153
  return cls(vocab=vocab)
154
+
155
  @classmethod
156
  def build_vocab_from_dataset(
157
  cls,
 
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
  from datasets import load_dataset
178
+
179
  dataset = load_dataset(dataset_name, split=split)
180
+
181
  if max_samples is not None:
182
  dataset = dataset.select(range(min(max_samples, len(dataset))))
183
+
184
  def game_iterator():
185
  for example in dataset:
186
  yield example[column]
187
+
188
  return cls.build_vocab_from_iterator(game_iterator(), min_frequency=min_frequency)
189
+
190
  @property
191
  def vocab_size(self) -> int:
192
  """Return the size of the vocabulary."""
193
  return len(self._vocab)
194
+
195
  def get_vocab(self) -> Dict[str, int]:
196
  """Return the vocabulary as a dictionary."""
197
  return dict(self._vocab)
198
+
199
  def _tokenize(self, text: str) -> List[str]:
200
  """
201
  Tokenize a string of moves into a list of tokens.
202
+
203
  Args:
204
  text: A string of space-separated moves.
205
+
206
  Returns:
207
  List of move tokens.
208
  """
 
218
  tokens += self.UNK_TOKEN
219
 
220
  return tokens
221
+
222
  def _convert_token_to_id(self, token: str) -> int:
223
  """Convert a token to its ID."""
224
  return self._vocab.get(token, self._vocab.get(self.UNK_TOKEN, 0))
225
+
226
  def _convert_id_to_token(self, index: int) -> str:
227
  """Convert an ID to its token."""
228
  return self._ids_to_tokens.get(index, self.UNK_TOKEN)
229
+
230
  def convert_tokens_to_string(self, tokens: List[str]) -> str:
231
  """Convert a list of tokens back to a string."""
232
  # Filter out special tokens for cleaner output
233
  special = {self.PAD_TOKEN, self.BOS_TOKEN, self.EOS_TOKEN, self.UNK_TOKEN}
234
  return " ".join(t for t in tokens if t not in special)
235
+
236
  def save_vocabulary(
237
  self,
238
  save_directory: str,
 
240
  ) -> tuple:
241
  """
242
  Save the vocabulary to a JSON file.
243
+
244
  Args:
245
  save_directory: Directory to save the vocabulary.
246
  filename_prefix: Optional prefix for the filename.
247
+
248
  Returns:
249
  Tuple containing the path to the saved vocabulary file.
250
  """
251
  if not os.path.isdir(save_directory):
252
  os.makedirs(save_directory, exist_ok=True)
253
+
254
  vocab_file = os.path.join(
255
  save_directory,
256
  (filename_prefix + "-" if filename_prefix else "") + "vocab.json",
257
  )
258
+
259
  with open(vocab_file, "w", encoding="utf-8") as f:
260
  json.dump(self._vocab, f, ensure_ascii=False, indent=2)
261
+
262
  return (vocab_file,)
263
 
264
 
 
270
  ) -> Dict[str, int]:
271
  """
272
  Count token frequencies in a dataset (useful for vocabulary analysis).
273
+
274
  Args:
275
  dataset_name: Name of the dataset on Hugging Face Hub.
276
  split: Dataset split to use.
277
  column: Column containing the game strings.
278
  max_samples: Maximum number of samples to process.
279
+
280
  Returns:
281
  Dictionary mapping tokens to their frequencies.
282
  """
283
  from collections import Counter
284
  from datasets import load_dataset
285
+
286
  dataset = load_dataset(dataset_name, split=split)
287
+
288
  if max_samples is not None:
289
  dataset = dataset.select(range(min(max_samples, len(dataset))))
290
+
291
  token_counts = Counter()
292
+
293
  for example in dataset:
294
  moves = example[column].strip().split()
295
  token_counts.update(moves)
296
+
297
  return dict(token_counts)
tokenizer_config.json CHANGED
@@ -33,12 +33,6 @@
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]",
@@ -46,5 +40,11 @@
46
  "model_max_length": 1000000000000000019884624838656,
47
  "pad_token": "[PAD]",
48
  "tokenizer_class": "ChessTokenizer",
49
- "unk_token": "[UNK]"
50
- }
 
 
 
 
 
 
 
33
  "special": true
34
  }
35
  },
 
 
 
 
 
 
36
  "bos_token": "[BOS]",
37
  "clean_up_tokenization_spaces": false,
38
  "eos_token": "[EOS]",
 
40
  "model_max_length": 1000000000000000019884624838656,
41
  "pad_token": "[PAD]",
42
  "tokenizer_class": "ChessTokenizer",
43
+ "unk_token": "[UNK]",
44
+ "auto_map": {
45
+ "AutoTokenizer": [
46
+ "tokenizer.ChessTokenizer",
47
+ null
48
+ ]
49
+ }
50
+ }
training_args.bin ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:d6233dcdd155640aa91cb55f44e1d6354ba7a1bfb4fbd7928908a301ea7f30b1
3
+ size 5777