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