Update readme (#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]>
NVIDIA · Apr 4, 2023 · d3017e4 · d3017e4
1 parent 46ba15e
commit d3017e4
Showing 1 changed file with 31 additions and 15 deletions.
diff --git a/README.rst b/README.rst
@@ -167,18 +167,16 @@ We recommend installing NeMo in a fresh Conda environment.
 
 .. code-block:: bash
 
-    conda create --name nemo python==3.8
+    conda create --name nemo python==3.8.10
     conda activate nemo
 
 Install PyTorch using their `configurator <https://pytorch.org/get-started/locally/>`_. 
 
 .. code-block:: bash
 
-    conda install pytorch torchvision torchaudio cudatoolkit=11.3 -c pytorch
+    conda install pytorch torchvision torchaudio pytorch-cuda=11.8 -c pytorch -c nvidia
 
-.. note::
-
-  The command used to install PyTorch may depend on your system.
+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.
 
 Pip
 ~~~
@@ -190,9 +188,7 @@ Use this installation mode if you want the latest released version.
     pip install Cython
     pip install nemo_toolkit['all']
 
-.. note::
-
-    Depending on the shell used, you may need to use ``"nemo_toolkit[all]"`` instead in the above command.
+Depending on the shell used, you may need to use ``"nemo_toolkit[all]"`` instead in the above command.
 
 Pip from source
 ~~~~~~~~~~~~~~~
@@ -216,10 +212,8 @@ Use this installation mode if you are contributing to NeMo.
     cd NeMo
     ./reinstall.sh
 
-.. note::
-
-    If you only want the toolkit without additional conda-based dependencies, you may replace ``reinstall.sh``
-    with ``pip install -e .`` when your PWD is the root of the NeMo repository.
+If you only want the toolkit without additional conda-based dependencies, you may replace ``reinstall.sh``
+with ``pip install -e .`` when your PWD is the root of the NeMo repository.
 
 RNNT
 ~~~~
@@ -240,18 +234,40 @@ Install it manually if not using the NVIDIA PyTorch container.
 
     git clone https://github.com/NVIDIA/apex.git
     cd apex
-    git checkout a32d7a6dddcf4e39d241b0d139c222a97c91887d
+    git checkout 03c9d80ed54c0eaa5b581bf42ceca3162f085327
     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" ./
 
+It is highly recommended to use the NVIDIA PyTorch or NeMo container if having issues installing Apex or any other dependencies. 
+
+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.
+This raise can be avoided by commenting it here: https://github.com/NVIDIA/apex/blob/master/setup.py#L32
+
+cuda-nvprof is needed to install Apex. The version should match the CUDA version that you are using:
+
+.. code-block:: bash
+
+  conda install -c nvidia cuda-nvprof=11.8
+
+packaging is also needed:
+
+.. code-block:: bash
+  
+  pip install -y packaging
+
+
 Transformer Engine
 ~~~~~~~~~~~~~~~~~~
 NeMo Megatron GPT has been integrated with `NVIDIA Transformer Engine <https://github.com/NVIDIA/TransformerEngine>`_ 
 Transformer Engine enables FP8 training on NVIDIA Hopper GPUs.
 `Install <https://docs.nvidia.com/deeplearning/transformer-engine/user-guide/installation.html>`_ it manually if not using the NVIDIA PyTorch container.
 
-.. note::
+.. code-block:: bash
+
+  pip install --upgrade git+https://github.com/NVIDIA/TransformerEngine.git@stable
+
+It is highly recommended to use the NVIDIA PyTorch or NeMo container if having issues installing Transformer Engine or any other dependencies. 
 
-  Transformer Engine requires PyTorch to be built with CUDA 11.8.
+Transformer Engine requires PyTorch to be built with CUDA 11.8.
 
 NeMo Text Processing
 ~~~~~~~~~~~~~~~~~~~~