docs: update readme with contribution and acknowledgement section#1129
docs: update readme with contribution and acknowledgement section#1129snowmanwwg wants to merge 2 commits intomainfrom
Conversation
📝 WalkthroughWalkthroughThe README’s “Contributing” header was renamed to “Acknowledgement and Contribution Guide,” expanded with a list of community partners and historical/contextual notes about NeMo RL, then reintroduced the contributing invitation; an explicit Apache-2.0 license statement for NVIDIA NeMo RL was added. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
README.md (4)
507-507: Split the section and preserve the “Contributing” anchor to avoid broken links.Renaming the section breaks the existing Table of Contents entry and any deep links to
#contributing. Make “Acknowledgements” a separate section and keep a dedicated “Contributing” header.Apply:
-## Acknowledgement and Contribution Guide +## AcknowledgementsAnd below (see Line 513 change):
+## Contributing
509-509: Fix duplicated wording and a typo; prefer colon over dash.Current text has “adoption and adoption” and “SB Instituition”.
Apply:
-NeMo RL would like to acknowledge the adoption and adoption by the following community partners - Google, Argonne National Labs, Atlassian, Camfer, Domyn, Future House, Inflection AI, Lila, Paypal, Pegatron, PyTorch, Radical AI, Samsung, SB Instituition, Shanghai AI Lab, Speakleash, Sword Health, TII, NVIDIA Nemotron team, and many others. +NeMo RL acknowledges adoption and contributions from the following community partners: Google, Argonne National Labs, Atlassian, Camfer, Domyn, Future House, Inflection AI, Lila, Paypal, Pegatron, PyTorch, Radical AI, Samsung, SB Institution, Shanghai AI Lab, Speakleash, Sword Health, TII, NVIDIA Nemotron team, and many others.
513-513: Use a relative link and restore a proper “Contributing” header.Keeps links working across forks/branches and restores the expected anchor.
Apply:
-We welcome contributions to NeMo RL! Please see our [Contributing Guidelines](https://github.com/NVIDIA-NeMo/RL/blob/main/CONTRIBUTING.md) for more information on how to get involved. +## Contributing + +We welcome contributions to NeMo RL! Please see our [Contributing Guidelines](CONTRIBUTING.md) for more information on how to get involved.
507-507: Spelling consistency: “Acknowledgement(s)” vs “Acknowledgment(s)”.Pick one variant and align with repo’s English style (US vs UK) before regenerating the TOC.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: build-container / main
- GitHub Check: Lint check
🔇 Additional comments (2)
README.md (2)
511-511: Back up or soften historical claims.“one of the earliest … and has inspired …” needs citations or softer language (“has influenced, e.g. …”). Please add references or rephrase.
509-509: Verify partner names, capitalization, and permissions.Several entries may need brand‑correct spelling/capitalization (e.g., PayPal, Argonne National Laboratory, SpeakLeash?) and listing third‑party names may require approval.
Would you like me to scan the repo for an existing brand/style guide and open a checklist issue?
|
@snowmanwwg can you add these to #1091 |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (3)
507-507: Broken TOC anchor after heading rename; add a stable alias.The Table of Contents still links to “Contributing” (
#contributing), but the heading is now “Acknowledgement and Contribution Guide,” so the TOC link will 404 on GitHub. Add an explicit anchor to preserve backward compatibility and fix US spelling.Apply this diff:
-## Acknowledgement and Contribution Guide +<a id="contributing"></a> +## Acknowledgments and Contribution GuideIf you prefer UK spelling, keep “Acknowledgement” but still add the
<a id="contributing">alias. Also consider updating the TOC entry to the new title once internal links relying on#contributingare updated.
511-512: Soften/verifiably source the “re‑architected” and “inspired other libraries” claims.These are strong historical assertions; without citations they can be perceived as marketing claims.
Suggested wording with neutral tone:
-NeMo RL is the re-architected repo of [NeMo Aligner](https://github.com/NVIDIA/NeMo-Aligner), which was one of the earliest LLM Reinforcement Learning libraries, and has inspired other open source libraries such as [VeRL](https://github.com/volcengine/verl) and [ROLL](https://github.com/alibaba/ROLL). +NeMo RL evolved from [NeMo Aligner](https://github.com/NVIDIA/NeMo-Aligner). It shares design ideas with other open‑source RLHF libraries, including [VeRL](https://github.com/volcengine/verl) and [ROLL](https://github.com/alibaba/ROLL).If you prefer to keep “inspired,” please add supporting citations (blog posts, release notes, or acknowledgments in those repos).
517-517: License note is good; add third‑party notice and align name casing.The explicit Apache‑2.0 statement is helpful. Given bundled submodules and docs referencing Megatron/NeMo components, add a brief note that third‑party components retain their own licenses. Also, the doc alternates between “Nemo RL” and “NeMo RL”; standardize on one (project seems to prefer “NeMo RL”).
Apply this diff:
-NVIDIA NeMo RL is licensed under the [Apache License 2.0](https://github.com/NVIDIA-NeMo/RL/blob/main/LICENSE). +NeMo RL is licensed under the [Apache License 2.0](https://github.com/NVIDIA-NeMo/RL/blob/main/LICENSE). + +This repository may include third‑party components and submodules that are licensed separately. Please refer to the respective directories for their license files.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: build-container / main
- GitHub Check: Lint check
🔇 Additional comments (2)
README.md (2)
513-513: Contributing link: keep, but ensure anchor/back‑compat works.Link to CONTRIBUTING.md is good. With the heading rename, ensure in‑page anchors elsewhere that referenced
#contributingcontinue to resolve (see alias suggestion above).
509-509: Remove/unpublish unverified third‑party org list from README.md until legal/comms sign‑offFile: README.md (line 509)
- Listing named organizations as "adoption and contribution" creates brand/comms/legal risk; obtain written permission before naming.
- Confirm spellings/legal names and permissions for entries flagged: "Paypal" → "PayPal", "SB Instituition" → verify official name, and verify "Camfer", "Domyn", "Speakleash" (and any other unfamiliar entries).
Recommend one of:
- Remove the explicit list until approvals are collected, or
- Convert to "Selected collaborators (alphabetical)" with "listed with permission" notice and link for orgs to request inclusion.
Proposed safe placeholder:
-NeMo RL would like to acknowledge the adoption and contribution by the following community partners - Google, Argonne National Labs, Atlassian, Camfer, Domyn, Future House, Inflection AI, Lila, Paypal, Pegatron, PyTorch, Radical AI, Samsung, SB Instituition, Shanghai AI Lab, Speakleash, Sword Health, TII, NVIDIA Nemotron team, and many others. +We thank our open‑source contributors and external collaborators across industry and academia. A verified, opt‑in list of organizations will be published here after permissions are collected. If your org wishes to be listed, please open an issue or PR.
euronymous-aithal
temporarily deployed
to
nemo-ci
GitHub Actions
Inactive
euronymous-aithal
temporarily deployed
to
nemo-ci
GitHub Actions
Inactive
Signed-off-by: Wenwen Gao <94138584+snowmanwwg@users.noreply.github.com>
Signed-off-by: Wenwen Gao <94138584+snowmanwwg@users.noreply.github.com>
terrykong
force-pushed
the
snowmanwwg-patch-1
branch
from
3a312ac to
6adcd35
Compare
terrykong
changed the title
|
@snowmanwwg and @terrykong pulling these changes in #1268. we can close this |
pulling #1129 Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Pull request was closed
pulling #1129 Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
3 participants
Summary by CodeRabbit