-
Notifications
You must be signed in to change notification settings - Fork 611
[PyTorch][Core][JAX] Expand troubleshooting docs #2602
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
Open
jberchtold-nvidia
wants to merge
4
commits into
NVIDIA:main
Choose a base branch
from
jberchtold-nvidia:jberchtold/expand-troubleshooting-installation-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -308,6 +308,37 @@ Troubleshooting | |
| cd transformer_engine | ||
| pip install -v -v -v --no-build-isolation . | ||
|
|
||
| **Problems using UV or Virtual Environments:** | ||
|
|
||
| 1. **Import Error:** | ||
|
|
||
| * **Symptoms:** Cannot import ``transformer_engine`` | ||
| * **Solution:** Ensure your UV environment is active and that you have used ``uv pip install --no-build-isolation <te_pypi_package_or_wheel_or_source_dir>`` instead of a regular pip install to your system environment. | ||
|
|
||
| 2. **cuDNN Sublibrary Loading Failed:** | ||
|
|
||
| * **Symptoms:** Errors at runtime with ``CUDNN_STATUS_SUBLIBRARY_LOADING_FAILED`` | ||
| * **Solution:** This can occur when TE is built against the container's system installation of cuDNN, but pip packages inside the virtual environment pull in pip packages for ``nvidia-cudnn-cu12/cu13``. To resolve this, when building TE from source please specify the following environment variables to point to the cuDNN in your virtual environment. | ||
|
|
||
|
|
||
| .. code-block:: bash | ||
|
|
||
| export CUDNN_PATH=$(pwd)/.venv/lib/python3.12/site-packages/nvidia/cudnn | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. style: hardcoded Python version may not work for all users - consider using a generic placeholder like Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time! |
||
| export CUDNN_HOME=$CUDNN_PATH | ||
| export LD_LIBRARY_PATH=$CUDNN_PATH/lib:$LD_LIBRARY_PATH | ||
|
|
||
| 3. **Building Wheels:** | ||
|
|
||
| * **Symptoms:** Regular TE installs work correctly but UV wheel builds fail at runtime. | ||
| * **Solution:** Ensure that ``uv build --wheel --no-build-isolation -v`` is used during the wheel build as well as the pip installation of the wheel. Use ``-v`` for verbose output to verify that TE is not pulling in a mismatching version of PyTorch or JAX that differs from the UV environment's version. | ||
|
|
||
| **JAX-specific Common Issues and Solutions:** | ||
|
|
||
| 1. **FFI Issues:** | ||
|
|
||
| * **Symptoms:** ``No registered implementation for custom call to <some_te_ffi> for platform CUDA`` | ||
| * **Solution:** Ensure ``--no-build-isolation`` is used during installation. If pre-building wheels, ensure that the wheel is both built and installed with ``--no-build-isolation``. See "Problems using UV or Virtual Environments" above if using UV. | ||
|
|
||
| .. troubleshooting-end-marker-do-not-remove | ||
|
|
||
| Breaking Changes | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: extra blank line - RST should have only one blank line before code blocks (see lines 305-306 for consistent formatting)
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!