Update
[beaver.git] / beaver.py
1 #!/usr/bin/env python
2
3 # Any copyright is dedicated to the Public Domain.
4 # https://creativecommons.org/publicdomain/zero/1.0/
5
6 # Written by Francois Fleuret <francois@fleuret.org>
7
8 # torch.backends.cuda.matmul.allow_tf23
9 # torch.autocast(torch.bfloat16)
10
11 import math, sys, argparse, time, tqdm, itertools, os
12
13 import torch, torchvision
14 from torch import nn
15 from torch.nn import functional as F
16
17 import mygpt, tensorstack
18
19 ######################################################################
20
21 if torch.cuda.is_available():
22     device = torch.device("cuda")
23     torch.backends.cuda.matmul.allow_tf32 = True
24 else:
25     device = torch.device("cpu")
26
27 ######################################################################
28
29 parser = argparse.ArgumentParser(description="A maze shortest path solving with a GPT.")
30
31 parser.add_argument("--log_filename", type=str, default="train.log")
32
33 parser.add_argument("--result_dir", type=str, default="results_default")
34
35 parser.add_argument("--seed", type=int, default=0)
36
37 parser.add_argument("--nb_epochs", type=int, default=25)
38
39 parser.add_argument("--nb_train_samples", type=int, default=200000)
40
41 parser.add_argument("--nb_test_samples", type=int, default=50000)
42
43 parser.add_argument("--batch_size", type=int, default=25)
44
45 parser.add_argument("--optim", type=str, default="adam")
46
47 parser.add_argument("--learning_rate", type=float, default=1e-3)
48
49 parser.add_argument(
50     "--learning_rate_schedule", type=str, default="10: 2e-4,20: 4e-5,30: 8e-6"
51 )
52
53 parser.add_argument("--dim_model", type=int, default=512)
54
55 parser.add_argument("--dim_keys", type=int, default=64)
56
57 parser.add_argument("--dim_hidden", type=int, default=2048)
58
59 parser.add_argument("--nb_heads", type=int, default=8)
60
61 parser.add_argument("--nb_blocks", type=int, default=12)
62
63 parser.add_argument("--dropout", type=float, default=0.1)
64
65 parser.add_argument("--deterministic_synthesis", action="store_true", default=False)
66
67 parser.add_argument("--no_checkpoint", action="store_true", default=False)
68
69 parser.add_argument("--overwrite_results", action="store_true", default=False)
70
71 parser.add_argument("--one_shot", action="store_true", default=False)
72
73 parser.add_argument("--checkpoint_name", type=str, default="checkpoint.pth")
74
75 ##############################
76 # maze options
77
78 parser.add_argument("--maze_height", type=int, default=13)
79
80 parser.add_argument("--maze_width", type=int, default=21)
81
82 parser.add_argument("--maze_nb_walls", type=int, default=15)
83
84 ######################################################################
85
86 args = parser.parse_args()
87
88 try:
89     os.mkdir(args.result_dir)
90 except FileExistsError:
91     if not args.overwrite_results:
92         print(f"result directory {args.result_dir} already exists")
93         exit(1)
94
95 log_file = open(os.path.join(args.result_dir, args.log_filename), "a")
96
97 if args.seed >= 0:
98     # torch.backends.cudnn.deterministic = True
99     # torch.backends.cudnn.benchmark = False
100     # torch.use_deterministic_algorithms(True)
101     torch.manual_seed(args.seed)
102     if torch.cuda.is_available():
103         torch.cuda.manual_seed_all(args.seed)
104
105 ######################################################################
106
107
108 def log_string(s):
109     t = time.strftime("%Y%m%d-%H:%M:%S ", time.localtime())
110
111     if log_file is not None:
112         log_file.write(t + s + "\n")
113         log_file.flush()
114
115     print(t + s)
116     sys.stdout.flush()
117
118
119 for n in vars(args):
120     log_string(f"args.{n} {getattr(args, n)}")
121
122 ######################################################################
123
124
125 # ar_mask is a Boolean matrix of same shape as input, with 1s on the
126 # tokens that should be generated
127
128
129 def masked_inplace_autoregression(model, batch_size, input, ar_mask):
130     for input, ar_mask in zip(input.split(batch_size), ar_mask.split(batch_size)):
131         i = (ar_mask.sum(0) > 0).nonzero()
132         if i.min() > 0:
133             # Needed to initialize the model's cache
134             model(mygpt.BracketedSequence(input, 0, i.min()))
135         for s in range(i.min(), i.max() + 1):
136             output = model(mygpt.BracketedSequence(input, s, 1)).x
137             logits = output[:, s]
138             if args.deterministic_synthesis:
139                 t_next = logits.argmax(1)
140             else:
141                 dist = torch.distributions.categorical.Categorical(logits=logits)
142                 t_next = dist.sample()
143             input[:, s] = ar_mask[:, s] * t_next + (1 - ar_mask[:, s]) * input[:, s]
144
145
146 ######################################################################
147
148
149 def compute_perplexity(model, split="train"):
150     with torch.autograd.no_grad():
151         t = model.training
152         model.eval()
153
154         nb_samples, acc_loss = 0, 0.0
155
156         for input in task.batches(split=split):
157             input = input.to(device)
158
159             output = model(mygpt.BracketedSequence(input)).x
160             loss = F.cross_entropy(output.transpose(1, 2), input)
161             acc_loss += loss.item() * input.size(0)
162             nb_samples += input.size(0)
163
164         model.train(t)
165
166         return math.exp(min(100, acc_loss / nb_samples))
167
168
169 ######################################################################
170
171
172 def one_shot(gpt, task):
173     t = gpt.training
174     gpt.eval()
175
176     model = nn.Sequential(
177         nn.Linear(args.dim_model, args.dim_model),
178         nn.ReLU(),
179         nn.Linear(args.dim_model, args.dim_model),
180         nn.ReLU(),
181         nn.Linear(args.dim_model, 4),
182     ).to(device)
183
184     for n_epoch in range(args.nb_epochs):
185         learning_rate = learning_rate_schedule[n_epoch]
186         optimizer = torch.optim.Adam(model.parameters(), lr=learning_rate)
187
188         acc_train_loss, nb_train_samples = 0, 0
189         for input, targets in task.policy_batches(split="train"):
190             output_gpt = gpt(mygpt.BracketedSequence(input), with_readout=False).x
191             output = model(output_gpt)
192             targets = targets * (input.unsqueeze(-1) == maze.v_empty)
193             output = output * (input.unsqueeze(-1) == maze.v_empty)
194             loss = (output.softmax(-1) - targets).abs().max(-1).values.mean()
195             # loss = (
196             # -(output.log_softmax(-1) * targets).sum()
197             # / (input == maze.v_empty).sum()
198             # + targets.xlogy(targets).sum() / (input == maze.v_empty).sum()
199             # )
200             acc_train_loss += loss.item() * input.size(0)
201             nb_train_samples += input.size(0)
202
203             optimizer.zero_grad()
204             loss.backward()
205             optimizer.step()
206
207         acc_test_loss, nb_test_samples = 0, 0
208         for input, targets in task.policy_batches(split="test"):
209             output_gpt = gpt(mygpt.BracketedSequence(input), with_readout=False).x
210             output = model(output_gpt)
211             targets = targets * (input.unsqueeze(-1) == maze.v_empty)
212             output = output * (input.unsqueeze(-1) == maze.v_empty)
213             loss = (output.softmax(-1) - targets).abs().max(-1).values.mean()
214             # loss = (
215             # -(output.log_softmax(-1) * targets).sum()
216             # / (input == maze.v_empty).sum()
217             # + targets.xlogy(targets).sum() / (input == maze.v_empty).sum()
218             # )
219             acc_test_loss += loss.item() * input.size(0)
220             nb_test_samples += input.size(0)
221
222         log_string(
223             f"diff_ce {n_epoch} train {acc_train_loss/nb_train_samples} test {acc_test_loss/nb_test_samples}"
224         )
225
226         # -------------------
227         input = task.test_input[:32, : task.height * task.width]
228         targets = task.test_policies[:32]
229         output_gpt = gpt(mygpt.BracketedSequence(input), with_readout=False).x
230         output = model(output_gpt)
231         # losses = (-output.log_softmax(-1) * targets + targets.xlogy(targets)).sum(-1)
232         # losses = losses * (input == maze.v_empty)
233         # losses = losses / losses.max()
234         losses = (output.softmax(-1) - targets).abs().max(-1).values
235         losses = (losses >= 0.05).float()
236         losses = losses.reshape(-1, args.maze_height, args.maze_width)
237         input = input.reshape(-1, args.maze_height, args.maze_width)
238         maze.save_image(
239             os.path.join(args.result_dir, f"oneshot_{n_epoch:04d}.png"),
240             mazes=input,
241             score_paths=losses,
242         )
243         # -------------------
244
245     gpt.train(t)
246
247
248 ######################################################################
249
250
251 class Task:
252     def batches(self, split="train"):
253         pass
254
255     def vocabulary_size(self):
256         pass
257
258     def produce_results(self, n_epoch, model):
259         pass
260
261
262 ######################################################################
263
264 import maze
265
266
267 class TaskMaze(Task):
268     def map2seq(self, *m):
269         return torch.cat([x.flatten(1) for x in m], 1)
270
271     def seq2map(self, s):
272         s = s.reshape(s.size(0), -1, self.height, self.width)
273         return (s[:, k] for k in range(s.size(1)))
274
275     def __init__(
276         self,
277         nb_train_samples,
278         nb_test_samples,
279         batch_size,
280         height,
281         width,
282         nb_walls,
283         device=torch.device("cpu"),
284     ):
285         self.batch_size = batch_size
286         self.height = height
287         self.width = width
288         self.device = device
289
290         train_mazes, train_paths, train_policies = maze.create_maze_data(
291             nb_train_samples,
292             height=height,
293             width=width,
294             nb_walls=nb_walls,
295             progress_bar=lambda x: tqdm.tqdm(x, dynamic_ncols=True, desc=f"data-train"),
296         )
297         self.train_input = self.map2seq(train_mazes.to(device), train_paths.to(device))
298         self.train_policies = train_policies.flatten(-2).permute(0, 2, 1).to(device)
299
300         test_mazes, test_paths, test_policies = maze.create_maze_data(
301             nb_test_samples,
302             height=height,
303             width=width,
304             nb_walls=nb_walls,
305             progress_bar=lambda x: tqdm.tqdm(x, dynamic_ncols=True, desc=f"data-test"),
306         )
307         self.test_input = self.map2seq(test_mazes.to(device), test_paths.to(device))
308         self.test_policies = test_policies.flatten(-2).permute(0, 2, 1).to(device)
309
310         self.nb_codes = self.train_input.max() + 1
311
312     def batches(self, split="train", nb_to_use=-1):
313         assert split in {"train", "test"}
314         input = self.train_input if split == "train" else self.test_input
315         if nb_to_use > 0:
316             input = input[:nb_to_use]
317         for batch in tqdm.tqdm(
318             input.split(self.batch_size), dynamic_ncols=True, desc=f"epoch-{split}"
319         ):
320             yield batch
321
322     def policy_batches(self, split="train", nb_to_use=-1):
323         assert split in {"train", "test"}
324         input = self.train_input if split == "train" else self.test_input
325         targets = self.train_policies if split == "train" else self.test_policies
326         input = input[:, : self.height * self.width]
327         targets = targets * (input != maze.v_wall)[:, :, None]
328
329         if nb_to_use > 0:
330             input = input[:nb_to_use]
331             targets = targets[:nb_to_use]
332
333         for batch in tqdm.tqdm(
334             zip(input.split(self.batch_size), targets.split(self.batch_size)),
335             dynamic_ncols=True,
336             desc=f"epoch-{split}",
337         ):
338             yield batch
339
340     def vocabulary_size(self):
341         return self.nb_codes
342
343     def compute_error(self, model, split="train", nb_to_use=-1):
344         nb_total, nb_correct = 0, 0
345         for input in task.batches(split, nb_to_use):
346             result = input.clone()
347             ar_mask = result.new_zeros(result.size())
348             ar_mask[:, self.height * self.width :] = 1
349             result *= 1 - ar_mask
350             masked_inplace_autoregression(model, self.batch_size, result, ar_mask)
351             mazes, paths = self.seq2map(result)
352             nb_correct += maze.path_correctness(mazes, paths).long().sum()
353             nb_total += mazes.size(0)
354
355         return nb_total, nb_correct
356
357     def produce_results(self, n_epoch, model):
358         with torch.autograd.no_grad():
359             t = model.training
360             model.eval()
361
362             train_nb_total, train_nb_correct = self.compute_error(
363                 model, "train", nb_to_use=1000
364             )
365             log_string(
366                 f"accuracy_train nb_total {train_nb_total} nb_correct {train_nb_correct} accuracy {(100.0*train_nb_correct)/train_nb_total:.02f}%"
367             )
368
369             test_nb_total, test_nb_correct = self.compute_error(
370                 model, "test", nb_to_use=1000
371             )
372             log_string(
373                 f"accuracy_test nb_total {test_nb_total} nb_correct {test_nb_correct} accuracy {(100.0*test_nb_correct)/test_nb_total:.02f}%"
374             )
375
376             input = self.test_input[:32]
377             result = input.clone()
378             ar_mask = result.new_zeros(result.size())
379             ar_mask[:, self.height * self.width :] = 1
380             result *= 1 - ar_mask
381             masked_inplace_autoregression(model, self.batch_size, result, ar_mask)
382
383             mazes, paths = self.seq2map(input)
384             _, predicted_paths = self.seq2map(result)
385             maze.save_image(
386                 os.path.join(args.result_dir, f"result_{n_epoch:04d}.png"),
387                 mazes=mazes,
388                 target_paths=paths,
389                 predicted_paths=predicted_paths,
390                 path_correct=maze.path_correctness(mazes, predicted_paths),
391             )
392
393             model.train(t)
394
395
396 ######################################################################
397
398 log_string(f"device {device}")
399
400
401 task = TaskMaze(
402     nb_train_samples=args.nb_train_samples,
403     nb_test_samples=args.nb_test_samples,
404     batch_size=args.batch_size,
405     height=args.maze_height,
406     width=args.maze_width,
407     nb_walls=args.maze_nb_walls,
408     device=device,
409 )
410
411
412 vocabulary_size = task.vocabulary_size()
413
414 log_string(f"vocabulary_size {vocabulary_size}")
415
416 ##############################
417
418 model = mygpt.MyGPT(
419     vocabulary_size=vocabulary_size,
420     dim_model=args.dim_model,
421     dim_keys=args.dim_keys,
422     dim_hidden=args.dim_hidden,
423     nb_heads=args.nb_heads,
424     nb_blocks=args.nb_blocks,
425     causal=True,
426     dropout=args.dropout,
427 )
428
429 model.to(device)
430
431 nb_parameters = sum(p.numel() for p in model.parameters())
432 log_string(f"nb_parameters {nb_parameters} ({int(nb_parameters/1e6)}M)")
433
434 ######################################################################
435
436 nb_epochs_finished = 0
437
438 if args.no_checkpoint:
439     log_string(f"not trying to load checkpoint.")
440
441 else:
442     try:
443         checkpoint_name = os.path.join(args.result_dir, args.checkpoint_name)
444         checkpoint = torch.load(checkpoint_name)
445         nb_epochs_finished = checkpoint["nb_epochs_finished"]
446         model.load_state_dict(checkpoint["model_state"])
447         torch.set_rng_state(checkpoint["rng_state"])
448         if torch.cuda.is_available():
449             torch.cuda.set_rng_state(checkpoint["cuda_rng_state"])
450
451         log_string(f"checkpoint loaded with {nb_epochs_finished} epochs finished.")
452
453     except FileNotFoundError:
454         log_string("starting from scratch.")
455
456     except:
457         log_string("error when loading the checkpoint.")
458         exit(1)
459
460 ######################################################################
461
462 token_count = 0
463 for input in task.batches(split="train"):
464     token_count += F.one_hot(input, num_classes=task.vocabulary_size()).sum((0, 1))
465 token_probas = token_count / token_count.sum()
466 entropy = -torch.xlogy(token_probas, token_probas).sum()
467 train_set_perplexity = math.exp(entropy)
468
469 ##############################
470
471 if args.learning_rate_schedule == "cos":
472     learning_rate_schedule = {}
473     for n_epoch in range(args.nb_epochs):
474         u = n_epoch / args.nb_epochs * math.pi
475         learning_rate_schedule[n_epoch] = args.learning_rate * 0.5 * (1 + math.cos(u))
476 else:
477     u = {
478         int(k): float(v)
479         for k, v in [
480             tuple(x.split(":")) for x in args.learning_rate_schedule.split(",")
481         ]
482     }
483
484     learning_rate_schedule = {}
485     learning_rate = args.learning_rate
486     for n_epoch in range(args.nb_epochs):
487         if n_epoch in u:
488             learning_rate = u[n_epoch]
489         learning_rate_schedule[n_epoch] = learning_rate
490
491 log_string(f"learning_rate_schedule {learning_rate_schedule}")
492
493 ##############################
494
495 if args.one_shot:
496     one_shot(model, task)
497     exit(0)
498
499 ##############################
500
501 if nb_epochs_finished >= args.nb_epochs:
502     n_epoch = nb_epochs_finished
503     train_perplexity = compute_perplexity(model, split="train")
504     test_perplexity = compute_perplexity(model, split="test")
505
506     log_string(
507         f"perplexity {n_epoch} train_set {train_set_perplexity} train_prediction {train_perplexity} test_prediction {test_perplexity}"
508     )
509
510     task.produce_results(n_epoch, model)
511
512     exit(0)
513
514 ##############################
515
516 for n_epoch in range(nb_epochs_finished, args.nb_epochs):
517     learning_rate = learning_rate_schedule[n_epoch]
518
519     log_string(f"learning_rate {learning_rate}")
520
521     if args.optim == "sgd":
522         optimizer = torch.optim.SGD(model.parameters(), lr=learning_rate)
523     elif args.optim == "adam":
524         optimizer = torch.optim.Adam(model.parameters(), lr=learning_rate)
525     elif args.optim == "adamw":
526         optimizer = torch.optim.AdamW(model.parameters(), lr=learning_rate)
527     else:
528         raise ValueError(f"Unknown optimizer {args.optim}.")
529
530     model.train()
531
532     nb_train_samples, acc_train_loss = 0, 0.0
533
534     for input in task.batches(split="train"):
535         input = input.to(device)
536         output = model(mygpt.BracketedSequence(input)).x
537         loss = F.cross_entropy(output.transpose(1, 2), input)
538         acc_train_loss += loss.item() * input.size(0)
539         nb_train_samples += input.size(0)
540
541         optimizer.zero_grad()
542         loss.backward()
543         optimizer.step()
544
545     train_perplexity = math.exp(min(100, acc_train_loss / nb_train_samples))
546     test_perplexity = compute_perplexity(model, split="test")
547
548     log_string(
549         f"perplexity {n_epoch} train_set {train_set_perplexity} train_prediction {train_perplexity} test_prediction {test_perplexity}"
550     )
551
552     task.produce_results(n_epoch, model)
553
554     checkpoint = {
555         "nb_epochs_finished": n_epoch + 1,
556         "model_state": model.state_dict(),
557         "rng_state": torch.get_rng_state(),
558     }
559
560     if torch.cuda.is_available():
561         checkpoint["cuda_rng_state"] = torch.cuda.get_rng_state()
562
563     checkpoint_name = os.path.join(args.result_dir, args.checkpoint_name)
564     torch.save(checkpoint, checkpoint_name)
565     log_string(f"saved checkpoint {checkpoint_name}")
566
567 ######################################################################