main.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(
  30     description="An implementation of GPT with cache to solve a toy geometric reasoning task."
  31 )
  32
  33 parser.add_argument("--log_filename", type=str, default="train.log")
  34
  35 parser.add_argument("--result_dir", type=str, default="results_default")
  36
  37 parser.add_argument("--seed", type=int, default=0)
  38
  39 parser.add_argument("--nb_epochs", type=int, default=25)
  40
  41 parser.add_argument("--batch_size", type=int, default=25)
  42
  43 parser.add_argument("--nb_train_samples", type=int, default=250000)
  44
  45 parser.add_argument("--nb_test_samples", type=int, default=10000)
  46
  47 parser.add_argument("--optim", type=str, default="adam")
  48
  49 parser.add_argument("--learning_rate", type=float, default=1e-4)
  50
  51 parser.add_argument("--learning_rate_schedule", type=str, default="10: 2e-5,30: 4e-6")
  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("--checkpoint_name", type=str, default="checkpoint.pth")
  72
  73 ##############################
  74 # picoclvr options
  75
  76 parser.add_argument("--nb_colors", type=int, default=5)
  77
  78 parser.add_argument("--height", type=int, default=12)
  79
  80 parser.add_argument("--width", type=int, default=16)
  81
  82 parser.add_argument("--prune_properties", type=str, default="none")
  83
  84 ######################################################################
  85
  86 args = parser.parse_args()
  87
  88 assert args.prune_properties in {"none", "train+eval", "eval"}
  89
  90 try:
  91     os.mkdir(args.result_dir)
  92 except FileExistsError:
  93     if not args.overwrite_results:
  94         print(f"result directory {args.result_dir} already exists")
  95         exit(1)
  96
  97 log_file = open(os.path.join(args.result_dir, args.log_filename), "a")
  98
  99 if args.seed >= 0:
 100     # torch.backends.cudnn.deterministic = True
 101     # torch.backends.cudnn.benchmark = False
 102     # torch.use_deterministic_algorithms(True)
 103     torch.manual_seed(args.seed)
 104     if torch.cuda.is_available():
 105         torch.cuda.manual_seed_all(args.seed)
 106
 107 ######################################################################
 108
 109
 110 def log_string(s):
 111     t = time.strftime("%Y%m%d-%H:%M:%S ", time.localtime())
 112
 113     if log_file is not None:
 114         log_file.write(t + s + "\n")
 115         log_file.flush()
 116
 117     print(t + s)
 118     sys.stdout.flush()
 119
 120
 121 for n in vars(args):
 122     log_string(f"args.{n} {getattr(args, n)}")
 123
 124 ######################################################################
 125
 126
 127 def masked_inplace_autoregression(
 128     model, batch_size, input, ar_mask, forbidden_tokens=None, device=torch.device("cpu")
 129 ):
 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             model(
 134                 mygpt.BracketedSequence(input, 0, i.min())
 135             )  # Needed to initialize the model's cache
 136         for s in range(i.min(), i.max() + 1):
 137             output = model(mygpt.BracketedSequence(input, s, 1)).x
 138             logits = output[:, s]
 139             if forbidden_tokens is not None:
 140                 logits = logits.masked_fill(forbidden_tokens, float("-inf"))
 141             if args.deterministic_synthesis:
 142                 t_next = logits.argmax(1)
 143             else:
 144                 dist = torch.distributions.categorical.Categorical(logits=logits)
 145                 t_next = dist.sample()
 146             input[:, s] = ar_mask[:, s] * t_next + (1 - ar_mask[:, s]) * input[:, s]
 147
 148
 149 ######################################################################
 150
 151
 152 class Task:
 153     def batches(self, split="train"):
 154         pass
 155
 156     def vocabulary_size(self):
 157         pass
 158
 159     def produce_results(self, n_epoch, model):
 160         pass
 161
 162
 163 ######################################################################
 164
 165 import picoclvr
 166
 167
 168 class TaskPicoCLVR(Task):
 169     # Make a tensor from a list of strings
 170     def tensorize(self, descr):
 171         token_descr = [s.strip().split(" ") for s in descr]
 172         l = max([len(s) for s in token_descr])
 173         token_descr = [s + ["<nul>"] * (l - len(s)) for s in token_descr]
 174         id_descr = [[self.token2id[u] for u in s] for s in token_descr]
 175         return torch.tensor(id_descr, device=self.device)
 176
 177     # Make a list of strings from a tensor
 178     def detensorize(self, x):
 179         return [" ".join([self.id2token[t.item()] for t in r]) for r in x]
 180
 181     # trim all the tensors in the tuple z to remove as much token from
 182     # left and right in the first tensor. If z is a tuple, all its
 183     # elements are trimed according to the triming for the first
 184     def trim(self, z, token="<nul>"):
 185         n = self.token2id[token]
 186         if type(z) == tuple:
 187             x = z[0]
 188             i = (1 - (F.pad(x, (1, 1), value=n) == n).min(0).values.long()).cumsum(0)
 189             a, b = (i == 0).nonzero().max(), (i == i.max()).nonzero().min()
 190             return tuple([t[:, a:b] for t in z])
 191         else:
 192             i = (1 - (F.pad(z, (1, 1), value=n) == n).min(0).values.long()).cumsum(0)
 193             a, b = (i == 0).nonzero().max(), (i == i.max()).nonzero().min()
 194             return z[:, a:b]
 195
 196     ######################
 197     # Not the cleanest part of the code
 198
 199     # Extract the last image of each sequence, from the last <img>
 200     # included, and set to <nul> all the tokens from the beginning of
 201     # that image to the end
 202     def excise_last_image(self, input):
 203         t_img, t_nul = self.token2id["<img>"], self.token2id["<nul>"]
 204         nb_img_tokens = self.height * self.width + 1
 205
 206         input = input.clone()
 207         t = (input == t_img).long()
 208         tail_masks = (t.cumsum(dim=1) == t.sum(dim=1, keepdim=True)).long()
 209         i = (t * tail_masks).nonzero(as_tuple=True)
 210         j = (
 211             i[0][:, None],
 212             i[1][:, None] + torch.arange(nb_img_tokens, device=input.device)[None, :],
 213         )
 214         images = self.trim(input[j])
 215         input[j] = t_nul
 216         loss_masks = 1 - tail_masks
 217         input, loss_masks = self.trim((input, loss_masks))
 218         return input, loss_masks, images
 219
 220     def add_true_image(self, input, images, loss_masks):
 221         t_nul = self.token2id["<nul>"]
 222         nb_img_tokens = self.height * self.width + 1
 223         input = F.pad(input, (0, nb_img_tokens), value=t_nul)
 224         loss_masks = F.pad(loss_masks, (0, nb_img_tokens), value=0)
 225         t = (input == t_nul).long()
 226         i = (t.cumsum(dim=1) == 1).nonzero(as_tuple=True)
 227         j = (
 228             i[0][:, None],
 229             i[1][:, None] + torch.arange(nb_img_tokens, device=input.device)[None, :],
 230         )
 231         input[j] = images
 232         loss_masks[j] = 1
 233         input, loss_masks = self.trim((input, loss_masks))
 234         return input, loss_masks
 235
 236     def add_generated_image(self, input, loss_masks, model):
 237         t_img, t_nul = self.token2id["<img>"], self.token2id["<nul>"]
 238         nb_img_tokens = self.height * self.width + 1
 239
 240         input = F.pad(input, (0, nb_img_tokens), value=t_nul)
 241         loss_masks = F.pad(loss_masks, (0, nb_img_tokens), value=0)
 242         t = (input == t_nul).long()
 243         i = (t.cumsum(dim=1) == 1).nonzero(as_tuple=True)
 244         input[i] = t_img
 245
 246         j = (
 247             i[0][:, None],
 248             i[1][:, None]
 249             + 1
 250             + torch.arange(nb_img_tokens - 1, device=input.device)[None, :],
 251         )
 252         ar_masks = input.new_zeros(input.size(), dtype=torch.int64)
 253         ar_masks[j] = 1
 254         forbidden_tokens = (
 255             torch.arange(self.vocabulary_size(), device=input.device) == t_nul
 256         )
 257         with torch.autograd.no_grad():
 258             t = model.training
 259             model.eval()
 260             masked_inplace_autoregression(
 261                 model,
 262                 self.batch_size,
 263                 input,
 264                 ar_masks,
 265                 forbidden_tokens,
 266                 device=self.device,
 267             )
 268             model.train(t)
 269
 270         input, loss_masks = self.trim((input, loss_masks))
 271
 272         return input, loss_masks
 273
 274     ######################
 275
 276     def __init__(
 277         self,
 278         nb_train_samples,
 279         nb_test_samples,
 280         batch_size,
 281         height,
 282         width,
 283         nb_colors=5,
 284         device=torch.device("cpu"),
 285         pruner_train=None,
 286         pruner_eval=None,
 287     ):
 288         def generate_descr(nb, cache_suffix, pruner):
 289             return picoclvr.generate(
 290                 nb,
 291                 height=self.height,
 292                 width=self.width,
 293                 nb_colors=nb_colors,
 294                 pruner=pruner,
 295             )
 296
 297         self.height = height
 298         self.width = width
 299         self.batch_size = batch_size
 300         self.device = device
 301         self.pruner_train = pruner_train
 302         self.pruner_eval = pruner_eval
 303
 304         param = {
 305             "nb_train_samples": nb_train_samples,
 306             "nb_test_samples": nb_test_samples,
 307             "height": height,
 308             "width": width,
 309             "nb_colors": nb_colors,
 310             "batch_size": batch_size,
 311             "rng_state": list(torch.get_rng_state()),
 312         }
 313
 314         log_string(f"generating {nb_train_samples+nb_test_samples} samples (can take some time)")
 315         self.train_descr = generate_descr(nb_train_samples, "train", pruner=self.pruner_train)
 316         self.test_descr = generate_descr(nb_test_samples, "test", pruner=None)
 317
 318         # Build the tokenizer
 319         tokens = {"<nul>", "<img>"}
 320         for d in [self.train_descr, self.test_descr]:
 321             for s in d:
 322                 for t in s.strip().split(" "):
 323                     tokens.add(t)
 324         # make this set a sorted list to get the same tensors given
 325         # the same descr
 326         tokens = list(tokens)
 327         tokens.sort()
 328         self.token2id = dict([(t, n) for n, t in enumerate(tokens)])
 329         self.id2token = dict([(n, t) for n, t in enumerate(tokens)])
 330
 331         # Tokenize the train and test sets
 332         self.train_input = self.tensorize(self.train_descr)
 333         self.test_input = self.tensorize(self.test_descr)
 334
 335     def batches(self, split="train"):
 336         assert split in {"train", "test"}
 337         input = self.train_input if split == "train" else self.test_input
 338         for batch in tqdm.tqdm(
 339             input.split(self.batch_size), dynamic_ncols=True, desc=f"epoch-{split}"
 340         ):
 341             yield self.trim(batch)
 342
 343     def vocabulary_size(self):
 344         return len(self.token2id)
 345
 346     def compute_missing_properties(self, n_epoch, model, pruner=None):
 347         acc_nb_requested_properties = []
 348         acc_nb_missing_properties = []
 349         acc_nb_results = 0
 350
 351         for input in tqdm.tqdm(
 352             self.test_input.split(self.batch_size),
 353             dynamic_ncols=True,
 354             desc=f"test-properties",
 355         ):
 356             tape, loss_masks, _ = self.excise_last_image(input)
 357             tape, loss_masks = self.add_generated_image(tape, loss_masks, model)
 358             result_descr = self.detensorize(tape)
 359             np = picoclvr.nb_properties(
 360                 result_descr,
 361                 height=self.height,
 362                 width=self.width,
 363                 pruner=pruner,
 364             )
 365             nb_requested_properties, _, nb_missing_properties = zip(*np)
 366             acc_nb_requested_properties += nb_requested_properties
 367             acc_nb_missing_properties += nb_missing_properties
 368             acc_nb_results += len(result_descr)
 369
 370         nb_requested_properties = sum(acc_nb_requested_properties)
 371         nb_missing_properties = sum(acc_nb_missing_properties)
 372
 373         prefix = "" if pruner is None else "pruned_"
 374         log_string(f"nb_{prefix}samples {n_epoch} {acc_nb_results}")
 375         log_string(
 376             f"property_{prefix}nb {n_epoch} requested {sum(acc_nb_requested_properties)} missing {sum(acc_nb_missing_properties)}"
 377         )
 378         log_string(
 379             f"property_{prefix}miss {n_epoch} {100*nb_missing_properties/nb_requested_properties:.02f}%"
 380         )
 381
 382     ######################################################################
 383
 384     def produce_results(self, n_epoch, model):
 385         self.compute_missing_properties(n_epoch, model)
 386
 387         if self.pruner_eval is not None:
 388             self.compute_missing_properties(n_epoch, model, self.pruner_eval)
 389
 390         nb_tokens_to_generate = self.height * self.width + 3
 391         result_descr = []
 392         nb_per_primer = 8
 393         primer = []
 394
 395         for primer_descr in [
 396             "red above green <sep> green top <sep> blue right of red",
 397             "there is red <sep> there is yellow <sep> there is blue",
 398             "red below yellow <sep> yellow below green <sep> green below blue <sep> red right <sep> yellow left <sep> green right <sep> blue left",
 399             "green bottom <sep> yellow bottom <sep> green left of blue <sep> yellow right of blue <sep> blue top",
 400         ]:
 401             primer += [primer_descr] * nb_per_primer
 402
 403         tape = self.tensorize(primer)
 404         loss_masks = 1 - (tape == self.token2id["<nul>"]).long()
 405         tape, loss_masks = self.add_generated_image(tape, loss_masks, model)
 406         result_descr = self.detensorize(tape)
 407
 408         np = picoclvr.nb_properties(result_descr, height=self.height, width=self.width)
 409
 410         acc_nb_requested_properties, _, acc_nb_missing_properties = zip(*np)
 411         acc_nb_results = len(result_descr)
 412
 413         nb_requested_properties = sum(acc_nb_requested_properties)
 414         nb_missing_properties = sum(acc_nb_missing_properties)
 415
 416         prefix = "demo_"
 417         log_string(f"nb_{prefix}samples {n_epoch} {acc_nb_results}")
 418         log_string(
 419             f"property_{prefix}nb {n_epoch} requested {sum(acc_nb_requested_properties)} missing {sum(acc_nb_missing_properties)}"
 420         )
 421         log_string(
 422             f"property_{prefix}miss {n_epoch} {100*nb_missing_properties/nb_requested_properties:.02f}%"
 423         )
 424
 425         img = picoclvr.descr2img(result_descr, height=self.height, width=self.width)
 426
 427         if img.dim() == 5:
 428             if img.size(1) == 1:
 429                 img = F.pad(img.squeeze(1), pad=(1, 1, 1, 1), value=64)
 430             else:
 431                 img = torch.cat(
 432                     [
 433                         torchvision.utils.make_grid(x, padding=1, pad_value=64)[None]
 434                         for x in img
 435                     ],
 436                     0,
 437                 )
 438
 439         image_name = os.path.join(args.result_dir, f"result_{n_epoch:04d}.png")
 440         torchvision.utils.save_image(
 441             img / 255.0, image_name, nrow=nb_per_primer, padding=1, pad_value=1.0
 442         )
 443         log_string(f"wrote {image_name}")
 444
 445
 446 ######################################################################
 447
 448 log_string(f"device {device}")
 449
 450
 451 def pruner_horizontal_green(p):
 452     return not ("green" in p and ("left" in p or "right" in p))
 453
 454
 455 task = TaskPicoCLVR(
 456     nb_train_samples=args.nb_train_samples,
 457     nb_test_samples=args.nb_test_samples,
 458     batch_size=args.batch_size,
 459     height=args.height,
 460     width=args.width,
 461     nb_colors=args.nb_colors,
 462     device=device,
 463     pruner_train=pruner_horizontal_green
 464     if args.prune_properties in {"train+eval"}
 465     else None,
 466     pruner_eval=(lambda p: not pruner_horizontal_green(p))
 467     if args.prune_properties in {"train+eval", "eval"}
 468     else None,
 469 )
 470
 471 vocabulary_size = task.vocabulary_size()
 472
 473 log_string(f"vocabulary_size {vocabulary_size}")
 474
 475 ##############################
 476
 477 model = mygpt.MyGPT(
 478     vocabulary_size=vocabulary_size,
 479     dim_model=args.dim_model,
 480     dim_keys=args.dim_keys,
 481     dim_hidden=args.dim_hidden,
 482     nb_heads=args.nb_heads,
 483     nb_blocks=args.nb_blocks,
 484     causal=True,
 485     dropout=args.dropout,
 486 )
 487
 488 model.to(device)
 489
 490 nb_parameters = sum(p.numel() for p in model.parameters())
 491 log_string(f"nb_parameters {nb_parameters} ({int(nb_parameters/1e6)}M)")
 492
 493 ######################################################################
 494
 495 nb_epochs_finished = 0
 496
 497 if args.no_checkpoint:
 498     log_string(f"not trying to load checkpoint.")
 499
 500 else:
 501     try:
 502         checkpoint_name = os.path.join(args.result_dir, args.checkpoint_name)
 503         checkpoint = torch.load(checkpoint_name)
 504         nb_epochs_finished = checkpoint["nb_epochs_finished"]
 505         model.load_state_dict(checkpoint["model_state"])
 506         torch.set_rng_state(checkpoint["rng_state"])
 507         if torch.cuda.is_available():
 508             torch.cuda.set_rng_state(checkpoint["cuda_rng_state"])
 509
 510         log_string(f"checkpoint loaded with {nb_epochs_finished} epochs finished.")
 511
 512     except FileNotFoundError:
 513         log_string("starting from scratch.")
 514
 515     except:
 516         log_string("error when loading the checkpoint.")
 517         exit(1)
 518
 519 ######################################################################
 520
 521 nb_epochs = args.nb_epochs if args.nb_epochs > 0 else nb_epochs_default
 522
 523 token_count = 0
 524 for input in task.batches(split="train"):
 525     token_count += F.one_hot(input, num_classes=task.vocabulary_size()).sum((0, 1))
 526 token_probas = token_count / token_count.sum()
 527 entropy = -torch.xlogy(token_probas, token_probas).sum()
 528 train_set_perplexity = math.exp(entropy)
 529
 530 ##############################
 531
 532 if args.learning_rate_schedule == "cos":
 533     learning_rate_schedule = {}
 534     for n_epoch in range(args.nb_epochs):
 535         u = n_epoch / args.nb_epochs * math.pi
 536         learning_rate_schedule[n_epoch] = args.learning_rate * 0.5 * (1 + math.cos(u))
 537 else:
 538     u = {
 539         int(k): float(v)
 540         for k, v in [
 541             tuple(x.split(":")) for x in args.learning_rate_schedule.split(",")
 542         ]
 543     }
 544
 545     learning_rate_schedule = {}
 546     learning_rate = args.learning_rate
 547     for n_epoch in range(args.nb_epochs):
 548         if n_epoch in u:
 549             learning_rate = u[n_epoch]
 550         learning_rate_schedule[n_epoch] = learning_rate
 551
 552 log_string(f"learning_rate_schedule {learning_rate_schedule}")
 553
 554 ##############################
 555
 556 nb_samples_seen = 0
 557
 558 if nb_epochs_finished >= nb_epochs:
 559     task.produce_results(nb_epochs_finished, model)
 560
 561 for n_epoch in range(nb_epochs_finished, nb_epochs):
 562     learning_rate = learning_rate_schedule[n_epoch]
 563
 564     log_string(f"learning_rate {learning_rate}")
 565
 566     if args.optim == "sgd":
 567         optimizer = torch.optim.SGD(model.parameters(), lr=learning_rate)
 568     elif args.optim == "adam":
 569         optimizer = torch.optim.Adam(model.parameters(), lr=learning_rate)
 570     elif args.optim == "adamw":
 571         optimizer = torch.optim.AdamW(model.parameters(), lr=learning_rate)
 572     else:
 573         raise ValueError(f"Unknown optimizer {args.optim}.")
 574
 575     model.train()
 576
 577     nb_train_samples, acc_train_loss = 0, 0.0
 578
 579     for input in task.batches(split="train"):
 580         input = input.to(device)
 581         output = model(mygpt.BracketedSequence(input)).x
 582         loss = F.cross_entropy(output.transpose(1, 2), input)
 583         acc_train_loss += loss.item() * input.size(0)
 584         nb_train_samples += input.size(0)
 585         nb_samples_seen += input.size(0)
 586
 587         optimizer.zero_grad()
 588         loss.backward()
 589         optimizer.step()
 590
 591     with torch.autograd.no_grad():
 592         model.eval()
 593
 594         nb_test_samples, acc_test_loss = 0, 0.0
 595
 596         for input in task.batches(split="test"):
 597             input = input.to(device)
 598
 599             # input, loss_masks, true_images = task.excise_last_image(input)
 600             # input, loss_masks = task.add_true_image(input, true_images, loss_masks)
 601
 602             output = model(mygpt.BracketedSequence(input)).x
 603             loss = F.cross_entropy(output.transpose(1, 2), input)
 604             acc_test_loss += loss.item() * input.size(0)
 605             nb_test_samples += input.size(0)
 606
 607         train_perplexity = math.exp(min(100, acc_train_loss / nb_train_samples))
 608         test_perplexity = math.exp(min(100, acc_test_loss / nb_test_samples))
 609
 610         log_string(
 611             f"perplexity {n_epoch} train_set {train_set_perplexity} train_prediction {train_perplexity} test_prediction {test_perplexity}"
 612         )
 613
 614         task.produce_results(n_epoch, model)
 615
 616     checkpoint = {
 617         "nb_epochs_finished": n_epoch + 1,
 618         "model_state": model.state_dict(),
 619         "rng_state": torch.get_rng_state(),
 620     }
 621
 622     if torch.cuda.is_available():
 623         checkpoint["cuda_rng_state"] = torch.cuda.get_rng_state()
 624
 625     checkpoint_name = os.path.join(args.result_dir, args.checkpoint_name)
 626     torch.save(checkpoint, checkpoint_name)
 627     log_string(f"saved checkpoint {checkpoint_name}")
 628
 629 ######################################################################