docs: update wheel install instructions by mckornfield · Pull Request #260 · NVIDIA-NeMo/Safe-Synthesizer

mckornfield · 2026-03-18T22:32:20Z

Update docs pages as appropriate for install instructions

Copilot

Pull request overview

Updates the user-guide documentation to provide complete wheel installation commands (including required package indexes) and to centralize install guidance by linking troubleshooting steps back to the Installation section.

Changes:

Expand Getting Started → Install the Package with pip/uv commands and required index URLs for CUDA 12.8 and CPU installs.
Add uv-specific guidance (--index-strategy unsafe-best-match) for multi-index resolution.
Update Troubleshooting (“No GPU Detected”) to link to the canonical Installation instructions instead of embedding a single command.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
docs/user-guide/troubleshooting.md	Replaces an inline CUDA install command with a link to the central Installation section.
docs/user-guide/getting-started.md	Adds detailed pip/uv install commands including index configuration for CUDA/CPU/bare installs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

binaryaaron · 2026-03-24T17:12:12Z

we should update this for devN wheel installs

Copilot

Pull request overview

Updates installation documentation to include the correct index URLs needed for CUDA/CPU extras (PyTorch + FlashInfer) and aligns dependency resolution metadata for FlashInfer in uv configuration/lock.

Changes:

Document pip/uv install commands for CUDA 12.8 and CPU variants, including required index URLs.
Add tool.uv.sources entries for flashinfer-python and flashinfer-cubin, and update uv.lock to resolve cu128 FlashInfer deps from the FlashInfer index.
Update troubleshooting guidance and the tutorial notebook install snippet to reference the new install approach.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
`uv.lock`	Adds sdist metadata for `griffelib` and pins FlashInfer cu128 deps to the FlashInfer index with conflicts metadata.
`pyproject.toml`	Configures `uv` sources for `flashinfer-python` / `flashinfer-cubin` to resolve from the FlashInfer cu128 index for the cu128 extra.
`docs/user-guide/troubleshooting.md`	Points users to the central install instructions (including index URLs) instead of embedding a partial command.
`docs/user-guide/getting-started.md`	Expands installation section with explicit `pip`/`uv` commands and rationale for uv index priority behavior.
`docs/tutorials/safe-synthesizer-101.ipynb`	Updates the Colab install cell to use public indexes (PyTorch + FlashInfer) instead of the internal Artifactory endpoint.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 4 out of 5 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-25T18:40:03Z

    }
+   },
+   "outputs": [],
+   "source": "%%capture\n!uv pip install nemo-safe-synthesizer[engine,cu128] --index https://flashinfer.ai/whl/cu128 --index https://download.pytorch.org/whl/cu128 --index-strategy unsafe-best-match\n!uv pip install datasets\n"


The shell command uses an unquoted extras specifier (nemo-safe-synthesizer[engine,cu128]). In many shells, [...] is treated as a glob character class, which can cause the requirement to be rewritten or fail depending on shell settings. Quote the requirement string to make the command robust.

Suggested change

"source": "%%capture\n!uv pip install nemo-safe-synthesizer[engine,cu128] --index https://flashinfer.ai/whl/cu128 --index https://download.pytorch.org/whl/cu128 --index-strategy unsafe-best-match\n!uv pip install datasets\n"

"source": "%%capture\n!uv pip install \"nemo-safe-synthesizer[engine,cu128]\" --index https://flashinfer.ai/whl/cu128 --index https://download.pytorch.org/whl/cu128 --index-strategy unsafe-best-match\n!uv pip install datasets\n"

Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>

Copilot

Pull request overview

Copilot reviewed 4 out of 5 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-25T22:57:24Z

        "# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n",
        "# SPDX-License-Identifier: Apache-2.0\n",
        "\n",
-        "#TODO: Replace the internal NVIDIA Artifactory endpoint with the public PyPI release when available.\n",
-        "!uv pip install nemo-safe-synthesizer[engine,cu128] --extra-index-url \"https://urm.nvidia.com/artifactory/api/pypi/nv-shared-pypi-local/simple\"\n",
+        "%%capture\n",
+        "!uv pip install \"nemo-safe-synthesizer[engine,cu128]\" --index https://flashinfer.ai/whl/cu128 --index https://download.pytorch.org/whl/cu128 --index-strategy unsafe-best-match\n",


In this notebook cell, %%capture is placed after comment lines. IPython requires cell magics (%%...) to be the very first line in the cell; otherwise the cell will error at runtime. Move %%capture to the top of the source list (before the SPDX comments), or drop the magic and use an alternative output-suppression approach.

The %%capture will cause an error if it's not on the first time, hence why we have %%capture and then the SPDX comments.

kendrickb-nvidia · 2026-03-30T17:31:02Z

        "# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n",
        "# SPDX-License-Identifier: Apache-2.0\n",
        "\n",
-        "#TODO: Replace the internal NVIDIA Artifactory endpoint with the public PyPI release when available.\n",
-        "!uv pip install nemo-safe-synthesizer[engine,cu128] --extra-index-url \"https://urm.nvidia.com/artifactory/api/pypi/nv-shared-pypi-local/simple\"\n",
+        "%%capture\n",
+        "!uv pip install \"nemo-safe-synthesizer[engine,cu128]\" --index https://flashinfer.ai/whl/cu128 --index https://download.pytorch.org/whl/cu128 --index-strategy unsafe-best-match\n",


The %%capture will cause an error if it's not on the first time, hence why we have %%capture and then the SPDX comments.

Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>

* Update docs/notebook pages as appropriate for install instructions --------- Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>

mckornfield requested a review from a team as a code owner March 18, 2026 22:32

Copilot AI review requested due to automatic review settings March 18, 2026 22:32

mckornfield commented Mar 18, 2026

View reviewed changes

Comment thread docs/user-guide/getting-started.md Outdated

Copilot AI reviewed Mar 18, 2026

View reviewed changes

Comment thread docs/user-guide/getting-started.md

Comment thread docs/user-guide/getting-started.md

Comment thread docs/user-guide/getting-started.md Outdated

kendrickb-nvidia reviewed Mar 23, 2026

View reviewed changes

Comment thread docs/user-guide/getting-started.md Outdated

Comment thread docs/user-guide/getting-started.md Outdated

Comment thread docs/user-guide/getting-started.md

Comment thread docs/user-guide/getting-started.md

Copilot AI review requested due to automatic review settings March 24, 2026 20:33

Copilot started reviewing on behalf of mckornfield March 24, 2026 20:34 View session

Copilot AI reviewed Mar 24, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings March 25, 2026 16:34

Copilot started reviewing on behalf of mckornfield March 25, 2026 16:34 View session

mckornfield commented Mar 25, 2026

View reviewed changes

Comment thread docs/user-guide/getting-started.md Outdated

Copilot AI reviewed Mar 25, 2026

View reviewed changes

Comment thread docs/tutorials/safe-synthesizer-101.ipynb Outdated

Comment thread docs/user-guide/getting-started.md

Comment thread docs/user-guide/getting-started.md

Comment thread docs/user-guide/getting-started.md

mckornfield force-pushed the update-install-steps/mck branch from b18e003 to 7acc2cb Compare March 25, 2026 16:40

kendrickb-nvidia previously approved these changes Mar 25, 2026

View reviewed changes

Comment thread docs/user-guide/getting-started.md

Copilot AI review requested due to automatic review settings March 25, 2026 18:36

mckornfield dismissed kendrickb-nvidia’s stale review via 23bf7a6 March 25, 2026 18:36

mckornfield force-pushed the update-install-steps/mck branch from 7acc2cb to 23bf7a6 Compare March 25, 2026 18:36

Copilot started reviewing on behalf of mckornfield March 25, 2026 18:36 View session

Copilot AI reviewed Mar 25, 2026

View reviewed changes

docs: update wheel install instructions

b760b61

Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>

mckornfield force-pushed the update-install-steps/mck branch from 23bf7a6 to b760b61 Compare March 25, 2026 20:28

Copilot AI review requested due to automatic review settings March 25, 2026 22:54

Copilot started reviewing on behalf of mckornfield March 25, 2026 22:54 View session

Copilot AI reviewed Mar 25, 2026

View reviewed changes

mckornfield requested a review from kendrickb-nvidia March 26, 2026 21:05

kendrickb-nvidia requested changes Mar 30, 2026

View reviewed changes

fix capture

46650ca

Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>

mckornfield force-pushed the update-install-steps/mck branch from 775b0d9 to 46650ca Compare March 30, 2026 17:50

mckornfield requested a review from kendrickb-nvidia March 30, 2026 17:56

kendrickb-nvidia approved these changes Mar 30, 2026

View reviewed changes

kendrickb-nvidia mentioned this pull request Mar 30, 2026

docs: add dp notebook #253

Merged

7 tasks

mckornfield merged commit 1f05c36 into main Mar 30, 2026
11 checks passed

mckornfield deleted the update-install-steps/mck branch March 30, 2026 18:32

memadi-nv pushed a commit that referenced this pull request Mar 30, 2026

docs: update wheel install instructions (#260)

5d5be96

* Update docs/notebook pages as appropriate for install instructions --------- Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>

	"source": "%%capture\n!uv pip install nemo-safe-synthesizer[engine,cu128] --index https://flashinfer.ai/whl/cu128 --index https://download.pytorch.org/whl/cu128 --index-strategy unsafe-best-match\n!uv pip install datasets\n"
	"source": "%%capture\n!uv pip install \"nemo-safe-synthesizer[engine,cu128]\" --index https://flashinfer.ai/whl/cu128 --index https://download.pytorch.org/whl/cu128 --index-strategy unsafe-best-match\n!uv pip install datasets\n"

Conversation

mckornfield commented Mar 18, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

binaryaaron commented Mar 24, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

kendrickb-nvidia Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

kendrickb-nvidia Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants