Skip to content

Improve setup guide #31

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

Merged
merged 2 commits into from
Mar 7, 2025
Merged

Improve setup guide #31

merged 2 commits into from
Mar 7, 2025

Conversation

guangy10
Copy link
Collaborator

@guangy10 guangy10 commented Mar 5, 2025

  • Moved more packages to be required to simplify the setup
  • Added a section to setup virtual env
  • Added a section to install key dependencies from source
  • Explained API behavior when an ExecuTorch model is cached on Hub
  • Added a list of supported models and recipes due to ExecuTorch documentation is broken on Hub #2

@guangy10 guangy10 marked this pull request as ready for review March 5, 2025 20:40
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@guangy10 guangy10 force-pushed the fix_readme branch 4 times, most recently from 5192cab to 1a26031 Compare March 5, 2025 23:14

Verified

This commit was signed with the committer’s verified signature.
ms32035 Marcin Szymański
Copy link
Collaborator

@echarlaix echarlaix left a comment

Choose a reason for hiding this comment

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

LGTM!

setup.py Outdated
Comment on lines 15 to 16
"accelerate>=0.26.0",
"datasets",
Copy link
Collaborator

Choose a reason for hiding this comment

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

why do we need accelerate and datasets as required dependencies ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@echarlaix Yeah, required when running certain models, as reported by users here #29 (comment)

I want to simplify the UX so that users can have most common deps installed by default.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd be in favor of keeping the number of required dependencies as low as possible (only keeping what's necessary). Could you extend on why datasets needs to be added? Also for accelerate I don't think this is mandatory (we could for example check if accelerate is available and depending on it how to set low_cpu_mem_usage when loading the model) https://github.com/huggingface/transformers/blob/v4.49.0/src/transformers/modeling_utils.py#L3612 wdyt ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't want to block this PR so reverted in 7768d35, would you mind opening a new PR for this so that we merge this PR asap and continue the discussion there?

Copy link
Collaborator

Choose a reason for hiding this comment

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

also cc @michaelbenayoun who will likely review the second PR

@echarlaix echarlaix merged commit 906cac7 into huggingface:main Mar 7, 2025
17 of 23 checks passed
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.

None yet

3 participants