Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: arxiv.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.9%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: rz-zhang
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 71.9 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog Contributing License Citation Security

README.md

NVIDIA NeMo-Aligner

Latest News

  • We released Nemotron-4-340B Base, Instruct, Reward. The Instruct and Reward variants are trained in Nemo-Aligner. Please see the Helpsteer2 paper for more details on the reward model training.
  • We are excited to announce the release of accelerated generation support in our RLHF pipeline using TensorRT-LLM. For more information, please refer to our RLHF documentation.
  • NeMo-Aligner Paper is now out on arxiv!

Introduction

NeMo-Aligner is a scalable toolkit for efficient model alignment. The toolkit has support for state-of-the- art model alignment algorithms such as SteerLM, DPO, and Reinforcement Learning from Human Feedback (RLHF). These algorithms enable users to align language models to be more safe, harmless, and helpful. Users can perform end-to-end model alignment on a wide range of model sizes and take advantage of all the parallelism techniques to ensure their model alignment is done in a performant and resource-efficient manner. For more technical details, please refer to our paper.

The NeMo-Aligner toolkit is built using the NeMo Framework, which enables scalable training across thousands of GPUs using tensor, data, and pipeline parallelism for all alignment components. Additionally, our checkpoints are cross-compatible with the NeMo ecosystem, facilitating inference deployment and further customization (https://github.com/NVIDIA/NeMo-Aligner).

The toolkit is currently in it's early stages. We are committed to improving the toolkit to make it easier for developers to pick and choose different alignment algorithms to build safe, helpful, and reliable models.

Key Features

Learn More

Latest Release

For the latest stable release, please see the releases page. All releases come with a pre-built container. Changes within each release will be documented in CHANGELOG.

Install Your Own Environment

Requirements

NeMo-Aligner has the same requirements as the NeMo Toolkit Requirements with the addition of PyTriton.

Install NeMo-Aligner

Please follow the same steps as outlined in the NeMo Toolkit Installation Guide. After installing NeMo, execute the following additional command: bash pip install nemo-aligner Alternatively, if you prefer to install the latest commit: bash pip install .

Docker Containers

We provide an official NeMo-Aligner Dockerfile which is based on stable, tested versions of NeMo, Megatron-LM, and TransformerEngine. The primary objective of this Dockerfile is to ensure stability, although it might not always reflect the very latest versions of those three packages. You can access our Dockerfile here.

Alternatively, you can build the NeMo Dockerfile here NeMo Dockerfile and add RUN pip install nemo-aligner at the end.

Future work

  • We will continue improving the stability of the PPO learning phase.
  • Improve the performance of RLHF.
  • Add TRT-LLM inference support for Rejection Sampling.

Contribute to NeMo-Aligner

We welcome community contributions! Please refer to CONTRIBUTING.md for guidelines.

Cite NeMo-Aligner in Your Work

@misc{shen2024nemoaligner, title={NeMo-Aligner: Scalable Toolkit for Efficient Model Alignment}, author={Gerald Shen and Zhilin Wang and Olivier Delalleau and Jiaqi Zeng and Yi Dong and Daniel Egert and Shengyang Sun and Jimmy Zhang and Sahil Jain and Ali Taghibakhshi and Markel Sanz Ausin and Ashwath Aithal and Oleksii Kuchaiev}, year={2024}, eprint={2405.01481}, archivePrefix={arXiv}, primaryClass={cs.CL} }

License

This toolkit is licensed under the Apache License, Version 2.0.

Owner

  • Name: Rongzhi Zhang
  • Login: rz-zhang
  • Kind: user
  • Location: Atlanta, GA, USA
  • Company: Georgia Institution of Technology

Citation (CITATION.cff)

cff-version: 1.0.0
message: "If you use this software, please cite it as below."
title: "NeMo-Aligner: a toolkit for model alignment"
repository-code: https://github.com/NVIDIA/NeMo-Aligner
authors:
  - family-names: Shen
    given-names: Gerald
  - family-names: Delalleau
    given-names: Olivier
  - family-names: Jian
    given-names: Sahil
  - family-names: Zhang
    given-names: Jimmy
  - family-names: Zeng
    given-names: Jiaqi
  - family-names: Egert
    given-names: Daniel
  - family-names: Wang
    given-names: Zhilin
  - family-names: Yan
    given-names: Zijie
  - family-names: Dong
    given-names: Yi
  - family-names: Markel 
    given-names: Ausin
  - family-names: Taghibakhshi
    given-names: Ali
  - family-names: Tao
    given-names: Li
  - family-names: Hu
    given-names: Jian
  - family-names: Yao
    given-names: Xin
  - family-names: Liu
    given-names: Hongbin
  - family-names: Aithal
    given-names: Ashwath
  - family-names: Kuchaiev
    given-names: Oleksii

GitHub Events

Total
  • Push event: 3
  • Create event: 2
Last Year
  • Push event: 3
  • Create event: 2

Dependencies

.github/workflows/_build_container.yml actions
  • actions/checkout v4 composite
  • docker/build-push-action v5 composite
  • docker/setup-buildx-action v3 composite
.github/workflows/_run_test.yml actions
  • NVIDIA/NeMo/.github/actions/cancel-workflow main composite
.github/workflows/cherry-pick-release-commit.yml actions
  • actions/checkout v3 composite
.github/workflows/cicd-main.yml actions
.github/workflows/labeler.yaml actions
  • actions/labeler v4 composite
.github/workflows/release-freeze.yml actions
  • actions/checkout v4 composite
  • peter-evans/create-pull-request v6 composite
.github/workflows/release.yaml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/upload-artifact v4 composite
.github/workflows/sync_branch.yaml actions
  • actions/checkout v2 composite
  • actions/setup-node v1 composite
  • tretuna/sync-branches 1.4.0 composite
Dockerfile docker
  • ${BASE_IMAGE} latest build
pyproject.toml pypi
setup/requirements.txt pypi
  • jsonlines *
  • megatron_core ==0.8
  • nemo_toolkit *
  • nvidia-pytriton *
setup.py pypi