Skip to content

Commit e4ed7e7

Browse files
pzelaskoclaude
andcommitted
docs: address review — generalize PyTorch targets, A100 DeepEP note, drop torchvision mention
- PyTorch target wording: "CPU, CUDA, etc." (drop explicit ROCm / Apple Silicon). - compiled-a100: note the patched A100 DeepEP is auto-built/installed by the Dockerfile when the CUDA 12 base image is selected. - Remove the stray torchvision mention from the conda tip. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent dee9c27 commit e4ed7e7

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ For technical documentation, please see the
5252
NeMo Speech works with the **Python, PyTorch, and CUDA versions of your choosing**:
5353

5454
- Python 3.10 or above
55-
- PyTorch 2.6 or above (CPU, CUDA, ROCm, or Apple Silicon build — your choice)
55+
- PyTorch 2.6 or above (CPU, CUDA, etc. — your choice)
5656
- NVIDIA GPU + CUDA (required for training; recommended for inference)
5757

5858
If you already have a Python/PyTorch/CUDA stack, NeMo Speech installs on top of it **without replacing it** — the `nemo-toolkit` package only requires `torch>=2.6`, so your existing PyTorch build is kept (see the install options below). The versions pinned in `uv.lock` and shipped in the official container — Python 3.13, PyTorch 2.12, CUDA 12.6/13.2 — are simply the combination we actively test and support. They make setup turnkey and reproducible, but they are **not** a hard requirement.
@@ -103,7 +103,7 @@ For A100, set `GPU_TARGET=a100` — A100 works with **both CUDA 12 and CUDA 13**
103103

104104
### From PyPI with pip (fallback — bring your own versions)
105105

106-
Prefer your own Python/PyTorch/CUDA? `nemo-toolkit` only requires `torch>=2.6`, so install your PyTorch first (any version ≥ 2.6 for your CPU/CUDA/ROCm/Apple Silicon target — see the [PyTorch install matrix](https://pytorch.org/get-started/locally/)), then add NeMo and it **keeps your build**. `uv pip` (uv's fast, pip-compatible installer) works like `pip`:
106+
Prefer your own Python/PyTorch/CUDA? `nemo-toolkit` only requires `torch>=2.6`, so install your PyTorch first (any version ≥ 2.6 for your CPU/CUDA/etc. target — see the [PyTorch install matrix](https://pytorch.org/get-started/locally/)), then add NeMo and it **keeps your build**. `uv pip` (uv's fast, pip-compatible installer) works like `pip`:
107107

108108
```bash
109109
uv pip install 'nemo-toolkit[asr,tts]' # or plain: pip install 'nemo-toolkit[asr,tts]'

docs/source/starthere/install.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Prerequisites
1111
NeMo Speech works with the **Python, PyTorch, and CUDA versions of your choosing**:
1212

1313
#. **Python** 3.10 or above
14-
#. **PyTorch** 2.6 or above, for your chosen target (CPU, CUDA, ROCm, or Apple Silicon)
14+
#. **PyTorch** 2.6 or above, for your chosen target (CPU, CUDA, etc.)
1515
#. **NVIDIA GPU + CUDA** (required for training; CPU-only inference is possible but slow)
1616
#. **uv** for the fastest source/PyPI workflow (``pip`` also works in a prepared environment)
1717

@@ -104,7 +104,7 @@ The Automodel backend used for SpeechLM2 **does not require any compiled depende
104104
Choose the variant that matches your GPU (the two are mutually exclusive):
105105

106106
* ``compiled`` — Hopper/Blackwell and newer (SM90/SM100/SM120, e.g. H100/H200/B200). Includes DeepEP.
107-
* ``compiled-a100`` — Ampere A100 (SM80). Omits DeepEP, which requires a separately-built, patched version on A100.
107+
* ``compiled-a100`` — Ampere A100 (SM80). Omits DeepEP, which requires a separately-built, patched version on A100; our Dockerfile auto-builds and installs it when the CUDA 12 base image is selected.
108108

109109
.. warning::
110110

@@ -157,7 +157,7 @@ See the header of ``docker/Dockerfile`` for all build arguments (``BASE_IMAGE``,
157157
Install from PyPI with pip (fallback — bring your own versions)
158158
---------------------------------------------------------------
159159

160-
Prefer your own Python/PyTorch/CUDA? Install your preferred PyTorch first (any version ≥ 2.6 for your CPU/CUDA/ROCm/Apple Silicon target — see `PyTorch's install matrix <https://pytorch.org/get-started/locally/>`_), then add NeMo. Because ``nemo-toolkit`` only requires ``torch>=2.6``, your pre-installed PyTorch is kept, not replaced. ``uv pip`` (uv's fast, pip-compatible installer) works just like ``pip``:
160+
Prefer your own Python/PyTorch/CUDA? Install your preferred PyTorch first (any version ≥ 2.6 for your CPU/CUDA/etc. target — see `PyTorch's install matrix <https://pytorch.org/get-started/locally/>`_), then add NeMo. Because ``nemo-toolkit`` only requires ``torch>=2.6``, your pre-installed PyTorch is kept, not replaced. ``uv pip`` (uv's fast, pip-compatible installer) works just like ``pip``:
161161

162162
.. code-block:: bash
163163
@@ -183,7 +183,7 @@ To instead have the installer pull *our* pinned PyTorch build, add the matching
183183
184184
.. tip::
185185

186-
Prefer a conda environment? Create and activate one (``conda create -n nemo python=3.10 -y && conda activate nemo``), then run the same ``uv`` or ``pip`` commands above inside it. NeMo Speech does not require a separate conda CUDA toolkit or a manual ``torchvision`` install.
186+
Prefer a conda environment? Create and activate one (``conda create -n nemo python=3.10 -y && conda activate nemo``), then run the same ``uv`` or ``pip`` commands above inside it. NeMo Speech does not require a separate conda CUDA toolkit.
187187

188188
Verify Installation
189189
-------------------

0 commit comments

Comments
 (0)