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

bug causes error uploading to huggingface, unicode issue on windows. #450

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

Conversation

resolver101757
Copy link
Contributor

@resolver101757 resolver101757 commented Sep 21, 2024

What this does

This PR resolves a bug in the LeRobot repository that causes an error when uploading a dataset to Huggingface on Windows due to a Unicode encoding issue. The problem arises because Windows, by default, uses cp1252 encoding, which cannot handle certain Unicode characters, such as emojis. The error is caused by the dataset card containing an emoji.

Error trace:

The error produced is 'Traceback (most recent call last):
File "D:\dev\lerobot\lerobot\scripts\control_robot.py", line 885, in
record(robot, **kwargs)
File "D:\dev\lerobot\lerobot\scripts\control_robot.py", line 681, in record
push_dataset_card_to_hub(repo_id, revision="main", tags=tags)
File "D:\dev\lerobot\lerobot\scripts\push_dataset_to_hub.py", line 124, in push_dataset_card_to_hub
card.push_to_hub(repo_id=repo_id, repo_type="dataset", revision=revision)
File "C:\Users\tblocal.conda\envs\lerobot\lib\site-packages\huggingface_hub\repocard.py", line 277, in push_to_hub
tmp_path.write_text(str(self))
File "C:\Users\tblocal.conda\envs\lerobot\lib\pathlib.py", line 1155, in write_text
return f.write(data)
File "C:\Users\tblocal.conda\envs\lerobot\lib\encodings\cp1252.py", line 19, in encode
return codecs.charmap_encode(input,self.errors,encoding_table)[0]
UnicodeEncodeError: 'charmap' codec can't encode character '\U0001f917' in position 102: character maps to

This fix removes the emoji 🤗 which prevents UnicodeEncodeError.

How it was tested

  • The script was run using the following command:

python lerobot/scripts/control_robot.py record --robot-path lerobot/configs/robot/koch_original.yaml --fps 30 --root data --repo-id RESOLVER101757/koch_test_2 --tags tutorial --warmup-time-s 5 --episode-time-s 30 --reset-time-s 30 --num-episodes 1

  • The run proceeded without encountering the UnicodeEncodeError, confirming that the issue is resolved.

How to checkout & try? (for the reviewer)

  1. Pull this branch.
  2. Run the record command:

python lerobot/scripts/control_robot.py record --robot-path lerobot/configs/robot/koch_original.yaml --fps 30 --root data --repo-id RESOLVER101757/koch_test_2 --tags tutorial --warmup-time-s 5 --episode-time-s 30 --reset-time-s 30 --num-episodes 1

  1. Verify that the command runs without the UnicodeEncodeError, and the dataset uploads successfully.

@resolver101757 resolver101757 changed the title bug causes error uploading to huggingface bug, unicode issue on windows. bug causes error uploading to huggingface, unicode issue on windows. Sep 21, 2024
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.

1 participant