docs: large tech edit #168
Closed
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: Jennifer Gerhold <163925524+jgerh@users.noreply.github.com>
terrykong
reviewed
Apr 11, 2025
terrykong
reviewed
Apr 11, 2025
terrykong
reviewed
Apr 11, 2025
terrykong
reviewed
Apr 11, 2025
terrykong
reviewed
Apr 11, 2025
terrykong
reviewed
Apr 11, 2025
terrykong
reviewed
Apr 11, 2025
terrykong
reviewed
Apr 11, 2025
terrykong
reviewed
Apr 11, 2025
terrykong
reviewed
Apr 11, 2025
README.md
Outdated
|
|
||
| NVIDIA NeMo-Reinforcer is licensed under the [Apache License 2.0](https://github.com/NVIDIA/NeMo?tab=Apache-2.0-1-ov-file#readme). | ||
|
|
||
| NeMo is licensed under the [NVIDIA AI PRODUCT AGREEMENT](https://www.nvidia.com/en-us/agreements/enterprise-software/product-specific-terms-for-ai-products/). By pulling and using the container, you accept the terms and conditions of this license. |
There was a problem hiding this comment.
do we need this right now? we actually don't publish a container yet. everything can be pip installed and we expect users to build their own container from the dockerfile we provide
There was a problem hiding this comment.
@snowmanwwg do we need this language since we don't have a container? Can we drop?
terrykong
reviewed
Apr 11, 2025
Signed-off-by: Jennifer Gerhold <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Jennifer Gerhold <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Jennifer Gerhold <163925524+jgerh@users.noreply.github.com>
SahilJain314
requested changes
Apr 14, 2025
There was a problem hiding this comment.
Request to call 'Hugging Face' 'HuggingFace' universally? 'Hugging Face' is definitely the 'correct company name', but the community almost universally knows it as 'HuggingFace'. Want to avoid making the docs sound like a marketing blogpost.
I've generally suggested changes for brevity.
README.md
Outdated
| ## Quick start | ||
| **Important Notes:** | ||
|
|
||
| - It is generally recommended **not to explicitly activate the virtual environment** when using `uv`. Instead, use `uv run <command>` to execute scripts within the managed environment. This helps maintain consistency across different shells and sessions. |
There was a problem hiding this comment.
Please provide correction
There was a problem hiding this comment.
Can you remove the 'activate the environment'? This line is correct.
|
|
||
| ## Slurm | ||
|
|
||
| The following code provides instructions on how to use Slurm to run batched job submissions and run jobs interactively. |
There was a problem hiding this comment.
Suggested change
| The following code provides instructions on how to use Slurm to run batched job submissions and run jobs interactively. |
docs/cluster.md
Outdated
| ::: | ||
|
|
||
| To run interactively, launch the same command as the [Batched Job Submission](#batched-job-submission) except omit the `COMMAND` line: | ||
| To run interactively, launch the same command as the [Batched Job Submission](#batched-job-submission), except omit the `COMMAND` line: |
There was a problem hiding this comment.
Suggested change
| To run interactively, launch the same command as the [Batched Job Submission](#batched-job-submission), except omit the `COMMAND` line: | |
| To run interactively, launch the same command as in [Batched Job Submission](#batched-job-submission), but omit the `COMMAND` line: |
Signed-off-by: Jennifer Gerhold <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Jennifer Gerhold <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Jennifer Gerhold <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Jennifer Gerhold <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Jennifer Gerhold <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Jennifer Gerhold <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Jennifer Gerhold <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Jennifer Gerhold <163925524+jgerh@users.noreply.github.com>
|
The state of the repo has moved very quickly and most if not all files are in conflict. I'll help @jgerh split out this PR |
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.
What does this PR do ?
Add a one line overview of what this PR aims to accomplish.
Issues
List issues that this PR closes (syntax):
Usage
# Add a code snippet demonstrating how to use thisBefore your PR is "Ready for review"
Pre checks:
Additional Information