You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+52-21Lines changed: 52 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,8 +28,60 @@ Feature Support Status
28
28
Installation
29
29
============
30
30
31
+
Install from manylinux wheels
32
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33
+
34
+
Starting from ROCm 7.0, we provide manylinux wheels for Transformer Engine releases on `https://repo.radeon.com/rocm/manylinux`. For example, the wheels for ROCm 7.1.1 are at `https://repo.radeon.com/rocm/manylinux/rocm-rel-7.1.1/`. From the page, you can find four files related to Transformer Engine:
35
+
36
+
* transformer_engine_rocm-*-py3-none-manylinux_2_28_x86_64.whl - This is the wheel file for installing the common library. It should not be installed by itself.
37
+
* transformer_engine-*-py3-none-any.whl - This is the wheel file for installing the common TE Python package.
38
+
* transformer_engine_jax-*.tar.gz - This is the source tar ball for the JAX extension.
39
+
* transformer_engine_torch-*.tar.gz - This is the source tar ball for the Pytorch extension.
40
+
41
+
Below are the example commands to download and install the wheels. They install both Pytorch and JAX extensions on the system where both frameworks are installed.
export NVTE_FRAMEWORK=pytorch,jax #optionally set framework, currently only support pytorch and jax; if not set will try to detect installed frameworks
64
+
export NVTE_ROCM_ARCH=gfx942,gfx950 # gfx942 for support of MI300/MI325, and gfx950 for support of MI350
65
+
66
+
# Build Platform Selection (optional)
67
+
# Note: Useful when both ROCm and CUDA platforms are present in the Docker
68
+
export NVTE_USE_ROCM=1 #Use 1 for ROCm, or set to 0 to use CUDA; If not set will try to detect installed platform, prioritizing ROCm
69
+
70
+
pip install . --no-build-isolation
71
+
72
+
It is also possible to build wheels for later installation with "pip wheel ." although those wheels will not be portable to systems with
73
+
different libraries installed. If the build still fails with the "--no-build-isolation" flag try installing setuptools<80.0.0
74
+
75
+
Note on Switching between Installation from Source and Installation from Wheels
76
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
77
+
Sometimes, issues might occur when installing from source on a system where a previous installation with wheels, or vice versa. It is safe to uninstall TE first before
78
+
switching between installing from source and installing from wheels. Here is the example command:
79
+
80
+
.. code-block:: bash
81
+
82
+
# The package name pattern might be transformer_engine or transformer-engine depending on setuptools version
83
+
pip list | grep transformer.engine | xargs pip uninstall -y
export NVTE_FRAMEWORK=pytorch,jax #optionally set framework, currently only support pytorch and jax; if not set will try to detect installed frameworks
70
-
export NVTE_ROCM_ARCH=gfx942 # CK fused attn only support MI200 and MI300 and fp8 features are only supported on MI300
71
-
72
-
# Build Platform Selection (optional)
73
-
# Note: Useful when both ROCm and CUDA platforms are present in the Docker
74
-
export NVTE_USE_ROCM=1 #Use 1 for ROCm, or set to 0 to use CUDA; If not set will try to detect installed platform, prioritizing ROCm
75
-
76
-
pip install --no-build-isolation .
77
-
78
-
It is also possible to build wheels for later installation with "pip wheel ." although those wheels will not be portable to systems with
79
-
different libraries installed. This build may also require "--no-build-isolation" and if the build still fails with this flag try installing setuptools<80.0.0
0 commit comments