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

Add web binding Tokenizer.tokenToId() #41

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

grf53
Copy link

@grf53 grf53 commented Aug 6, 2024

In Tokenizer class of web binding, there is no tokenToId() method while idToToken() is.

There are already the original functions corresponding to tokenToId().

  • HFTokenizer.TokenToId()
  • SentencePieceTokenizer.TokenToId()

So I simply added function to use them on web.

Not sure logic related to unk_id() that I appended to the SentencePieceTokenizer.TokenToId() is consistent.
So please leave comments if there is any point to modify.

Thanks.

@CharlieFRuan
Copy link
Contributor

The web portion looks good to me. cc @Ubospica for the change on SentencePieceTokenizer.TokenToId()

@grf53
Copy link
Author

grf53 commented Aug 12, 2024

The web portion looks good to me. cc @Ubospica for the change on SentencePieceTokenizer.TokenToId()

@CharlieFRuan
Thanks for your comment. Alright to merge? or we need more reviews?

Copy link
Contributor

@Ubospica Ubospica left a comment

Choose a reason for hiding this comment

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

Hi @grf53, sorry I didn't see this message before. That looks good for me, just one thing to point out.

Comment on lines +40 to +46
int32_t TokenToId(const std::string& token) final {
int32_t id = sentence_piece_.PieceToId(token);
if (id == sentence_piece_.unk_id()) {
return -1;
}
return id;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Shall we still align with sentencepiece and still return unk when the token is not found?

Copy link
Author

Choose a reason for hiding this comment

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

Hello @Ubospica. Thanks for your comment!
I am not sure about current circumstances with sentencepiece, but I just wanted to enable tokenToId in web.
As I can see in the following description of Tokenizer.TokenToId(), -1 would be returned when it could not find the corresponding id.

/*!
* \brief Convert the given token to its corresponding id if it exists. If not, return -1.
*/
virtual int32_t TokenToId(const std::string& token) = 0;

The mentioned function is implementing that virtual method, so I wanted to make it as that.
(For HFTokenizer, it is already covered as I saw.)

As I understood, UNK token from sentencepiece tokenizer could be sth other than -1 due to the configuration. So I added explicit check with sentence_piece_ .unk_id(). But as I mentioned in the first comment, I am not sure this logic is really consistent considering practical uses, so you can suggest me to modify or revert that part to align it.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hello @grf53, thank you for your explanation!

I think we should still align with Huggingface tokenizers, which means returning unk_token instead of -1 when the token does not exist. Additionally, please add tests to ensure that unk_token is returned for non-existent tokens.

For the current implementation of HFTokenizer, we will later modify it to return unk_token instead of -1.

Thanks again for your contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants