Docs: clarify installation steps, add ONNX export examples & troubleshooting #37

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.

Sign up for GitHub

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

Jump to bottom

Open

MaraschinoGirl wants to merge 2 commits into huggingface:main from MaraschinoGirl:docs/examples-install-and-cli

MaraschinoGirl commented Aug 14, 2025

This PR improves the README by:

Adding clear installation instructions for CPU and GPU.
Including virtual environment setup guidance.
Providing additional ONNX export examples (DistilBERT, Whisper, Gemma).
Adding a troubleshooting section for common installation and runtime issues.
Improving beginner accessibility with clearer formatting and links to docs.

These changes should make it easier for new users to install Optimum ONNX and get started quickly.

MaraschinoGirl and others added 2 commits

August 14, 2025 17:13


          Docs: improve install guide, add examples & troubleshooting

5a9718b


          Merge branch 'main' into docs/examples-install-and-cli

89a96ba

Member

IlyasMoutawwakil commented Oct 22, 2025

thanks for the improvements ! are the "---" necessary ? I don't think they look good 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet