Skip to content

Update transformer_tutorial.py | Resolving issue #1778 #2402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 2, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions beginner_source/transformer_tutorial.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,15 @@ def generate_square_subsequent_mask(sz: int) -> Tensor:
# positional encodings have the same dimension as the embeddings so that
# the two can be summed. Here, we use ``sine`` and ``cosine`` functions of
# different frequencies.
# The ``div_term`` in the code is calculated as
# ``torch.exp(torch.arange(0, d_model, 2) * (-math.log(10000.0) / d_model))``.
# This calculation is based on the original Transformer paper’s formulation
# for positional encoding. The purpose of this calculation is to create
# a range of values that decrease exponentially.
# This allows the model to learn to attend to positions based on their relative distances.
# The ``math.log(10000.0)`` term in the exponent represents the maximum effective
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this is correct, the maximum input length is max_len, not 10000. Am I missing something?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The purpose of this value is to make the frequencies of the sine and cosine functions very large. This is important because it helps to ensure that the positional encodings are unique for each position in the sequence. Right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think, I need to update this, too.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, can you please make the description less lengthy and in a simpler language. Thank you!

# input length (in this case, ``10000``). Dividing this term by ``d_model`` scales
# the values to be within a reasonable range for the exponential function.
#

class PositionalEncoding(nn.Module):
Expand Down