Safely import optional python packages #13936

roclark · 2025-06-16T18:11:38Z

What does this PR do ?

This update safely imports optional Python packages which are incompatible with Windows and MacOS. This allows nemo_toolkit to be installable and usable on Windows and MacOS, especially in conjunction with NeMo-Run.

Before your PR is "Ready for review"

Pre checks:

Make sure you read and followed Contributor guidelines
Did you write any new necessary tests?
Did you add or update any necessary documentation?
Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
- Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

New Feature
Bugfix
Documentation

dimapihtar

LGTM. Thank you!

github-actions · 2025-07-09T02:12:00Z

This PR is stale because it has been open for 14 days with no activity. Remove stale label or comment or update or this will be closed in 7 days.

ahmadki · 2025-07-09T15:42:11Z

@dimapihtar , @marcromeyn : what is the next step for this PR ?

ri-roee · 2025-07-10T01:14:21Z

This would be huge for us as well, +1!

The nvidia-resiliency-ext package is not compatible with Windows/MacOS currently and cannot be installed directly on those platforms. Given the number of nested imports in the nemo.collections.llm API, it will try and automatically import the resliency package even if not used. Safely importing the package allows all modules to be imported without blocking on the resiliency package for incompatible platforms. This opens up greater support on more platforms. If the nvidia-resiliency-ext package is needed when these lines are called, it will throw an import error only when directly called. Signed-Off-By: Robert Clark <roclark@nvidia.com>

The default modelopt model transforms rely on the modelopt package being installed which is not available on all platforms. This module gets auto-imported when importing the nemo.collections.llm module and will fail on platforms that don't support modelopt, such as Windows and MacOS, even if the package isn't used. Safely importing the package should allow the toolkit to be runnable on both Windows and MacOS in a minimal state, which increases its functionality, especially while paired with NeMo-Run. Signed-Off-By: Robert Clark <roclark@nvidia.com>

Signed-off-by: roclark <roclark@users.noreply.github.com>

This reverts commit e04ee42. Signed-off-by: Charlie Truong <chtruong@nvidia.com>

This reverts commit e04ee42. Signed-off-by: Charlie Truong <chtruong@nvidia.com> Co-authored-by: Robert Clark <roclark@users.noreply.github.com>

)" This reverts commit 808845b. Signed-off-by: Charlie Truong <chtruong@nvidia.com>

* Revert "Revert "Safely import optional python packages (#13936)" (#14197)" This reverts commit 808845b. Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Fix LocalCheckpointCallback safe import Signed-off-by: Charlie Truong <chtruong@nvidia.com> --------- Signed-off-by: Charlie Truong <chtruong@nvidia.com>

* Safely import nvidia-resiliency-ext package The nvidia-resiliency-ext package is not compatible with Windows/MacOS currently and cannot be installed directly on those platforms. Given the number of nested imports in the nemo.collections.llm API, it will try and automatically import the resliency package even if not used. Safely importing the package allows all modules to be imported without blocking on the resiliency package for incompatible platforms. This opens up greater support on more platforms. If the nvidia-resiliency-ext package is needed when these lines are called, it will throw an import error only when directly called. Signed-Off-By: Robert Clark <roclark@nvidia.com> * Safely import modelopt algorithms The default modelopt model transforms rely on the modelopt package being installed which is not available on all platforms. This module gets auto-imported when importing the nemo.collections.llm module and will fail on platforms that don't support modelopt, such as Windows and MacOS, even if the package isn't used. Safely importing the package should allow the toolkit to be runnable on both Windows and MacOS in a minimal state, which increases its functionality, especially while paired with NeMo-Run. Signed-Off-By: Robert Clark <roclark@nvidia.com> * Apply isort and black reformatting Signed-off-by: roclark <roclark@users.noreply.github.com> --------- Signed-off-by: Robert Clark <roclark@nvidia.com> Signed-off-by: roclark <roclark@users.noreply.github.com> Signed-off-by: Amir Hussein <amhussein@nvidia.com>

…VIDIA-NeMo#14197) This reverts commit e04ee42. Signed-off-by: Charlie Truong <chtruong@nvidia.com> Co-authored-by: Robert Clark <roclark@users.noreply.github.com> Signed-off-by: Amir Hussein <amhussein@nvidia.com>

…DIA-NeMo#14198) * Revert "Revert "Safely import optional python packages (NVIDIA-NeMo#13936)" (NVIDIA-NeMo#14197)" This reverts commit 808845b. Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Fix LocalCheckpointCallback safe import Signed-off-by: Charlie Truong <chtruong@nvidia.com> --------- Signed-off-by: Charlie Truong <chtruong@nvidia.com> Signed-off-by: Amir Hussein <amhussein@nvidia.com>

* Safely import nvidia-resiliency-ext package The nvidia-resiliency-ext package is not compatible with Windows/MacOS currently and cannot be installed directly on those platforms. Given the number of nested imports in the nemo.collections.llm API, it will try and automatically import the resliency package even if not used. Safely importing the package allows all modules to be imported without blocking on the resiliency package for incompatible platforms. This opens up greater support on more platforms. If the nvidia-resiliency-ext package is needed when these lines are called, it will throw an import error only when directly called. Signed-Off-By: Robert Clark <roclark@nvidia.com> * Safely import modelopt algorithms The default modelopt model transforms rely on the modelopt package being installed which is not available on all platforms. This module gets auto-imported when importing the nemo.collections.llm module and will fail on platforms that don't support modelopt, such as Windows and MacOS, even if the package isn't used. Safely importing the package should allow the toolkit to be runnable on both Windows and MacOS in a minimal state, which increases its functionality, especially while paired with NeMo-Run. Signed-Off-By: Robert Clark <roclark@nvidia.com> * Apply isort and black reformatting Signed-off-by: roclark <roclark@users.noreply.github.com> --------- Signed-off-by: Robert Clark <roclark@nvidia.com> Signed-off-by: roclark <roclark@users.noreply.github.com>