Goals:
Install libraries.
#%pip install -q datasets transformers[sentencepiece]
Import PyTorch and the HuggingFace Transformers library.
import torch
import torch.nn as nn
import torch.nn.functional as F
import transformers
import pandas as pd
import matplotlib.pyplot as plt
%matplotlib inline
device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
Load a Marian Machine Translation model.
Specifically, we're using one that was trained on the OPUS corpus (opus-mt
) to translate text in any romance language (ROMANCE
) to English (en
).
from transformers import MarianMTModel, MarianTokenizer
model_name = 'Helsinki-NLP/opus-mt-ROMANCE-en'
tokenizer = MarianTokenizer.from_pretrained(model_name)
model = MarianMTModel.from_pretrained(model_name).to(device)
print(f"The model has {model.num_parameters():,d} parameters.")
Finally, these wrappers will make the code below easier to understand (you should completely ignore them).
from functools import partial
from transformers.models.marian.modeling_marian import shift_tokens_right
prepend_start_token = partial(
shift_tokens_right,
pad_token_id = model.config.pad_token_id, decoder_start_token_id = model.config.decoder_start_token_id)
encoder = model.get_encoder()
decoder = model.get_decoder()
encoder.forward = partial(encoder.forward, output_attentions=True, output_hidden_states=True)
decoder.forward = partial(decoder.forward, output_attentions=True, output_hidden_states=True)
Let's practice with the tokenizer. This should be mostly review, but we'll do it in the way that the HuggingFace docs do it.
spanish_text = "Yo les doy vida eterna."
spanish_batch = tokenizer(spanish_text, return_tensors='pt', padding=True).to(device)
spanish_batch
Since we're only translating one sentence, we can ignore attention_mask
(which just helps ignore padding tokens) and the extra initial dimension of the input_ids
.
input_ids = spanish_batch.input_ids
input_ids.shape
tokenizer.convert_ids_to_tokens(input_ids[0])
Now let's ask the model to generate a translation. Lots of magic happens here; we'll peel back the layers shortly.
translated = model.generate(input_ids = input_ids, num_beams=1, do_sample=False)
translated.shape
Decode the result!
with tokenizer.as_target_tokenizer():
english_text = tokenizer.decode(translated[0])
english_text
The generate
method can use several different algorithms under the hood. Let's see how each of them behaves:
def cross_entropy_for_sequences(logits, targets):
'''
Standard F.cross_entropy doesn't handle multiple sequences consistently.
This is a slow approach to get the correct sequences. (Faster would be to not reduce and multiply by (targets >= 0).sum(axis=1).)
'''
return [
F.cross_entropy(inp, tgt) for inp, tgt in zip(logits.unbind(), targets.unbind())
]
def generate_with_params(input_ids, **kwargs):
# Generate translations. Tell `generate` to give us the logits (which they call "scores")
translations = model.generate(input_ids = input_ids, return_dict_in_generate=True, output_scores=True, **kwargs)
# Recompute the cross-entropy (some `generate` outptus give us this, others don't, so we have to recompute).
logprobs = cross_entropy_for_sequences(translations.scores, translations.sequences)
with tokenizer.as_target_tokenizer():
return pd.DataFrame({
'sentence': tokenizer.batch_decode(translations.sequences),
'logprobs': logprobs
})
#with tokenizer.as_target_tokenizer():
# english_batch = tokenizer(english_text, return_tensors='pt', padding=True).to(device)
#decoder_input_ids = torch.tensor([model.config.decoder_start_token_id]).unsqueeze(0)
#outputs = model(input_ids=spanish_batch.input_ids, decoder_input_ids=decoder_input_ids)
#outputs.logits.shape
def predict_next_token(source_input_ids, decoded_so_far=[], k=5):
decoder_input_ids = torch.tensor([model.config.decoder_start_token_id] + decoded_so_far).unsqueeze(0).to(device)
assert input_ids.shape[0] == 1
with torch.no_grad(): # This tells PyTorch we don't need it to compute gradients for us.
model_output = model(input_ids = source_input_ids, decoder_input_ids=decoder_input_ids)
last_token_logits = model_output.logits[0, -1].cpu()
assert len(last_token_logits.shape) == 1
most_likely_tokens = last_token_logits.topk(k)
with tokenizer.as_target_tokenizer():
probs = most_likely_tokens.values.softmax(dim=0)
return pd.DataFrame({
'token': [tokenizer.decode(token_id) for token_id in most_likely_tokens.indices],
'id': most_likely_tokens.indices,
'probability': probs,
'logprob': probs.log(),
'cumulative probability': probs.cumsum(0)
})
print(-0.028718 + -0.083301, "I give")
predict_next_token(spanish_batch.input_ids, [20, 685])
The model gives us conditional probabilities of each word: P(word_i | src, word_1, word_2, ..., word_{i-1})
. You should recognize these as the softmax
We can use those to compute the probability of a complete translation by multiplying the conditional probabilities:
TODO
Those underflow, so we actually use the logs TODO
which are conveniently the cross-entropy loss values of each token. TODO
First, let's look at the loss that the model gives. We'll compare the correct translation with an incorrect one:
def tokenize_target_sentence(sentence):
with tokenizer.as_target_tokenizer():
return tokenizer(sentence, return_tensors='pt', padding=True).to(device)
wrong_target_batch = tokenize_target_sentence("I give them eternal death.")
Let's run a forward pass through the full model (encoder and decoder) with the complete candidate translation. First, the correct translation:
@torch.no_grad() # We don't need to compute gradients
def get_logprob_of_translation(src_ids, tgt_ids):
model_outputs = model(
input_ids = src_ids,
labels = tgt_ids
)
return model_outputs.loss # TODO: multiply by num tokens? Replace by manually doing cross_entropy_loss?
get_logprob_of_translation(spanish_batch.input_ids, correct_batch.input_ids)
Now (your turn) the incorrect translation:
# your code here
Ok now how did it do that?
You may find it helpful to have the documentation for the MarianMT model in HuggingFace Transformers open. But you can do all of this without referring to it.
I've ripped out all the plumbing code and things you only need in special situations to just show the guts of the model below. Study this code carefully with the help of the questions below it. Add comments to describe what each line does. Include, where applicable, the shape of the tensors involved.
encoder_input_ids = spanish_batch.input_ids
target_ids = english_batch.input_ids
decoder_input_ids = prepend_start_token(target_ids)
with torch.no_grad():
encoder_outputs = encoder(input_ids = encoder_input_ids)
# (Aside: an alternative to the above)
# encoder_input_embeddings = encoder.embed_tokens(encoder_input_ids) * encoder.embed_scale
# encoder_outputs = encoder(inputs_embeds = encoder_input_embeddings)
decoder_outputs = decoder(
input_ids = decoder_input_ids,
encoder_hidden_states = encoder_outputs.last_hidden_state
)
output_embedding = decoder_outputs.last_hidden_state
token_embeddings = model.lm_head.weight
logits = output_embedding @ token_embeddings.t()
logits += model.final_logits_bias
# ignore the batch dimension.
logits = logits[0]
nlls_of_correct_tokens = F.cross_entropy(logits, target_ids[0], reduction='none')
nlls_of_correct_tokens.mean()
Explain logits.shape
.
logits.shape
your narrative answer here
tokenizer.convert_ids_to_tokens(logits.argmax(dim=1))
tokenizer.convert_ids_to_tokens(target_ids[0])
What tensor contains all of the information from the Spanish sentence that is used to generate the English sentence? Explain each element of the shape of that tensor.
(The leading "1" is the batch dimension; you can ignore this unless you're translating multiple sentence simultaneously.)
What is the "shape" of this model? Specifically:
encoder_outputs.last_hidden_state.shape
model.config.num_hidden_layers
Read these as: the row token looks at the column token.
There are actually 8 attention heads for each of the 6 layers, so to visualize simply, we take the mean over the attention weights (which are all positive).
decoder_outputs.cross_attentions[0].shape
layer = 1
plt.pcolormesh(decoder_outputs.cross_attentions[layer][0].mean(dim=0).cpu().numpy())
plt.title(f"Cross-Attention Weights for layer {layer} (avg over all {model.config.num_attention_heads} heads)")
plt.xticks(torch.arange(8)+.5, tokenizer.convert_ids_to_tokens(encoder_input_ids[0]))
plt.yticks(torch.arange(7)+.5, tokenizer.convert_ids_to_tokens(decoder_input_ids[0]))
plt.colorbar();
layer = -1
plt.pcolormesh(encoder_outputs.attentions[layer][0].mean(dim=0).cpu().numpy())
plt.title(f"Encoder Self-Attention Weights for layer {layer} (avg over all {model.config.num_attention_heads} heads)")
plt.xticks(torch.arange(8)+.5, tokenizer.convert_ids_to_tokens(encoder_input_ids[0]))
plt.yticks(torch.arange(8)+.5, tokenizer.convert_ids_to_tokens(encoder_input_ids[0]))
plt.colorbar();
layer = 0
plt.pcolormesh(decoder_outputs.attentions[layer][0].mean(dim=0).cpu().numpy())
plt.title(f"Decoder Self-Attention Weights for layer {layer} (avg over all {model.config.num_attention_heads} heads)")
plt.xticks(torch.arange(7)+.5, tokenizer.convert_ids_to_tokens(decoder_input_ids[0]))
plt.yticks(torch.arange(7)+.5, tokenizer.convert_ids_to_tokens(decoder_input_ids[0]))
plt.colorbar();
Notice that the last step of the model is a dot product with all the token embeddings. Recall that a dot product is a measure of similarity. Let's look at similarity in embedding space.
normalized_token_embeddings = token_embeddings / token_embeddings.norm(p=2, dim=1, keepdim=True)
query_word = "London"
with tokenizer.as_target_tokenizer():
query_ids = tokenizer.encode(query_word, add_special_tokens=False)
print(query_ids)
query = token_embeddings[query_ids].mean(dim=0)
similarities = query @ normalized_token_embeddings.t()
most_similar_indices = similarities.topk(50).indices
tokenizer.convert_ids_to_tokens(most_similar_indices)
Your turn: now, take query vectors from the output_embeddings
that were calculated above and find the most similar token embeddings.
Compare the results with the translation output you saw from the model earlier.
# your code here
This is an exploration inspired by this article. Intuition: the Transformer iteratively refines a guess.
# http://stephantul.github.io/python/pytorch/2020/09/18/fast_topk/
def get_ranks(values, indices):
targets = values[range(len(values)), indices]
return (values > targets[:, None]).long().sum(dim=1)
ranks = []
print(tokenizer.convert_ids_to_tokens(decoder_input_ids[0]))
for hidden in decoder_outputs.hidden_states[1:]:
x = model.lm_head(hidden)[0]
print(tokenizer.convert_ids_to_tokens(x.argmax(dim=1)))
ranks.append(get_ranks(x, target_ids[0]))
torch.stack(ranks[::-1])