Skip to content
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

fix sentencepiece tokenizer special tokens #11767

Merged

Conversation

akoumpa
Copy link
Member

@akoumpa akoumpa commented Jan 6, 2025

What does this PR do ?

Special tokens were not passed to sentencepiece library.

Collection: [Note which collection this PR will affect]

Changelog

  • Add specific line by line info of high level changes in this PR.

Usage

  • You can potentially add a usage example below
# Add a code snippet demonstrating how to use this 

GitHub Actions CI

The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.

The GitHub Actions CI will run automatically when the "Run CICD" label is added to the PR.
To re-run CI remove and add the label again.
To run CI on an untrusted fork, a NeMo user with write access must first click "Approve and run".

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you add or update any necessary documentation?
  • Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
    • Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

  • New Feature
  • Bugfix
  • Documentation

If you haven't finished some of the above items you can still open "Draft" PR.

Who can review?

Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.

Additional Information

  • Related to # (issue)

Signed-off-by: Alexandros Koumparoulis <[email protected]>
Signed-off-by: Alexandros Koumparoulis <[email protected]>
Signed-off-by: Alexandros Koumparoulis <[email protected]>
@akoumpa akoumpa force-pushed the akoumparouli/fix_sentencepiece_tokenizer_special_tokens branch from b45e00a to da653c0 Compare January 6, 2025 22:29
@akoumpa akoumpa changed the title Akoumparouli/fix sentencepiece tokenizer special tokens fix sentencepiece tokenizer special tokens Jan 6, 2025
Signed-off-by: Alexandros Koumparoulis <[email protected]>
@akoumpa akoumpa force-pushed the akoumparouli/fix_sentencepiece_tokenizer_special_tokens branch from b9af29f to a895489 Compare January 6, 2025 22:42
Signed-off-by: Alexandros Koumparoulis <[email protected]>
@akoumpa akoumpa force-pushed the akoumparouli/fix_sentencepiece_tokenizer_special_tokens branch from 138caaa to b9494cc Compare January 6, 2025 22:47
@akoumpa akoumpa added Run CICD and removed Run CICD labels Jan 6, 2025
Copy link
Contributor

github-actions bot commented Jan 6, 2025

beep boop 🤖: 🙏 The following files have warnings. In case you are familiar with these, please try helping us to improve the code base.


Your code was analyzed with PyLint. The following annotations have been identified:

************* Module nemo.collections.common.tokenizers.sentencepiece_tokenizer
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:42:0: C0301: Line too long (140/119) (line-too-long)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:43:0: C0301: Line too long (139/119) (line-too-long)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:307:0: C0301: Line too long (137/119) (line-too-long)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:362:0: C0301: Line too long (120/119) (line-too-long)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:371:0: C0301: Line too long (135/119) (line-too-long)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:376:0: C0301: Line too long (131/119) (line-too-long)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:377:0: C0301: Line too long (153/119) (line-too-long)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:378:0: C0301: Line too long (155/119) (line-too-long)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:203:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:257:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:265:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:273:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:281:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:288:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:295:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:302:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:314:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:323:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/common/tokenizers/sentencepiece_tokenizer.py:324:4: C0116: Missing function or method docstring (missing-function-docstring)
************* Module nemo.collections.nlp.modules.common.tokenizer_utils
nemo/collections/nlp/modules/common/tokenizer_utils.py:73:0: C0301: Line too long (199/119) (line-too-long)
nemo/collections/nlp/modules/common/tokenizer_utils.py:96:0: C0301: Line too long (149/119) (line-too-long)
nemo/collections/nlp/modules/common/tokenizer_utils.py:131:0: C0301: Line too long (146/119) (line-too-long)
nemo/collections/nlp/modules/common/tokenizer_utils.py:232:0: C0301: Line too long (146/119) (line-too-long)
nemo/collections/nlp/modules/common/tokenizer_utils.py:42:0: C0115: Missing class docstring (missing-class-docstring)

-----------------------------------
Your code has been rated at 9.34/10

Mitigation guide:

  • Add sensible and useful docstrings to functions and methods
  • For trivial methods like getter/setters, consider adding # pylint: disable=C0116 inside the function itself
  • To disable multiple functions/methods at once, put a # pylint: disable=C0116 before the first and a # pylint: enable=C0116 after the last.

By applying these rules, we reduce the occurance of this message in future.

Thank you for improving NeMo's documentation!

@@ -237,6 +237,9 @@ def add_special_tokens(self, special_tokens):
self.special_token_to_id[token] = self.vocab_size
self.id_to_special_token[self.vocab_size] = token
self.vocab_size += 1
elif self.tokenizer.piece_to_id(token) != self.tokenizer.unk_id():
Copy link
Member Author

Choose a reason for hiding this comment

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

if a token is already in the vocab, we want to allow users to mark them as special tokens.

@akoumpa akoumpa marked this pull request as ready for review January 6, 2025 23:28
Copy link
Collaborator

@cuichenx cuichenx left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

github-actions bot commented Jan 7, 2025

[🤖]: Hi @akoumpa 👋,

We wanted to let you know that a CICD pipeline for this PR just finished successfully

So it might be time to merge this PR or get some approvals

I'm just a bot so I'll leave it you what to do next.

//cc @pablo-garay @ko3n1g

@akoumpa akoumpa merged commit d98b7cd into main Jan 7, 2025
193 of 196 checks passed
@akoumpa akoumpa deleted the akoumparouli/fix_sentencepiece_tokenizer_special_tokens branch January 7, 2025 04:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants