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