| 1 | import copy |
| 2 | import math |
| 3 | import time |
| 4 | |
| 5 | import torch |
| 6 | import torch.nn as nn |
| 7 | from torch.nn.functional import log_softmax |
| 8 | from torch.optim.lr_scheduler import LambdaLR |
| 9 | |
| 10 | |
| 11 | def attention(query, key, value, mask=None, dropout=None): |
| 12 | "Compute 'Scaled Dot Product Attention'" |
| 13 | d_k = query.size(-1) |
| 14 | scores = torch.matmul(query, key.transpose(-2, -1)) / math.sqrt(d_k) |
| 15 | if mask is not None: |
| 16 | scores = scores.masked_fill(mask == 0, -1e9) |
| 17 | p_attn = scores.softmax(dim=-1) |
| 18 | if dropout is not None: |
| 19 | p_attn = dropout(p_attn) |
| 20 | return torch.matmul(p_attn, value), p_attn |
| 21 | |
| 22 | |
| 23 | def subsequent_mask(size): |
| 24 | "Mask out subsequent positions." |
| 25 | attn_shape = (1, size, size) |
| 26 | subsequent_mask = torch.triu(torch.ones(attn_shape), diagonal=1).type( |
| 27 | torch.uint8 |
| 28 | ) |
| 29 | return subsequent_mask == 0 |
| 30 | |
| 31 | |
| 32 | def clones(module, N): |
| 33 | "Produce N identical layers." |
| 34 | return nn.ModuleList([copy.deepcopy(module) for _ in range(N)]) |
| 35 | |
| 36 | |
| 37 | class MultiHeadedAttention(nn.Module): |
| 38 | def __init__(self, h, d_model, dropout=0.1): |
| 39 | "Take in model size and number of heads." |
| 40 | super(MultiHeadedAttention, self).__init__() |
| 41 | assert d_model % h == 0 |
| 42 | # We assume d_v always equals d_k |
| 43 | self.d_k = d_model // h |
| 44 | self.h = h |
| 45 | self.linears = clones(nn.Linear(d_model, d_model), 4) |
| 46 | self.attn = None |
| 47 | self.dropout = nn.Dropout(p=dropout) |
| 48 | |
| 49 | def forward(self, query, key, value, mask=None): |
| 50 | "Implements Figure 2" |
| 51 | if mask is not None: |
| 52 | # Same mask applied to all h heads. |
| 53 | mask = mask.unsqueeze(1) |
| 54 | nbatches = query.size(0) |
| 55 | |
| 56 | # 1) Do all the linear projections in batch from d_model => h x d_k |
| 57 | query, key, value = [ |
| 58 | lin(x).view(nbatches, -1, self.h, self.d_k).transpose(1, 2) |
| 59 | for lin, x in zip(self.linears, (query, key, value)) |
| 60 | ] |
| 61 | |
| 62 | # 2) Apply attention on all the projected vectors in batch. |
| 63 | x, self.attn = attention( |
| 64 | query, key, value, mask=mask, dropout=self.dropout |
| 65 | ) |
| 66 | |
| 67 | # 3) "Concat" using a view and apply a final linear. |
| 68 | x = ( |
| 69 | x.transpose(1, 2) |
| 70 | .contiguous() |
| 71 | .view(nbatches, -1, self.h * self.d_k) |
| 72 | ) |
| 73 | del query |
| 74 | del key |
| 75 | del value |
| 76 | return self.linears[-1](x) |
| 77 | |
| 78 | |
| 79 | class PositionwiseFeedForward(nn.Module): |
| 80 | "Implements FFN equation." |
| 81 | |
| 82 | def __init__(self, d_model, d_ff, dropout=0.1): |
| 83 | super(PositionwiseFeedForward, self).__init__() |
| 84 | self.w_1 = nn.Linear(d_model, d_ff) |
| 85 | self.w_2 = nn.Linear(d_ff, d_model) |
| 86 | self.dropout = nn.Dropout(dropout) |
| 87 | |
| 88 | def forward(self, x): |
| 89 | return self.w_2(self.dropout(self.w_1(x).relu())) |
| 90 | |
| 91 | |
| 92 | class Embeddings(nn.Module): |
| 93 | def __init__(self, d_model, vocab): |
| 94 | super(Embeddings, self).__init__() |
| 95 | self.lut = nn.Embedding(vocab, d_model) |
| 96 | self.d_model = d_model |
| 97 | |
| 98 | def forward(self, x): |
| 99 | return self.lut(x) * math.sqrt(self.d_model) |
| 100 | |
| 101 | |
| 102 | class PositionalEncoding(nn.Module): |
| 103 | "Implement the PE function." |
| 104 | |
| 105 | def __init__(self, d_model, dropout, max_len=5000): |
| 106 | super(PositionalEncoding, self).__init__() |
| 107 | self.dropout = nn.Dropout(p=dropout) |
| 108 | |
| 109 | # Compute the positional encodings once in log space. |
| 110 | pe = torch.zeros(max_len, d_model) |
| 111 | position = torch.arange(0, max_len).unsqueeze(1) |
| 112 | div_term = torch.exp( |
| 113 | torch.arange(0, d_model, 2) * -(math.log(10000.0) / d_model) |
| 114 | ) |
| 115 | pe[:, 0::2] = torch.sin(position * div_term) |
| 116 | pe[:, 1::2] = torch.cos(position * div_term) |
| 117 | pe = pe.unsqueeze(0) |
| 118 | self.register_buffer("pe", pe) |
| 119 | |
| 120 | def forward(self, x): |
| 121 | x = x + self.pe[:, : x.size(1)].requires_grad_(False) |
| 122 | return self.dropout(x) |
| 123 | |
| 124 | |
| 125 | class LayerNorm(nn.Module): |
| 126 | "Construct a layernorm module (See citation for details)." |
| 127 | |
| 128 | def __init__(self, features, eps=1e-6): |
| 129 | super(LayerNorm, self).__init__() |
| 130 | self.a_2 = nn.Parameter(torch.ones(features)) |
| 131 | self.b_2 = nn.Parameter(torch.zeros(features)) |
| 132 | self.eps = eps |
| 133 | |
| 134 | def forward(self, x): |
| 135 | mean = x.mean(-1, keepdim=True) |
| 136 | std = x.std(-1, keepdim=True) |
| 137 | return self.a_2 * (x - mean) / (std + self.eps) + self.b_2 |
| 138 | |
| 139 | |
| 140 | class SublayerConnection(nn.Module): |
| 141 | """ |
| 142 | A residual connection followed by a layer norm. |
| 143 | Note for code simplicity the norm is first as opposed to last. |
| 144 | """ |
| 145 | |
| 146 | def __init__(self, size, dropout): |
| 147 | super(SublayerConnection, self).__init__() |
| 148 | self.norm = LayerNorm(size) |
| 149 | self.dropout = nn.Dropout(dropout) |
| 150 | |
| 151 | def forward(self, x, sublayer): |
| 152 | "Apply residual connection to any sublayer with the same size." |
| 153 | return x + self.dropout(sublayer(self.norm(x))) |
| 154 | |
| 155 | |
| 156 | class EncoderLayer(nn.Module): |
| 157 | "Encoder is made up of self-attn and feed forward (defined below)" |
| 158 | |
| 159 | def __init__(self, size, self_attn, feed_forward, dropout): |
| 160 | super(EncoderLayer, self).__init__() |
| 161 | self.self_attn = self_attn |
| 162 | self.feed_forward = feed_forward |
| 163 | self.sublayer = clones(SublayerConnection(size, dropout), 2) |
| 164 | self.size = size |
| 165 | |
| 166 | def forward(self, x, mask): |
| 167 | "Follow Figure 1 (left) for connections." |
| 168 | x = self.sublayer[0](x, lambda x: self.self_attn(x, x, x, mask)) |
| 169 | return self.sublayer[1](x, self.feed_forward) |
| 170 | |
| 171 | |
| 172 | class Encoder(nn.Module): |
| 173 | "Core encoder is a stack of N layers" |
| 174 | |
| 175 | def __init__(self, layer, N): |
| 176 | super(Encoder, self).__init__() |
| 177 | self.layers = clones(layer, N) |
| 178 | self.norm = LayerNorm(layer.size) |
| 179 | |
| 180 | def forward(self, x, mask): |
| 181 | "Pass the input (and mask) through each layer in turn." |
| 182 | for layer in self.layers: |
| 183 | x = layer(x, mask) |
| 184 | return self.norm(x) |
| 185 | |
| 186 | |
| 187 | class DecoderLayer(nn.Module): |
| 188 | "Decoder is made of self-attn, src-attn, and feed forward (defined below)" |
| 189 | |
| 190 | def __init__(self, size, self_attn, src_attn, feed_forward, dropout): |
| 191 | super(DecoderLayer, self).__init__() |
| 192 | self.size = size |
| 193 | self.self_attn = self_attn |
| 194 | self.src_attn = src_attn |
| 195 | self.feed_forward = feed_forward |
| 196 | self.sublayer = clones(SublayerConnection(size, dropout), 3) |
| 197 | |
| 198 | def forward(self, x, memory, src_mask, tgt_mask): |
| 199 | "Follow Figure 1 (right) for connections." |
| 200 | m = memory |
| 201 | x = self.sublayer[0](x, lambda x: self.self_attn(x, x, x, tgt_mask)) |
| 202 | x = self.sublayer[1](x, lambda x: self.src_attn(x, m, m, src_mask)) |
| 203 | return self.sublayer[2](x, self.feed_forward) |
| 204 | |
| 205 | |
| 206 | class Decoder(nn.Module): |
| 207 | "Generic N layer decoder with masking." |
| 208 | |
| 209 | def __init__(self, layer, N): |
| 210 | super(Decoder, self).__init__() |
| 211 | self.layers = clones(layer, N) |
| 212 | self.norm = LayerNorm(layer.size) |
| 213 | |
| 214 | def forward(self, x, memory, src_mask, tgt_mask): |
| 215 | for layer in self.layers: |
| 216 | x = layer(x, memory, src_mask, tgt_mask) |
| 217 | return self.norm(x) |
| 218 | |
| 219 | |
| 220 | class EncoderDecoder(nn.Module): |
| 221 | """ |
| 222 | A standard Encoder-Decoder architecture. Base for this and many |
| 223 | other models. |
| 224 | """ |
| 225 | |
| 226 | def __init__(self, encoder, decoder, src_embed, tgt_embed, generator): |
| 227 | super(EncoderDecoder, self).__init__() |
| 228 | self.encoder = encoder |
| 229 | self.decoder = decoder |
| 230 | self.src_embed = src_embed |
| 231 | self.tgt_embed = tgt_embed |
| 232 | self.generator = generator |
| 233 | |
| 234 | def forward(self, src, tgt, src_mask, tgt_mask): |
| 235 | "Take in and process masked src and target sequences." |
| 236 | return self.decode(self.encode(src, src_mask), src_mask, tgt, tgt_mask) |
| 237 | |
| 238 | def encode(self, src, src_mask): |
| 239 | return self.encoder(self.src_embed(src), src_mask) |
| 240 | |
| 241 | def decode(self, memory, src_mask, tgt, tgt_mask): |
| 242 | return self.decoder(self.tgt_embed(tgt), memory, src_mask, tgt_mask) |
| 243 | |
| 244 | |
| 245 | class Generator(nn.Module): |
| 246 | "Define standard linear + softmax generation step." |
| 247 | |
| 248 | def __init__(self, d_model, vocab): |
| 249 | super(Generator, self).__init__() |
| 250 | self.proj = nn.Linear(d_model, vocab) |
| 251 | |
| 252 | def forward(self, x): |
| 253 | return log_softmax(self.proj(x), dim=-1) |
| 254 | |
| 255 | |
| 256 | def make_model( |
| 257 | src_vocab, tgt_vocab, N=6, d_model=512, d_ff=2048, h=8, dropout=0.1 |
| 258 | ): |
| 259 | "Helper: Construct a model from hyperparameters." |
| 260 | c = copy.deepcopy |
| 261 | attn = MultiHeadedAttention(h, d_model) |
| 262 | ff = PositionwiseFeedForward(d_model, d_ff, dropout) |
| 263 | position = PositionalEncoding(d_model, dropout) |
| 264 | model = EncoderDecoder( |
| 265 | Encoder(EncoderLayer(d_model, c(attn), c(ff), dropout), N), |
| 266 | Decoder(DecoderLayer(d_model, c(attn), c(attn), c(ff), dropout), N), |
| 267 | nn.Sequential(Embeddings(d_model, src_vocab), c(position)), |
| 268 | nn.Sequential(Embeddings(d_model, tgt_vocab), c(position)), |
| 269 | Generator(d_model, tgt_vocab), |
| 270 | ) |
| 271 | |
| 272 | # This was important from their code. |
| 273 | # Initialize parameters with Glorot / fan_avg. |
| 274 | for p in model.parameters(): |
| 275 | if p.dim() > 1: |
| 276 | nn.init.xavier_uniform_(p) |
| 277 | return model |
| 278 | |
| 279 | |
| 280 | def greedy_decode(model, src, src_mask, max_len, start_symbol): |
| 281 | memory = model.encode(src, src_mask) |
| 282 | ys = torch.zeros(1, 1).fill_(start_symbol).type_as(src.data) |
| 283 | for i in range(max_len - 1): |
| 284 | out = model.decode( |
| 285 | memory, src_mask, ys, subsequent_mask(ys.size(1)).type_as(src.data) |
| 286 | ) |
| 287 | prob = model.generator(out[:, -1]) |
| 288 | _, next_word = torch.max(prob, dim=1) |
| 289 | next_word = next_word.data[0] |
| 290 | ys = torch.cat( |
| 291 | [ys, torch.zeros(1, 1).type_as(src.data).fill_(next_word)], dim=1 |
| 292 | ) |
| 293 | return ys |
| 294 | |
| 295 | |
| 296 | class Batch: |
| 297 | """Object for holding a batch of data with mask during training.""" |
| 298 | |
| 299 | def __init__(self, src, tgt=None, pad=2): # 2 = <blank> |
| 300 | self.src = src |
| 301 | self.src_mask = (src != pad).unsqueeze(-2) |
| 302 | if tgt is not None: |
| 303 | self.tgt = tgt[:, :-1] |
| 304 | self.tgt_y = tgt[:, 1:] |
| 305 | self.tgt_mask = self.make_std_mask(self.tgt, pad) |
| 306 | self.ntokens = (self.tgt_y != pad).data.sum() |
| 307 | |
| 308 | @staticmethod |
| 309 | def make_std_mask(tgt, pad): |
| 310 | "Create a mask to hide padding and future words." |
| 311 | tgt_mask = (tgt != pad).unsqueeze(-2) |
| 312 | tgt_mask = tgt_mask & subsequent_mask(tgt.size(-1)).type_as( |
| 313 | tgt_mask.data |
| 314 | ) |
| 315 | return tgt_mask |
| 316 | |
| 317 | |
| 318 | class LabelSmoothing(nn.Module): |
| 319 | "Implement label smoothing." |
| 320 | |
| 321 | def __init__(self, size, padding_idx, smoothing=0.0): |
| 322 | super(LabelSmoothing, self).__init__() |
| 323 | self.criterion = nn.KLDivLoss(reduction="sum") |
| 324 | self.padding_idx = padding_idx |
| 325 | self.confidence = 1.0 - smoothing |
| 326 | self.smoothing = smoothing |
| 327 | self.size = size |
| 328 | self.true_dist = None |
| 329 | |
| 330 | def forward(self, x, target): |
| 331 | assert x.size(1) == self.size |
| 332 | true_dist = x.data.clone() |
| 333 | true_dist.fill_(self.smoothing / (self.size - 2)) |
| 334 | true_dist.scatter_(1, target.data.unsqueeze(1), self.confidence) |
| 335 | true_dist[:, self.padding_idx] = 0 |
| 336 | mask = torch.nonzero(target.data == self.padding_idx) |
| 337 | if mask.dim() > 0: |
| 338 | true_dist.index_fill_(0, mask.squeeze(), 0.0) |
| 339 | self.true_dist = true_dist |
| 340 | return self.criterion(x, true_dist.clone().detach()) |
| 341 | |
| 342 | |
| 343 | class SimpleLossCompute: |
| 344 | "A simple loss compute and train function." |
| 345 | |
| 346 | def __init__(self, generator, criterion): |
| 347 | self.generator = generator |
| 348 | self.criterion = criterion |
| 349 | |
| 350 | def __call__(self, x, y, norm): |
| 351 | x = self.generator(x) |
| 352 | sloss = ( |
| 353 | self.criterion( |
| 354 | x.contiguous().view(-1, x.size(-1)), y.contiguous().view(-1) |
| 355 | ) |
| 356 | / norm |
| 357 | ) |
| 358 | return sloss.data * norm, sloss |
| 359 | |
| 360 | |
| 361 | def rate(step, model_size, factor, warmup): |
| 362 | """ |
| 363 | we have to default the step to 1 for LambdaLR function |
| 364 | to avoid zero raising to negative power. |
| 365 | """ |
| 366 | if step == 0: |
| 367 | step = 1 |
| 368 | return factor * ( |
| 369 | model_size ** (-0.5) * min(step ** (-0.5), step * warmup ** (-1.5)) |
| 370 | ) |
| 371 | |
| 372 | |
| 373 | class TrainState: |
| 374 | """Track number of steps, examples, and tokens processed""" |
| 375 | |
| 376 | step: int = 0 # Steps in the current epoch |
| 377 | accum_step: int = 0 # Number of gradient accumulation steps |
| 378 | samples: int = 0 # total # of examples used |
| 379 | tokens: int = 0 # total # of tokens processed |
| 380 | |
| 381 | |
| 382 | def run_epoch( |
| 383 | data_iter, |
| 384 | model, |
| 385 | loss_compute, |
| 386 | optimizer, |
| 387 | scheduler, |
| 388 | mode="train", |
| 389 | accum_iter=1, |
| 390 | train_state=TrainState(), |
| 391 | ): |
| 392 | """Train a single epoch""" |
| 393 | start = time.time() |
| 394 | total_tokens = 0 |
| 395 | total_loss = 0 |
| 396 | tokens = 0 |
| 397 | n_accum = 0 |
| 398 | for i, batch in enumerate(data_iter): |
| 399 | out = model.forward( |
| 400 | batch.src, batch.tgt, batch.src_mask, batch.tgt_mask |
| 401 | ) |
| 402 | loss, loss_node = loss_compute(out, batch.tgt_y, batch.ntokens) |
| 403 | # loss_node = loss_node / accum_iter |
| 404 | if mode == "train" or mode == "train+log": |
| 405 | loss_node.backward() |
| 406 | train_state.step += 1 |
| 407 | train_state.samples += batch.src.shape[0] |
| 408 | train_state.tokens += batch.ntokens |
| 409 | if i % accum_iter == 0: |
| 410 | optimizer.step() |
| 411 | optimizer.zero_grad(set_to_none=True) |
| 412 | n_accum += 1 |
| 413 | train_state.accum_step += 1 |
| 414 | scheduler.step() |
| 415 | |
| 416 | total_loss += loss |
| 417 | total_tokens += batch.ntokens |
| 418 | tokens += batch.ntokens |
| 419 | if i % 40 == 1 and (mode == "train" or mode == "train+log"): |
| 420 | lr = optimizer.param_groups[0]["lr"] |
| 421 | elapsed = time.time() - start |
| 422 | print( |
| 423 | ( |
| 424 | "Epoch Step: %6d | Accumulation Step: %3d | Loss: %6.2f " |
| 425 | + "| Tokens / Sec: %7.1f | Learning Rate: %6.1e" |
| 426 | ) |
| 427 | % (i, n_accum, loss / batch.ntokens, tokens / elapsed, lr) |
| 428 | ) |
| 429 | start = time.time() |
| 430 | tokens = 0 |
| 431 | del loss |
| 432 | del loss_node |
| 433 | return total_loss / total_tokens, train_state |
| 434 | |
| 435 | |
| 436 | class DummyOptimizer(torch.optim.Optimizer): |
| 437 | def __init__(self): |
| 438 | self.param_groups = [{"lr": 0}] |
| 439 | None |
| 440 | |
| 441 | def step(self): |
| 442 | None |
| 443 | |
| 444 | def zero_grad(self, set_to_none=False): |
| 445 | None |
| 446 | |
| 447 | |
| 448 | class DummyScheduler: |
| 449 | def step(self): |
| 450 | None |
| 451 | |
| 452 | |
| 453 | def data_gen(V, batch_size, nbatches): |
| 454 | "Generate random data for a src-tgt copy task." |
| 455 | for i in range(nbatches): |
| 456 | data = torch.randint(1, V, size=(batch_size, 10)) |
| 457 | data[:, 0] = 1 |
| 458 | src = data.requires_grad_(False).clone().detach() |
| 459 | tgt = data.requires_grad_(False).clone().detach() |
| 460 | yield Batch(src, tgt, 0) |
| 461 | |
| 462 | |
| 463 | def example_simple_model(): |
| 464 | V = 11 |
| 465 | criterion = LabelSmoothing(size=V, padding_idx=0, smoothing=0.0) |
| 466 | model = make_model(V, V, N=2) |
| 467 | |
| 468 | optimizer = torch.optim.Adam( |
| 469 | model.parameters(), lr=0.5, betas=(0.9, 0.98), eps=1e-9 |
| 470 | ) |
| 471 | lr_scheduler = LambdaLR( |
| 472 | optimizer=optimizer, |
| 473 | lr_lambda=lambda step: rate( |
| 474 | step, model_size=model.src_embed[0].d_model, factor=1.0, warmup=400 |
| 475 | ), |
| 476 | ) |
| 477 | |
| 478 | batch_size = 80 |
| 479 | for epoch in range(20): |
| 480 | model.train() |
| 481 | run_epoch( |
| 482 | data_gen(V, batch_size, 20), |
| 483 | model, |
| 484 | SimpleLossCompute(model.generator, criterion), |
| 485 | optimizer, |
| 486 | lr_scheduler, |
| 487 | mode="train", |
| 488 | ) |
| 489 | model.eval() |
| 490 | run_epoch( |
| 491 | data_gen(V, batch_size, 5), |
| 492 | model, |
| 493 | SimpleLossCompute(model.generator, criterion), |
| 494 | DummyOptimizer(), |
| 495 | DummyScheduler(), |
| 496 | mode="eval", |
| 497 | )[0] |
| 498 | |
| 499 | model.eval() |
| 500 | src = torch.LongTensor([[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]]) |
| 501 | max_len = src.shape[1] |
| 502 | src_mask = torch.ones(1, 1, max_len) |
| 503 | print(greedy_decode(model, src, src_mask, max_len=max_len, start_symbol=0)) |