Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding NeMo Megatron Launcher integration inline in SteerLM documentation #84

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

Zenodia
Copy link

@Zenodia Zenodia commented Jan 22, 2024

What does this PR do ?

Adding NeMo Megatron Launcher integration inline in SteerLM documentation.
Add a one line overview of what this PR aims to accomplish.

Changelog

  • Please update the CHANGELOG.md under next version with high level changes in this PR.
    @gshennvm please kindly advise if i should be updating changelog or if you would like to do this ?

Usage

# Add a code snippet demonstrating how to use this , example script running on oci 
python main.py launcher_scripts_path=<Path_to>/NeMo-Megatron-Launcher/launcher_scripts data_dir=<Path_to_the_folder_of_downloaded_HF_llama2_model_ckpts_and_files> base_results_dir=<Path_to_dir_of_job_logs> stages=[conversion_hf2nemo]

Before your PR is "Ready for review"

Pre checks:

Checklist when contributing a new algorithm

  • Does the trainer resume and restore model state all states?
  • Does the trainer support all parallelism techniques(PP, TP, DP)?
  • Does the trainer support max_steps=-1 and validation?
  • Does the trainer only call APIs defined in alignable_interface.py?
  • Does the trainer have proper logging?

Additional Information

  • Related to # (issue)

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 22, 2024
gshennvm and others added 11 commits January 23, 2024 10:13
Signed-off-by: Gerald Shen <geshen@nvidia.com>
Signed-off-by: Zenodia Charpy <zcharpy@nvidia.com>
Signed-off-by: Zenodia Charpy <zcharpy@nvidia.com>
Signed-off-by: Zenodia Charpy <zcharpy@nvidia.com>
Signed-off-by: Zenodia Charpy <zcharpy@nvidia.com>
Signed-off-by: Zenodia Charpy <zcharpy@nvidia.com>
Signed-off-by: Zenodia Charpy <zcharpy@nvidia.com>
Signed-off-by: Zenodia Charpy <zcharpy@nvidia.com>
Signed-off-by: Zenodia Charpy <zcharpy@nvidia.com>
Signed-off-by: Zenodia Charpy <zcharpy@nvidia.com>
Signed-off-by: Zenodia Charpy <zcharpy@nvidia.com>
Signed-off-by: Zenodia Charpy <zcharpy@nvidia.com>
@github-actions github-actions bot removed the CI label Jan 23, 2024
Zenodia and others added 3 commits January 26, 2024 12:31
For details of HelpSteer dataset, please refer to our paper `HelpSteer: Multi-attribute Helpfulness Dataset for SteerLM <https://arxiv.org/abs/2311.09528>`_.

For detail on leveraging scalable training and inference via integration with `NeMo-Megatron-Launcher <https://github.com/NVIDIA/NeMo-Megatron-Launcher>`_, please refer to the `user guide <https://docs.nvidia.com/nemo-framework/user-guide/latest/playbooks/pretraining.html#project-instructions-and-milestones>`_.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you give a brief description of what nemo megatron launcher here?

Copy link
Collaborator

@gshennvm gshennvm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mostly LGTM after resolving 1 more comment. Please make sure to also sign your commits before merge: https://github.com/NVIDIA/NeMo-Aligner/pull/84/checks?check_run_id=21083012106

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants