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, os
   9
  10 import torch, torchvision
  11 from torch import nn
  12 from torch.nn import functional as F
  13
  14 import ffutils
  15 import mygpt, tasks, problems
  16
  17 ######################################################################
  18
  19 if torch.cuda.is_available():
  20     device = torch.device("cuda")
  21     torch.backends.cuda.matmul.allow_tf32 = True
  22 else:
  23     device = torch.device("cpu")
  24
  25 ######################################################################
  26
  27 parser = argparse.ArgumentParser(
  28     description="An implementation of GPT with cache.",
  29     formatter_class=argparse.ArgumentDefaultsHelpFormatter,
  30 )
  31
  32 parser.add_argument(
  33     "--task",
  34     type=str,
  35     default="sandbox",
  36     help="sandbox, picoclvr, mnist, maze, snake, stack, expr, rpl, world",
  37 )
  38
  39 parser.add_argument("--log_filename", type=str, default="train.log", help=" ")
  40
  41 parser.add_argument("--result_dir", type=str, default=None)
  42
  43 parser.add_argument("--seed", type=int, default=0)
  44
  45 parser.add_argument("--max_percents_of_test_in_train", type=int, default=1)
  46
  47 ########################################
  48
  49 parser.add_argument("--nb_epochs", type=int, default=None)
  50
  51 parser.add_argument("--batch_size", type=int, default=None)
  52
  53 parser.add_argument("--nb_train_samples", type=int, default=None)
  54
  55 parser.add_argument("--nb_test_samples", type=int, default=None)
  56
  57 parser.add_argument("--optim", type=str, default="adam")
  58
  59 parser.add_argument("--learning_rate", type=float, default=1e-4)
  60
  61 parser.add_argument("--learning_rate_schedule", type=str, default="10: 2e-5,30: 4e-6")
  62
  63 ########################################
  64
  65 parser.add_argument("--model", type=str, default="37M")
  66
  67 parser.add_argument("--dim_model", type=int, default=None)
  68
  69 parser.add_argument("--dim_keys", type=int, default=None)
  70
  71 parser.add_argument("--dim_hidden", type=int, default=None)
  72
  73 parser.add_argument("--nb_heads", type=int, default=None)
  74
  75 parser.add_argument("--nb_blocks", type=int, default=None)
  76
  77 parser.add_argument("--dropout", type=float, default=0.1)
  78
  79 ########################################
  80
  81 parser.add_argument("--deterministic_synthesis", action="store_true", default=False)
  82
  83 parser.add_argument("--no_checkpoint", action="store_true", default=False)
  84
  85 parser.add_argument("--overwrite_results", action="store_true", default=False)
  86
  87 parser.add_argument("--checkpoint_name", type=str, default="checkpoint.pth")
  88
  89 ##############################
  90 # rpl options
  91
  92 parser.add_argument("--rpl_nb_starting_values", type=int, default=5)
  93
  94 parser.add_argument("--rpl_max_input", type=int, default=9)
  95
  96 parser.add_argument("--rpl_prog_len", type=int, default=10)
  97
  98 parser.add_argument("--rpl_nb_runs", type=int, default=8)
  99
 100 parser.add_argument("--rpl_no_prog", action="store_true", default=False)
 101
 102 ##############################
 103 # sandbox options
 104
 105 parser.add_argument("--sandbox_level", type=int, default=0)
 106
 107 parser.add_argument("--sandbox_levels_nb_items", type=int, default=25)
 108
 109 parser.add_argument("--sandbox_levels_len_source", type=int, default=6)
 110
 111 parser.add_argument("--sandbox_levels_len_result", type=int, default=8)
 112
 113 ##############################
 114 # picoclvr options
 115
 116 parser.add_argument("--picoclvr_nb_colors", type=int, default=5)
 117
 118 parser.add_argument("--picoclvr_height", type=int, default=12)
 119
 120 parser.add_argument("--picoclvr_width", type=int, default=16)
 121
 122 parser.add_argument("--picocvlr_prune_properties", type=str, default="none")
 123
 124 ##############################
 125 # Maze options
 126
 127 parser.add_argument("--maze_height", type=int, default=23)
 128
 129 parser.add_argument("--maze_width", type=int, default=39)
 130
 131 parser.add_argument("--maze_nb_walls", type=int, default=45)
 132
 133 ##############################
 134 # Snake options
 135
 136 parser.add_argument("--snake_height", type=int, default=6)
 137
 138 parser.add_argument("--snake_width", type=int, default=8)
 139
 140 parser.add_argument("--snake_nb_colors", type=int, default=5)
 141
 142 parser.add_argument("--snake_length", type=int, default=200)
 143
 144 ##############################
 145 # Stack options
 146
 147 parser.add_argument("--stack_nb_steps", type=int, default=100)
 148
 149 parser.add_argument("--stack_nb_stacks", type=int, default=3)
 150
 151 parser.add_argument("--stack_nb_digits", type=int, default=3)
 152
 153 parser.add_argument("--stack_fraction_values_for_train", type=float, default=0.75)
 154
 155 ##############################
 156 # Expr options
 157
 158 parser.add_argument("--expr_nb_variables", type=int, default=5)
 159
 160 parser.add_argument("--expr_sequence_length", type=int, default=40)
 161
 162 parser.add_argument("--expr_operand_max", type=int, default=9)
 163
 164 parser.add_argument("--expr_result_max", type=int, default=99)
 165
 166 parser.add_argument("--expr_input_file", type=str, default=None)
 167
 168 ##############################
 169 # World options
 170
 171 parser.add_argument("--world_vqae_nb_epochs", type=int, default=25)
 172
 173 ######################################################################
 174
 175 args = parser.parse_args()
 176
 177 assert args.picocvlr_prune_properties in {"none", "train+eval", "eval"}
 178
 179 if args.result_dir is None:
 180     args.result_dir = f"results_{args.task}"
 181
 182 ######################################################################
 183
 184 default_task_args = {
 185     "sandbox": {
 186         "nb_epochs": 50,
 187         "batch_size": 25,
 188         "nb_train_samples": 100000,
 189         "nb_test_samples": 10000,
 190     },
 191     "picoclvr": {
 192         "nb_epochs": 25,
 193         "batch_size": 25,
 194         "nb_train_samples": 250000,
 195         "nb_test_samples": 10000,
 196     },
 197     "mnist": {
 198         "nb_epochs": 25,
 199         "batch_size": 10,
 200         "nb_train_samples": 250000,
 201         "nb_test_samples": 10000,
 202     },
 203     "maze": {
 204         "nb_epochs": 25,
 205         "batch_size": 5,
 206         "nb_train_samples": 250000,
 207         "nb_test_samples": 10000,
 208     },
 209     "snake": {
 210         "nb_epochs": 5,
 211         "batch_size": 25,
 212         "nb_train_samples": 250000,
 213         "nb_test_samples": 10000,
 214     },
 215     "stack": {
 216         "nb_epochs": 5,
 217         "batch_size": 25,
 218         "nb_train_samples": 100000,
 219         "nb_test_samples": 1000,
 220     },
 221     "expr": {
 222         "nb_epochs": 40,
 223         "batch_size": 25,
 224         "nb_train_samples": 1000000,
 225         "nb_test_samples": 10000,
 226     },
 227     "rpl": {
 228         "nb_epochs": 40,
 229         "batch_size": 25,
 230         "nb_train_samples": 100000,
 231         "nb_test_samples": 10000,
 232     },
 233     "world": {
 234         "nb_epochs": 10,
 235         "batch_size": 25,
 236         "nb_train_samples": 25000,
 237         "nb_test_samples": 1000,
 238     },
 239 }
 240
 241 if args.task in default_task_args:
 242     for k, v in default_task_args[args.task].items():
 243         if getattr(args, k) is None:
 244             setattr(args, k, v)
 245
 246 ######################################################################
 247
 248 default_model_args = {
 249     "17K": {
 250         "dim_model": 32,
 251         "dim_keys": 32,
 252         "dim_hidden": 32,
 253         "nb_heads": 2,
 254         "nb_blocks": 2,
 255     },
 256     "37M": {
 257         "dim_model": 512,
 258         "dim_keys": 64,
 259         "dim_hidden": 2048,
 260         "nb_heads": 8,
 261         "nb_blocks": 12,
 262     },
 263     "122M": {
 264         "dim_model": 768,
 265         "dim_keys": 64,
 266         "dim_hidden": 2048,
 267         "nb_heads": 8,
 268         "nb_blocks": 24,
 269     },
 270     "352M": {
 271         "dim_model": 1024,
 272         "dim_keys": 64,
 273         "dim_hidden": 2048,
 274         "nb_heads": 8,
 275         "nb_blocks": 48,
 276     },
 277 }
 278
 279 if args.model in default_model_args:
 280     for k, v in default_model_args[args.model].items():
 281         if getattr(args, k) is None:
 282             setattr(args, k, v)
 283 else:
 284     raise ValueError(f"Unknown model {args.model}")
 285
 286 ######################################################################
 287
 288 try:
 289     os.mkdir(args.result_dir)
 290 except FileExistsError:
 291     if not args.overwrite_results:
 292         print(f"result directory {args.result_dir} already exists")
 293         exit(1)
 294
 295 log_file = open(os.path.join(args.result_dir, args.log_filename), "a")
 296
 297 if args.seed >= 0:
 298     # torch.backends.cudnn.deterministic = True
 299     # torch.backends.cudnn.benchmark = False
 300     # torch.use_deterministic_algorithms(True)
 301     torch.manual_seed(args.seed)
 302     if torch.cuda.is_available():
 303         torch.cuda.manual_seed_all(args.seed)
 304
 305 ######################################################################
 306
 307
 308 def log_string(s):
 309     t = time.strftime("%Y%m%d-%H:%M:%S ", time.localtime())
 310
 311     if log_file is not None:
 312         log_file.write(t + s + "\n")
 313         log_file.flush()
 314
 315     print(t + s)
 316     sys.stdout.flush()
 317
 318
 319 for n in vars(args):
 320     log_string(f"args.{n} {getattr(args, n)}")
 321
 322
 323 ######################################################################
 324
 325
 326 def picoclvr_pruner_horizontal_green(p):
 327     return not ("green" in p and ("left" in p or "right" in p))
 328
 329
 330 picoclvr_pruner_train = (
 331     picoclvr_pruner_horizontal_green
 332     if args.picocvlr_prune_properties in {"train+eval"}
 333     else None
 334 )
 335
 336 picoclvr_pruner_eval = (
 337     (lambda p: not picoclvr_pruner_horizontal_green(p))
 338     if args.picocvlr_prune_properties in {"train+eval", "eval"}
 339     else None
 340 )
 341
 342 ######################################################################
 343
 344 if args.task == "sandbox":
 345     if args.sandbox_level == 0:
 346         problem = problems.ProblemLevel0(
 347             nb_sentences=args.sandbox_levels_nb_items,
 348             len_prompt=args.sandbox_levels_len_source,
 349             len_result=args.sandbox_levels_len_result,
 350         )
 351     elif args.sandbox_level == 1:
 352         problem = problems.ProblemLevel1(
 353             nb_operators=args.sandbox_levels_nb_items,
 354             len_source=args.sandbox_levels_len_source,
 355             len_result=args.sandbox_levels_len_result,
 356         )
 357     elif args.sandbox_level == 2:
 358         problem = problems.ProblemLevel2(
 359             len_source=args.sandbox_levels_len_source,
 360             len_result=args.sandbox_levels_len_result,
 361         )
 362     else:
 363         raise ValueError(f"Unknown sandbox level {args.sandbox_level}")
 364
 365     task = tasks.SandBox(
 366         # problem,
 367         # problems.ProblemAddition(zero_padded=False, inverted_result=False),
 368         problems.ProblemLenId(len_max=args.sandbox_levels_len_source),
 369         nb_train_samples=args.nb_train_samples,
 370         nb_test_samples=args.nb_test_samples,
 371         batch_size=args.batch_size,
 372         logger=log_string,
 373         device=device,
 374     )
 375
 376 elif args.task == "picoclvr":
 377     task = tasks.PicoCLVR(
 378         nb_train_samples=args.nb_train_samples,
 379         nb_test_samples=args.nb_test_samples,
 380         batch_size=args.batch_size,
 381         height=args.picoclvr_height,
 382         width=args.picoclvr_width,
 383         nb_colors=args.picoclvr_nb_colors,
 384         logger=log_string,
 385         device=device,
 386         pruner_train=picoclvr_pruner_train,
 387         pruner_eval=picoclvr_pruner_eval,
 388     )
 389
 390 elif args.task == "mnist":
 391     task = tasks.MNIST(
 392         nb_train_samples=args.nb_train_samples,
 393         nb_test_samples=args.nb_test_samples,
 394         batch_size=args.batch_size,
 395         device=device,
 396     )
 397
 398 elif args.task == "maze":
 399     task = tasks.Maze(
 400         nb_train_samples=args.nb_train_samples,
 401         nb_test_samples=args.nb_test_samples,
 402         batch_size=args.batch_size,
 403         height=args.maze_height,
 404         width=args.maze_width,
 405         nb_walls=args.maze_nb_walls,
 406         device=device,
 407     )
 408
 409 elif args.task == "snake":
 410     task = tasks.Snake(
 411         nb_train_samples=args.nb_train_samples,
 412         nb_test_samples=args.nb_test_samples,
 413         batch_size=args.batch_size,
 414         height=args.snake_height,
 415         width=args.snake_width,
 416         nb_colors=args.snake_nb_colors,
 417         length=args.snake_length,
 418         prompt_length=args.snake_length // 2,
 419         device=device,
 420     )
 421
 422 elif args.task == "stack":
 423     task = tasks.Stack(
 424         nb_train_samples=args.nb_train_samples,
 425         nb_test_samples=args.nb_test_samples,
 426         batch_size=args.batch_size,
 427         logger=log_string,
 428         nb_steps=args.stack_nb_steps,
 429         nb_stacks=args.stack_nb_stacks,
 430         nb_digits=args.stack_nb_digits,
 431         fraction_values_for_train=args.stack_fraction_values_for_train,
 432         device=device,
 433     )
 434
 435 elif args.task == "expr":
 436     task = tasks.Expr(
 437         nb_train_samples=args.nb_train_samples,
 438         nb_test_samples=args.nb_test_samples,
 439         nb_variables=args.expr_nb_variables,
 440         sequence_length=args.expr_sequence_length,
 441         operand_max=args.expr_operand_max,
 442         result_max=args.expr_result_max,
 443         batch_size=args.batch_size,
 444         device=device,
 445     )
 446
 447 elif args.task == "rpl":
 448     task = tasks.RPL(
 449         nb_train_samples=args.nb_train_samples,
 450         nb_test_samples=args.nb_test_samples,
 451         batch_size=args.batch_size,
 452         nb_starting_values=args.rpl_nb_starting_values,
 453         max_input=args.rpl_max_input,
 454         prog_len=args.rpl_prog_len,
 455         nb_runs=args.rpl_nb_runs,
 456         no_prog=args.rpl_no_prog,
 457         logger=log_string,
 458         device=device,
 459     )
 460
 461 elif args.task == "world":
 462     task = tasks.World(
 463         nb_train_samples=args.nb_train_samples,
 464         nb_test_samples=args.nb_test_samples,
 465         batch_size=args.batch_size,
 466         vqae_nb_epochs=args.world_vqae_nb_epochs,
 467         logger=log_string,
 468         device=device,
 469     )
 470
 471 else:
 472     raise ValueError(f"Unknown task {args.task}")
 473
 474 ######################################################################
 475
 476 log_string(f"device {device}")
 477
 478 vocabulary_size = task.vocabulary_size()
 479
 480 log_string(f"vocabulary_size {vocabulary_size}")
 481
 482 ##############################
 483
 484 model = mygpt.MyGPT(
 485     vocabulary_size=vocabulary_size,
 486     dim_model=args.dim_model,
 487     dim_keys=args.dim_keys,
 488     dim_hidden=args.dim_hidden,
 489     nb_heads=args.nb_heads,
 490     nb_blocks=args.nb_blocks,
 491     causal=True,
 492     dropout=args.dropout,
 493 )
 494
 495 model.to(device)
 496
 497 nb_parameters = sum(p.numel() for p in model.parameters())
 498 log_string(f"nb_parameters {nb_parameters} ({int(nb_parameters/1e6)}M)")
 499
 500 ######################################################################
 501
 502 nb_epochs_finished = 0
 503
 504 if args.no_checkpoint:
 505     log_string(f"not trying to load checkpoint.")
 506
 507 else:
 508     try:
 509         checkpoint_name = os.path.join(args.result_dir, args.checkpoint_name)
 510         checkpoint = torch.load(checkpoint_name)
 511         nb_epochs_finished = checkpoint["nb_epochs_finished"]
 512         model.load_state_dict(checkpoint["model_state"])
 513         torch.set_rng_state(checkpoint["rng_state"])
 514         if torch.cuda.is_available():
 515             torch.cuda.set_rng_state(checkpoint["cuda_rng_state"])
 516
 517         log_string(f"checkpoint loaded with {nb_epochs_finished} epochs finished.")
 518
 519     except FileNotFoundError:
 520         log_string("starting from scratch.")
 521
 522     except:
 523         log_string("error when loading the checkpoint.")
 524         exit(1)
 525
 526 ######################################################################
 527
 528 if args.task == "expr" and args.expr_input_file is not None:
 529     task.produce_results(
 530         n_epoch=nb_epochs_finished,
 531         model=model,
 532         result_dir=args.result_dir,
 533         logger=log_string,
 534         deterministic_synthesis=args.deterministic_synthesis,
 535         input_file=args.expr_input_file,
 536     )
 537
 538     exit(0)
 539
 540 ######################################################################
 541
 542 nb_epochs = args.nb_epochs if args.nb_epochs > 0 else nb_epochs_default
 543
 544 # Compute the entropy of the training tokens
 545
 546 token_count = 0
 547 for input in task.batches(split="train"):
 548     token_count += F.one_hot(input, num_classes=task.vocabulary_size()).sum((0, 1))
 549 token_probas = token_count / token_count.sum()
 550 entropy = -torch.xlogy(token_probas, token_probas).sum()
 551 train_set_perplexity = math.exp(entropy)
 552
 553 ######################################################################
 554 # A bit of paranoia never hurts
 555
 556
 557 def subsets_as_tuples(batches, cs):
 558     s = set()
 559     for batch in batches:
 560         for x in batch:
 561             s.add(tuple([v.item() for v in x]))
 562             if len(s) == cs:
 563                 yield s
 564                 s = set()
 565     yield s
 566
 567
 568 nb_test, nb_in_train = 0, 0
 569 for test_subset in subsets_as_tuples(task.batches(split="test"), 25000):
 570     in_train = set()
 571     for train_subset in subsets_as_tuples(task.batches(split="train"), 25000):
 572         in_train.update(test_subset.intersection(train_subset))
 573     nb_in_train += len(in_train)
 574     nb_test += len(test_subset)
 575
 576 log_string(
 577     f"data_check {nb_in_train*100/nb_test:.02f}% ({nb_in_train}/{nb_test}) of test samples are in the train set"
 578 )
 579
 580 assert (
 581     nb_in_train <= args.max_percents_of_test_in_train * nb_test / 100
 582 ), f"More than {args.max_percents_of_test_in_train}% of test samples are in the train set"
 583
 584 ##############################
 585
 586 if args.learning_rate_schedule == "cos":
 587     learning_rate_schedule = {}
 588     for n_epoch in range(args.nb_epochs):
 589         u = n_epoch / args.nb_epochs * math.pi
 590         learning_rate_schedule[n_epoch] = args.learning_rate * 0.5 * (1 + math.cos(u))
 591 else:
 592     u = {
 593         int(k): float(v)
 594         for k, v in [
 595             tuple(x.split(":")) for x in args.learning_rate_schedule.split(",")
 596         ]
 597     }
 598
 599     learning_rate_schedule = {}
 600     learning_rate = args.learning_rate
 601     for n_epoch in range(args.nb_epochs):
 602         if n_epoch in u:
 603             learning_rate = u[n_epoch]
 604         learning_rate_schedule[n_epoch] = learning_rate
 605
 606 log_string(f"learning_rate_schedule {learning_rate_schedule}")
 607
 608 ##############################
 609
 610 nb_samples_seen = 0
 611
 612 if nb_epochs_finished >= nb_epochs:
 613     task.produce_results(
 614         n_epoch=nb_epochs_finished,
 615         model=model,
 616         result_dir=args.result_dir,
 617         logger=log_string,
 618         deterministic_synthesis=args.deterministic_synthesis,
 619     )
 620
 621 for n_epoch in range(nb_epochs_finished, nb_epochs):
 622     learning_rate = learning_rate_schedule[n_epoch]
 623
 624     log_string(f"learning_rate {learning_rate}")
 625
 626     if args.optim == "sgd":
 627         optimizer = torch.optim.SGD(model.parameters(), lr=learning_rate)
 628     elif args.optim == "adam":
 629         optimizer = torch.optim.Adam(model.parameters(), lr=learning_rate)
 630     elif args.optim == "adamw":
 631         optimizer = torch.optim.AdamW(model.parameters(), lr=learning_rate)
 632     else:
 633         raise ValueError(f"Unknown optimizer {args.optim}.")
 634
 635     model.train()
 636
 637     nb_train_samples, acc_train_loss = 0, 0.0
 638
 639     for input in task.batches(split="train"):
 640         input = input.to(device)
 641         output = model(mygpt.BracketedSequence(input)).x
 642         loss = F.cross_entropy(output.transpose(1, 2), input)
 643         acc_train_loss += loss.item() * input.size(0)
 644         nb_train_samples += input.size(0)
 645         nb_samples_seen += input.size(0)
 646
 647         optimizer.zero_grad()
 648         loss.backward()
 649         optimizer.step()
 650
 651     with torch.autograd.no_grad():
 652         model.eval()
 653
 654         nb_test_samples, acc_test_loss = 0, 0.0
 655
 656         for input in task.batches(split="test"):
 657             input = input.to(device)
 658
 659             output = model(mygpt.BracketedSequence(input)).x
 660             loss = F.cross_entropy(output.transpose(1, 2), input)
 661             acc_test_loss += loss.item() * input.size(0)
 662             nb_test_samples += input.size(0)
 663
 664         train_perplexity = math.exp(min(100, acc_train_loss / nb_train_samples))
 665         test_perplexity = math.exp(min(100, acc_test_loss / nb_test_samples))
 666
 667         log_string(
 668             f"perplexity {n_epoch} train_set {train_set_perplexity} train_prediction {train_perplexity} test_prediction {test_perplexity}"
 669         )
 670
 671         task.produce_results(
 672             n_epoch=n_epoch,
 673             model=model,
 674             result_dir=args.result_dir,
 675             logger=log_string,
 676             deterministic_synthesis=args.deterministic_synthesis,
 677         )
 678
 679     checkpoint = {
 680         "nb_epochs_finished": n_epoch + 1,
 681         "model_state": model.state_dict(),
 682         "rng_state": torch.get_rng_state(),
 683     }
 684
 685     if torch.cuda.is_available():
 686         checkpoint["cuda_rng_state"] = torch.cuda.get_rng_state()
 687
 688     checkpoint_name = os.path.join(args.result_dir, args.checkpoint_name)
 689     torch.save(checkpoint, checkpoint_name)
 690     log_string(f"saved checkpoint {checkpoint_name}")
 691
 692 ######################################################################