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

Enhanced Installation Section in README.md #35094

Open
wants to merge 19 commits into
base: main
Choose a base branch
from

Conversation

egojoseph
Copy link

This PR improves the Installation section in the README.md file by:

  • Adding GPU setup instructions for TensorFlow and PyTorch.
  • Including troubleshooting tips for Python version issues and missing dependencies.
  • Separating OS-specific virtual environment activation commands for clarity.
  • Providing links to relevant installation guides for backend frameworks.

These enhancements aim to improve the clarity and usability of the installation instructions for new users.

@Rocketknight1
Copy link
Member

cc @stevhliu!

@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.

@egojoseph
Copy link
Author

Hi @Rocketknight1 and @stevhliu, I noticed that this pull request requires workflow approval and a review to proceed. All checks have passed so far and I have updated the branch to sync with main. Could you kindly review and approve the workflows when convenient? Let me know if further changes are required. Thanks!"

@LysandreJik
Copy link
Member

We want the README.md to stay quite minimal, but those changes could be applied in the installation section in the docs!

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.

4 participants