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.

Sign up for GitHub

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

Jump to bottom

docs: Apply other feedback from 24.09 VDR #411

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

docs: Apply other feedback from 24.09 VDR #411

wants to merge 30 commits into from
+234 −99

Conversation

terrykong
Copy link
Collaborator

What does this PR do ?

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.

Usage

  • You can potentially add a usage example below
# Add a code snippet demonstrating how to use this

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)

@terrykong
Model Alignment -> NeMo Aligner
cb7804f 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
change header for model alignment -> nemo-aligner
7a35949 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
test table
1547cc9 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
add in mistral
dd999d7 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
hardware requirement
1c66c92 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
header for all the notes
a403c1f 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
nemotron
9596591 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
make startup command more complete to avoid common error messages
13aaf99 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
make index show more than the title for quickly being able to jump
e22e67c 
around

Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
small wording
4f0f9e8 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
use different anchor to directly jump to getting started
dcc3bc5 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
Add a section explaining how to build the dockerfile when users need to
5f5dfbd 
customize the environment

Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
indent bug
a733ea3 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
add more stuff about the matrix table
d1c61fe 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
reorder table
22a24b7 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
add mm table + model-aligner -> nemo-aligner
0a22550 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
lint
f573960 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
add a dummy dataset
a974cc5 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
small ex
8b8804a 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
comment
218fcd5 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
missing newline
f83ad35 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
wording
a436f8f 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
checkmark
534e535 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
unicode checkmark instead
3facc8c 
Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong terrykong changed the title docs: Apply feedback from 24.09 VDR docs: Apply other feedback from 24.09 VDR Nov 19, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 19, 2024
ashors1
ashors1 reviewed Nov 21, 2024
View reviewed changes
docs/user-guide/index.rst Outdated Show resolved Hide resolved
ashors1
ashors1 previously approved these changes Nov 21, 2024
View reviewed changes
Copy link
Collaborator

@ashors1 ashors1 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

@zredeaux07
Copy link

Reviewed the updates and made a few minor grammatical edits.

@terrykong
Addresses
91a6979 
1c66c92#commitcomment-149379937

Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
Addresses
a6ffeeb 
0a22550#commitcomment-149380286

Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
address
fda3dad 
a974cc5#commitcomment-149380366

Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
address
7f6ef41 
534e535#commitcomment-149380509

Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong terrykong added the Run CICD Set + un-set to retrigger label Nov 22, 2024
@terrykong terrykong added Run CICD Set + un-set to retrigger and removed Run CICD Set + un-set to retrigger labels Nov 22, 2024
@terrykong terrykong enabled auto-merge (squash) November 22, 2024 22:58
ashors1
ashors1 previously approved these changes Nov 22, 2024
View reviewed changes
@terrykong
apply anna's feedback
03863de 
Signed-off-by: Terry Kong <terryk@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ashors1 ashors1 ashors1 left review comments

@jgerh jgerh Awaiting requested review from jgerh

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation Run CICD Set + un-set to retrigger
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@terrykong @zredeaux07 @ashors1