docs: Update installation guides #12596
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: oliver könig <[email protected]>
Signed-off-by: oliver könig <[email protected]>
…llable Signed-off-by: oliver könig <[email protected]>
Signed-off-by: oliver könig <[email protected]>
Signed-off-by: oliver könig <[email protected]>
Signed-off-by: oliver könig <[email protected]>
Signed-off-by: oliver könig <[email protected]>
Signed-off-by: oliver könig <[email protected]>
Signed-off-by: oliver könig <[email protected]>
Signed-off-by: oliver könig <[email protected]>
Signed-off-by: oliver könig <[email protected]>
ericharper
reviewed
Mar 13, 2025
README.md
Outdated
| - Conda / Pip - Refer to [Conda](#conda) and [Pip](#pip) for | ||
| installation instructions. | ||
| - [Conda / Pip](#conda--pip): Install NeMo-Framework with native Pip into a virtual environment. | ||
| - Perfect to explore NeMo on any supported platform. |
There was a problem hiding this comment.
Perfect sounds optimistic, maybe "Used"
ericharper
reviewed
Mar 13, 2025
README.md
Outdated
| instructions. | ||
| - Limited feature-completeness for other domains. | ||
| - [NGC PyTorch container](#ngc-pytorch-container): Install NeMo-Framework from source with feature-completeness into a highly optimized container. | ||
| - Perfect for customers that seek flexibility. |
There was a problem hiding this comment.
Again let's use another word besides "perfect". Also flexibility is a bit generic. Maybe just say what it is. For users that want to install from source in a highly optimized container.
ericharper
reviewed
Mar 13, 2025
README.md
Outdated
| - Perfect for customers that seek flexibility. | ||
| - Provides most flexibility for container of your choice. | ||
| - [NGC NeMo container](#ngc-nemo-container): Ready-to-go solution of NeMo-Framework | ||
| - Perfect for customers that seek highest performance. |
There was a problem hiding this comment.
Let's not use perfect. And replace customers -> users
ericharper
reviewed
Mar 13, 2025
README.md
Outdated
| - Provides most flexibility for container of your choice. | ||
| - [NGC NeMo container](#ngc-nemo-container): Ready-to-go solution of NeMo-Framework | ||
| - Perfect for customers that seek highest performance. | ||
| - Insides all dependencies and NeMo libraries such as NeMo-Aligner, NeMo-Curator, and more. |
There was a problem hiding this comment.
Let's mention that the container contains all dependencies installed and tested for performance and convergence
ericharper
reviewed
Mar 13, 2025
README.md
Outdated
| NeMo-Framework provides tiers of support based on OS / Platform and mode of installation. Please refer the following overview of support levels: | ||
|
|
||
| - Fully supported: Max performance and feature-completeness. | ||
| - Limited supported: Perfect to explore NeMo. |
There was a problem hiding this comment.
Perfect, let's change it
ericharper
reviewed
Mar 13, 2025
README.md
Outdated
|
|
||
| Please refer to the following table for current support levels: | ||
|
|
||
| | OS / Platform | Pip-install | Source into NGC container | |
There was a problem hiding this comment.
Pip-install is a bit ambiguous. Let's use Install from PyPi or something like that.
ericharper
reviewed
Mar 13, 2025
README.md
Outdated
|
|
||
| ```bash | ||
| conda install pytorch torchvision torchaudio pytorch-cuda=11.8 -c pytorch -c nvidia | ||
| pip install "nemo_toolkit" |
There was a problem hiding this comment.
Does this work? Don't we need "nemo_toolkit[all]" or a specific domain? Also can we switch to "nemo_framework" ?
There was a problem hiding this comment.
Good point, nemo_toolkit works but it's probably too lightweight.
ericharper
reviewed
Mar 13, 2025
|
|
||
| To install the nemo_toolkit, use the following installation method: | ||
| If a more specific version is desired, we recommend a Pip-VCS install. From [NVIDIA/NeMo](github.com/NVIDIA/NeMo), fetch the commit, branch, or tag that you would like to install. | ||
| To install nemo_toolkit from this Git reference `$REF`, use the following installation method: |
ericharper
reviewed
Mar 13, 2025
Comment on lines
+376
to
+381
| pip install nemo_toolkit['all'] # or pip install "git+https://github.com/NVIDIA/NeMo@${REF:-'main'}#egg=nemo_toolkit[all]" | ||
| pip install nemo_toolkit['asr'] # or pip install "git+https://github.com/NVIDIA/NeMo@$REF#egg=nemo_toolkit[asr]" | ||
| pip install nemo_toolkit['nlp'] # or pip install "git+https://github.com/NVIDIA/NeMo@${REF:-'main'}#egg=nemo_toolkit[nlp]" | ||
| pip install nemo_toolkit['tts'] # or pip install "git+https://github.com/NVIDIA/NeMo@${REF:-'main'}#egg=nemo_toolkit[tts]" | ||
| pip install nemo_toolkit['vision'] # or pip install "git+https://github.com/NVIDIA/NeMo@${REF:-'main'}#egg=nemo_toolkit[vision]" | ||
| pip install nemo_toolkit['multimodal'] # or pip install "git+https://github.com/NVIDIA/NeMo@${REF:-'main'}#egg=nemo_toolkit[multimodal]" |
ericharper
reviewed
Mar 13, 2025
README.md
Outdated
| --shm-size=16g \ | ||
| --ulimit memlock=-1 \ | ||
| --ulimit stack=67108864 \ | ||
| nvcr.io/nvidia/pytorch:${NV_PYTORCH_TAG:-'nvcr.io/nvidia/nemo:24.12'} |
Signed-off-by: oliver könig <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Important
The
Update branchbutton must only be pressed in very rare occassions.An outdated branch is never blocking the merge of a PR.
Please reach out to the automation team before pressing that button.
What does this PR do ?
Add a one line overview of what this PR aims to accomplish.
Collection: [Note which collection this PR will affect]
Changelog
Usage
# Add a code snippet demonstrating how to use thisGitHub Actions CI
The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.
The GitHub Actions CI will run automatically when the "Run CICD" label is added to the PR.
To re-run CI remove and add the label again.
To run CI on an untrusted fork, a NeMo user with write access must first click "Approve and run".
Before your PR is "Ready for review"
Pre checks:
PR Type:
If you haven't finished some of the above items you can still open "Draft" PR.
Who can review?
Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.
Additional Information