Skip to content

Commit d3017e4

Browse files
authored
Update readme (NVIDIA#6363)
* update readme Signed-off-by: ericharper <[email protected]> * try note fix Signed-off-by: ericharper <[email protected]> * try note fix Signed-off-by: ericharper <[email protected]> * remove note Signed-off-by: ericharper <[email protected]> * remove all note Signed-off-by: ericharper <[email protected]> * add code block Signed-off-by: ericharper <[email protected]> --------- Signed-off-by: ericharper <[email protected]>
1 parent 46ba15e commit d3017e4

File tree

1 file changed

+31
-15
lines changed

1 file changed

+31
-15
lines changed

README.rst

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -167,18 +167,16 @@ We recommend installing NeMo in a fresh Conda environment.
167167

168168
.. code-block:: bash
169169
170-
conda create --name nemo python==3.8
170+
conda create --name nemo python==3.8.10
171171
conda activate nemo
172172
173173
Install PyTorch using their `configurator <https://pytorch.org/get-started/locally/>`_.
174174

175175
.. code-block:: bash
176176
177-
conda install pytorch torchvision torchaudio cudatoolkit=11.3 -c pytorch
177+
conda install pytorch torchvision torchaudio pytorch-cuda=11.8 -c pytorch -c nvidia
178178
179-
.. note::
180-
181-
The command used to install PyTorch may depend on your system.
179+
The command used to install PyTorch may depend on your system. Please use the configurator linked above to find the right command for your system.
182180

183181
Pip
184182
~~~
@@ -190,9 +188,7 @@ Use this installation mode if you want the latest released version.
190188
pip install Cython
191189
pip install nemo_toolkit['all']
192190
193-
.. note::
194-
195-
Depending on the shell used, you may need to use ``"nemo_toolkit[all]"`` instead in the above command.
191+
Depending on the shell used, you may need to use ``"nemo_toolkit[all]"`` instead in the above command.
196192

197193
Pip from source
198194
~~~~~~~~~~~~~~~
@@ -216,10 +212,8 @@ Use this installation mode if you are contributing to NeMo.
216212
cd NeMo
217213
./reinstall.sh
218214
219-
.. note::
220-
221-
If you only want the toolkit without additional conda-based dependencies, you may replace ``reinstall.sh``
222-
with ``pip install -e .`` when your PWD is the root of the NeMo repository.
215+
If you only want the toolkit without additional conda-based dependencies, you may replace ``reinstall.sh``
216+
with ``pip install -e .`` when your PWD is the root of the NeMo repository.
223217

224218
RNNT
225219
~~~~
@@ -240,18 +234,40 @@ Install it manually if not using the NVIDIA PyTorch container.
240234
241235
git clone https://github.com/NVIDIA/apex.git
242236
cd apex
243-
git checkout a32d7a6dddcf4e39d241b0d139c222a97c91887d
237+
git checkout 03c9d80ed54c0eaa5b581bf42ceca3162f085327
244238
pip install -v --disable-pip-version-check --no-cache-dir --global-option="--cpp_ext" --global-option="--cuda_ext" --global-option="--fast_layer_norm" --global-option="--distributed_adam" --global-option="--deprecated_fused_adam" ./
245239
240+
It is highly recommended to use the NVIDIA PyTorch or NeMo container if having issues installing Apex or any other dependencies.
241+
242+
While installing Apex, it may raise an error if the CUDA version on your system does not match the CUDA version torch was compiled with.
243+
This raise can be avoided by commenting it here: https://github.com/NVIDIA/apex/blob/master/setup.py#L32
244+
245+
cuda-nvprof is needed to install Apex. The version should match the CUDA version that you are using:
246+
247+
.. code-block:: bash
248+
249+
conda install -c nvidia cuda-nvprof=11.8
250+
251+
packaging is also needed:
252+
253+
.. code-block:: bash
254+
255+
pip install -y packaging
256+
257+
246258
Transformer Engine
247259
~~~~~~~~~~~~~~~~~~
248260
NeMo Megatron GPT has been integrated with `NVIDIA Transformer Engine <https://github.com/NVIDIA/TransformerEngine>`_
249261
Transformer Engine enables FP8 training on NVIDIA Hopper GPUs.
250262
`Install <https://docs.nvidia.com/deeplearning/transformer-engine/user-guide/installation.html>`_ it manually if not using the NVIDIA PyTorch container.
251263

252-
.. note::
264+
.. code-block:: bash
265+
266+
pip install --upgrade git+https://github.com/NVIDIA/TransformerEngine.git@stable
267+
268+
It is highly recommended to use the NVIDIA PyTorch or NeMo container if having issues installing Transformer Engine or any other dependencies.
253269

254-
Transformer Engine requires PyTorch to be built with CUDA 11.8.
270+
Transformer Engine requires PyTorch to be built with CUDA 11.8.
255271

256272
NeMo Text Processing
257273
~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)