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

fixes to SO-100 readme #600

Merged
merged 6 commits into from
Jan 10, 2025
Merged

fixes to SO-100 readme #600

merged 6 commits into from
Jan 10, 2025

Conversation

philfung
Copy link
Contributor

What this does

Fixes to the S0-100 instructions

  • Mac: added Mac-specific instructions. the previous instructions were only for Ubuntu
  • readability: increased readability by using numbered lists and sublists (see below for before/after)
  • links: links to youtube videos are to the exact sections of the video instead of to the start

How it was tested

  • looked through README, made sure instructions made sense for both ubuntu and Mac
  • I ran through and made the entire arm with a Mac using the README instructions

Possible reviewers: @jess-moss @Cadene @aliberts

before

Screenshot 2024-12-26 at 6 35 56 PM

after

Screenshot 2024-12-26 at 6 35 15 PM

Philip Fung and others added 2 commits December 26, 2024 18:26
- added Mac-specific instructions in addition to
Ubuntu instructions
- formatting: indexed list and sublist for readability
- links: links to youtube videos are to the exact sections
of the video instead of to the start

test plan:
- looked through README, made sure instructions made sense for both
 ubuntu and Mac
@philfung
Copy link
Contributor Author

philfung commented Jan 4, 2025

Hi! Quick ping to see if you are willing to merge this? It's a low-risk doc change and just trying to make your documentation better for others : ) . Thanks in any case!

Copy link
Collaborator

@aliberts aliberts left a comment

Choose a reason for hiding this comment

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

Thank you!
Suggested a few more changes to improve it a bit more and you're good to merge ;)

examples/10_use_so100.md Outdated Show resolved Hide resolved
examples/10_use_so100.md Outdated Show resolved Hide resolved
examples/10_use_so100.md Outdated Show resolved Hide resolved
examples/10_use_so100.md Outdated Show resolved Hide resolved
examples/10_use_so100.md Outdated Show resolved Hide resolved
examples/10_use_so100.md Outdated Show resolved Hide resolved
@philfung
Copy link
Contributor Author

thanks @aliberts - applied all your suggested changes in adb5b76. Appreciate reviewing and lmk if anything else!

@aliberts aliberts merged commit eec6796 into huggingface:main Jan 10, 2025
5 checks passed
villekuosmanen added a commit to villekuosmanen/lerobot that referenced this pull request Jan 10, 2025
* feat: enable to use multiple rgb encoders per camera in diffusion policy (huggingface#484)

Co-authored-by: Alexander Soare <[email protected]>

* Fix config file (huggingface#495)

* fix: broken images and a few minor typos in README (huggingface#499)

Signed-off-by: ivelin <[email protected]>

* Add support for Windows (huggingface#494)

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

* Add distinction between two unallowed cases in name check "eval_" (huggingface#489)

* Rename deprecated argument (temporal_ensemble_momentum) (huggingface#490)

* Dataset v2.0 (huggingface#461)

Co-authored-by: Remi <[email protected]>

* Refactor OpenX (huggingface#505)

* Fix missing local_files_only in record/replay (huggingface#540)

Co-authored-by: Simon Alibert <[email protected]>

* Control simulated robot with real leader (huggingface#514)

Co-authored-by: Remi <[email protected]>

* Update 7_get_started_with_real_robot.md (huggingface#559)

* LerobotDataset pushable to HF from any folder (huggingface#563)

* Fix example 6 (huggingface#572)

* fixing typo from 'teloperation' to 'teleoperation' (huggingface#566)

* [vizualizer] for LeRobodDataset V2 (huggingface#576)

* Fix broken `create_lerobot_dataset_card`  (huggingface#590)

* Update README.md (huggingface#612)

* Fix Quality workflow (huggingface#622)

* fix(docs): typos in benchmark readme.md (huggingface#614)

Co-authored-by: Simon Alibert <[email protected]>

* fix(visualise): use correct language description for each episode id (huggingface#604)

Co-authored-by: Simon Alibert <[email protected]>

* typo fix: batch_convert_dataset_v1_to_v2.py (huggingface#615)

Co-authored-by: Simon Alibert <[email protected]>

* [viz] Fixes & updates to html visualizer (huggingface#617)

* fixes to SO-100 readme (huggingface#600)

Co-authored-by: Philip Fung <no@one>
Co-authored-by: Simon Alibert <[email protected]>

---------

Signed-off-by: ivelin <[email protected]>
Co-authored-by: Hirokazu Ishida <[email protected]>
Co-authored-by: Alexander Soare <[email protected]>
Co-authored-by: Arsen Ohanyan <[email protected]>
Co-authored-by: Ivelin Ivanov <[email protected]>
Co-authored-by: Daniel Ritchie <[email protected]>
Co-authored-by: resolver101757 <[email protected]>
Co-authored-by: Jannik Grothusen <[email protected]>
Co-authored-by: KasparSLT <[email protected]>
Co-authored-by: Simon Alibert <[email protected]>
Co-authored-by: Remi <[email protected]>
Co-authored-by: Michel Aractingi <[email protected]>
Co-authored-by: Simon Alibert <[email protected]>
Co-authored-by: berjaoui <[email protected]>
Co-authored-by: Claudio Coppola <[email protected]>
Co-authored-by: s1lent4gnt <[email protected]>
Co-authored-by: Mishig <[email protected]>
Co-authored-by: Eugene Mironov <[email protected]>
Co-authored-by: CharlesCNorton <[email protected]>
Co-authored-by: Philip Fung <[email protected]>
Co-authored-by: Philip Fung <no@one>
chrisheninger pushed a commit to chrisheninger/lerobot that referenced this pull request Jan 26, 2025
Co-authored-by: Philip Fung <no@one>
Co-authored-by: Simon Alibert <[email protected]>
michel-aractingi pushed a commit that referenced this pull request Feb 3, 2025
Co-authored-by: Philip Fung <no@one>
Co-authored-by: Simon Alibert <[email protected]>
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.

2 participants