Skip to content

Commit e62b47f

Browse files
committed
docs: restore install version floors
1 parent e4ed7e7 commit e62b47f

3 files changed

Lines changed: 11 additions & 11 deletions

File tree

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ NeMo Speech — toolkit for training/deploying speech models (ASR, TTS, Speech L
1010

1111
See the canonical installation guide — [`docs/source/starthere/install.rst`](docs/source/starthere/install.rst) (published at https://docs.nvidia.com/nemo/speech/nightly/) — for the uv, pip (bring-your-own Python/PyTorch/CUDA), Docker, and optional `compiled` (SpeechLM2/Automodel) install paths.
1212

13-
Dev quickstart: `uv sync --extra all --extra cu13` (Python 3.10+, PyTorch 2.6+; `test`/`docs` are `--group`s, not extras).
13+
Dev quickstart: `uv sync --extra all --extra cu13` (Python 3.12+, PyTorch 2.7+; `test`/`docs` are `--group`s, not extras).
1414

1515
## Code Style
1616

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ For technical documentation, please see the
5151

5252
NeMo Speech works with the **Python, PyTorch, and CUDA versions of your choosing**:
5353

54-
- Python 3.10 or above
55-
- PyTorch 2.6 or above (CPU, CUDA, etc. — your choice)
54+
- Python 3.12 or above
55+
- PyTorch 2.7 or above (CPU, CUDA, etc. — your choice)
5656
- NVIDIA GPU + CUDA (required for training; recommended for inference)
5757

58-
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.
58+
If you already have a Python/PyTorch/CUDA stack that satisfies those minimums, NeMo Speech installs on top of it **without replacing it**, 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.
5959

6060
As of [Pytorch 2.6](https://docs.pytorch.org/docs/stable/notes/serialization.html#torch-load-with-weights-only-true),
6161
`torch.load` defaults to using `weights_only=True`. Some model checkpoints may require using `weights_only=False`.
@@ -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/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`:
106+
Prefer your own Python/PyTorch/CUDA? Install your PyTorch first (any version ≥ 2.7 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: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ Prerequisites
1010

1111
NeMo Speech works with the **Python, PyTorch, and CUDA versions of your choosing**:
1212

13-
#. **Python** 3.10 or above
14-
#. **PyTorch** 2.6 or above, for your chosen target (CPU, CUDA, etc.)
13+
#. **Python** 3.12 or above
14+
#. **PyTorch** 2.7 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

1818
.. admonition:: Bring your own Python / PyTorch / CUDA
1919
:class: important
2020

21-
The recommended install path is uv (below), which gives you our actively-tested stack. But NeMo Speech can also install *on top of* an existing environment: the ``nemo-toolkit`` package only requires ``torch>=2.6``, so if you already have a Python, PyTorch, and CUDA stack, your pre-installed PyTorch is **kept, not replaced** (see :ref:`the pip fallback <install-from-pypi>`).
21+
The recommended install path is uv (below), which gives you our actively-tested stack. But NeMo Speech can also install *on top of* an existing environment: if you already have a Python, PyTorch, and CUDA stack that satisfies the minimums above, your pre-installed PyTorch is **kept, not replaced** (see :ref:`the pip fallback <install-from-pypi>`).
2222

2323
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.
2424

@@ -157,11 +157,11 @@ 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/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``:
160+
Prefer your own Python/PyTorch/CUDA? Install your preferred PyTorch first (any version ≥ 2.7 for your CPU/CUDA/etc. target — see `PyTorch's install matrix <https://pytorch.org/get-started/locally/>`_), then add NeMo. 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
164-
uv venv --python 3.12 # any Python >= 3.10 your PyTorch supports — or use your own env
164+
uv venv --python 3.12 # any Python >= 3.12 your PyTorch supports — or use your own env
165165
source .venv/bin/activate
166166
167167
# 1) Your choice of PyTorch (example: CUDA 12.6 build). Skip if you already have one.
@@ -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.
186+
Prefer a conda environment? Create and activate one (``conda create -n nemo python=3.12 -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)