Skip to content

Commit 3c416fc

Browse files
docs: added pre-requisite for GPU and CUDA (#340)
<!-- SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. --> <!-- SPDX-License-Identifier: Apache-2.0 --> <!-- Thank you for contributing to Safe Synthesizer! --> # Summary Added language to enhance pre-requisite for GPU and CUDA and warning for macOS users. ## Pre-Review Checklist <!-- These checks should be completed before a PR is reviewed, --> <!-- but you can submit a draft early to indicate that the issue is being worked on. --> Ensure that the following pass: - [ ] `make format && make check` or via prek validation. - [ ] `make test` passes locally - [ ] `make test-e2e` passes locally - [ ] `make test-ci-container` passes locally (recommended) - [ ] GPU CI status check passes -- comment `/sync` on this PR to trigger a run (auto-triggers on ready-for-review) ## Pre-Merge Checklist <!-- These checks need to be completed before a PR is merged, --> <!-- but as PRs often change significantly during review, --> <!-- it's OK for them to be incomplete when review is first requested. --> - [ ] New or updated tests for any fix or new behavior - [ ] Updated documentation for new features and behaviors, including docstrings for API docs. ## Other Notes <!-- Please add the issue number that should be closed when this PR is merged. --> - Closes #<issue> --------- Signed-off-by: Sean Yang <seayang@nvidia.com> Signed-off-by: seayang-nv <seayang@nvidia.com> Co-authored-by: Kendrick Boyd <kendrickb@nvidia.com>
1 parent 68c71d4 commit 3c416fc

5 files changed

Lines changed: 14 additions & 4 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ Read detailed usage below, or jump to the documentation with [Getting Started](h
88

99
### Prerequisites
1010

11-
- Python 3.11–3.13 (we pin a specific 3.11.x in `.python-version` for local/dev bootstrap; any 3.11, 3.12, or 3.13 interpreter works. Python 3.14+ is **not** supported because ray, a transitive dependency of vLLM, does not yet publish `cp314` wheels)
11+
- Python 3.11–3.13 (we pin a specific 3.11.x in `.python-version` for local/dev bootstrap; any 3.11, 3.12, or 3.13 interpreter works. Python 3.14+ is NOT supported because ray, a transitive dependency of vLLM, does not yet publish `cp314` wheels)
1212
- [uv](https://docs.astral.sh/uv/) - Python package manager (>=0.9.14, <0.11.0)
1313
- NVIDIA GPU (A100 or larger) for training and generation
14+
- Linux only -- macOS, Windows, and Apple Silicon are not supported for training or generation. A CPU-only install is available for development and configuration validation.
1415

1516
### Installation
1617

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ NeMo Safe Synthesizer creates private, safe versions of sensitive tabular datase
1717
- Comprehensive evaluation -- Privacy and quality metrics in an in-depth HTML report
1818
- Flexible interfaces -- CLI for scripting, Python SDK for programmatic workflows, YAML configuration
1919

20+
!!! info "System Requirements"
21+
NeMo Safe Synthesizer requires a Linux machine with an NVIDIA GPU (A100 80GB+ recommended) and CUDA 12.8+ to run the training and generation pipeline. macOS, Windows, and Apple Silicon are not supported for pipeline execution. A CPU-only install is available for development and configuration validation -- see [Getting Started](user-guide/getting-started.md#install-the-package).
22+
2023
## Next Steps
2124

2225
<div class="grid cards" markdown>

docs/tutorials/differential-privacy.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"\n",
1515
"### 🖥️ Prerequisites\n",
1616
"\n",
17-
"This notebook requires a GPU. We recommend an H100; minimum A100."
17+
"This notebook requires a Linux machine with an NVIDIA GPU (H100 recommended, A100 minimum) and CUDA 12.8+. It will not run on macOS, Windows, or Apple Silicon."
1818
]
1919
},
2020
{

docs/tutorials/safe-synthesizer-101.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"\n",
1717
"### 🖥️ Prerequisites\n",
1818
"\n",
19-
"This notebook requires a GPU. We recommend an H100; minimum A100."
19+
"This notebook requires a Linux machine with an NVIDIA GPU (H100 recommended, A100 minimum) and CUDA 12.8+. It will not run on macOS, Windows, or Apple Silicon."
2020
]
2121
},
2222
{

docs/user-guide/getting-started.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,15 @@ does at each stage.
1515
### Prerequisites
1616

1717
- Python 3.11–3.13 (dev tooling currently pins 3.11 via `.python-version` in the repo root; Python 3.14+ is **not** supported — see [Troubleshooting](troubleshooting.md#python-314-is-not-supported))
18-
- CUDA runtime 12.8
18+
- CUDA runtime 12.8+
1919
- NVIDIA GPU (A100 or larger) for training and generation
2020

21+
!!! failure "Linux only -- macOS, Windows, and Apple Silicon are not supported"
22+
NeMo Safe Synthesizer requires a Linux machine with an NVIDIA GPU and CUDA 12.8+
23+
to run the training and generation pipeline. The [CPU install tab below](#install-the-package)
24+
is for development and configuration validation only -- it cannot train models or
25+
generate synthetic data.
26+
2127
### Install the Package
2228

2329
The CUDA and CPU extras depend on packages (PyTorch, FlashInfer) hosted on

0 commit comments

Comments
 (0)