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: add support for wide characters when building index of dataset files #728

Merged

Conversation

mattmazzola
Copy link
Contributor

@mattmazzola mattmazzola commented Jun 7, 2023

Context

When reading a dataset for the first time metaseq will create an "index" file that will store the byte offset in the .jsonl file where item N begins

Issue

This calculation cur += len(line) was previously assuming the "length" of the read line was the offset of "next" item.
In the case that the line contains wide Unicode characters, this calculation is incorrect. len(line) will return 1 instead of the total bytes of the character.

Example

An example where len gives us the wrong number with a normal string that contains wide-unicode char
The correct length is given if we use a byte-string

>>> "\u2205"
''
>>> len("\u2205")
1
>>> len(b"\u2205")
6

Solution

Instead of keeping a running counter this PR simplifies the implementation by querying the current position of the file reader after every line is read. This approach properly accounts for the bytes and not the characters.

Credit goes to @tupini07 for diagnosing and fixing.

One of the important bug fixes from #726

Testing steps

We noticed this bug in our repo when testing datasets containing these wide characters and have been using it in our pipeline for few weeks now.

@facebook-github-bot
Copy link

Hi @mattmazzola!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Copy link
Contributor

@suchenzang suchenzang left a comment

Choose a reason for hiding this comment

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

Thanks for catching!

@suchenzang suchenzang merged commit f7ffa5f into facebookresearch:main Jun 8, 2023
1 of 2 checks passed
@mattmazzola mattmazzola deleted the mattm/wide-char-support branch June 8, 2023 17:57
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.

None yet

3 participants