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