Skip to content

Conversation

@joecummings
Copy link
Member

@joecummings joecummings commented Feb 4, 2025

Context

What is the purpose of this PR? Is it to

  • add a new feature
  • fix a bug
  • update tests and/or documentation
  • other (please add here)

As detailed in #2337, the ending token for Qwen2 and Qwen2.5 should actually be "<|im_end|>", not "<|endoftext|>". This fixes that and updates tests accordingly.

Qwen2 tokenizer source
Qwen2.5 tokenizer source

Changelog

What are the changes made in this PR?

  • Change eos token id to be the token id for "<|im_end|>"
  • Set UNK id to null b/c that's the same way it is in HF code
  • Update tests

Test plan

Please make sure to do each of the following if applicable to your PR. If you're unsure about any one of these just ask and we will happily help. We also have a contributing page for some guidance on contributing.

  • run pre-commit hooks and linters (make sure you've first installed via pre-commit install)
  • add unit tests for any new functionality
  • update docstrings for any new or updated methods or classes
  • run unit tests via pytest tests
  • run recipe tests via pytest tests -m integration_test
  • manually run any new or modified recipes with sufficient proof of correctness
  • include relevant commands and any other artifacts in this summary (pastes of loss curves, eval results, etc.)

UX

If your function changed a public API, please add a dummy example of what the user experience will look like when calling it.
Here is a docstring example
and a tutorial example

  • I did not change any public API
  • I have added an example to docs or docstrings

@pytorch-bot
Copy link

pytorch-bot bot commented Feb 4, 2025

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/torchtune/2342

Note: Links to docs will display an error until the docs builds have been completed.

❗ 1 Active SEVs

There are 1 currently active SEVs. If your PR is affected, please view them below:

✅ No Failures

As of commit 6f01c17 with merge base 059cad9 (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Feb 4, 2025
@joecummings joecummings linked an issue Feb 4, 2025 that may be closed by this pull request
prompt_template: Optional[PromptTemplate] = None,
errors: str = "replace",
unk_token: Optional[str] = ENDOFTEXT,
unk_token: Optional[str] = None,
Copy link
Contributor

Choose a reason for hiding this comment

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

why did we need this before?

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't think we did. It was just incorrectly set.

self.im_start_id = self.special_tokens[IM_START]
self.im_end_id = self.special_tokens[IM_END]
self.stop_tokens = [self.eos_id, self.im_end_id]
self.stop_tokens = [self.eos_id, self.pad_id]
Copy link
Contributor

Choose a reason for hiding this comment

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

was "self.pad_id" not here also a bug?

Copy link
Member Author

Choose a reason for hiding this comment

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

No b/c eos_id was set to the pad_id. So now it's the same values, but proper references.

@felipemello1
Copy link
Contributor

did you have a chance to reproduce the python code detailed in the ticket and make sure the output is correct now? I can approve after that

@joecummings
Copy link
Member Author

did you have a chance to reproduce the python code detailed in the ticket and make sure the output is correct now? I can approve after that

I confirm that when I run the code on the ticket, I get the following output, which is correct according to the code on Hugging Face:

<|im_start|>user
user content<|im_end|>
<|im_start|>assistant
assistant content<|im_end|>

@joecummings joecummings merged commit 9475b5a into meta-pytorch:main Feb 5, 2025
17 checks passed
@joecummings joecummings deleted the update-qwen-tokenizer-special-toks branch February 5, 2025 00:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Qwen Tokenizer Excludes Last Assistant EOT Token

3 participants