Skip to content

Docs: add "Nemo Fundamentals" page#9835

Merged
ericharper merged 15 commits intoNVIDIA-NeMo:r2.0.0rc1from
erastorgueva-nv:erastorgueva/docs_fundamentals
Jul 25, 2024
Merged

Docs: add "Nemo Fundamentals" page#9835
ericharper merged 15 commits intoNVIDIA-NeMo:r2.0.0rc1from
erastorgueva-nv:erastorgueva/docs_fundamentals

Conversation

@erastorgueva-nv
Copy link
Collaborator

@erastorgueva-nv erastorgueva-nv commented Jul 22, 2024

What does this PR do ?

Adding a "NeMo Fundamentals" page near the top of the developer docs.

Collection: Docs

Changelog

  • new file: docs/source/starthere/fundamentals.rst

Usage

N/A

GitHub Actions CI

The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.

The GitHub Actions CI will run automatically when the "Run CICD" label is added to the PR.
To re-run CI remove and add the label again.
To run CI on an untrusted fork, a NeMo user with write access must first click "Approve and run".

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • [N/A] Did you write any new necessary tests?
  • [N/A] Did you add or update any necessary documentation?
  • [N/A] Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
    • Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

  • New Feature
  • Bugfix
  • Documentation

If you haven't finished some of the above items you can still open "Draft" PR.

Who can review?

Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.

Additional Information

  • Related to # (issue)

@erastorgueva-nv
add nemo fundamentals page
b1abd22 
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
@erastorgueva-nv
remove unused reference tag
1b10a74 
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
yaoyu-33
yaoyu-33 reviewed Jul 23, 2024
View reviewed changes
yaoyu-33
yaoyu-33 reviewed Jul 23, 2024
View reviewed changes
yaoyu-33
yaoyu-33 reviewed Jul 23, 2024
View reviewed changes
yaoyu-33
yaoyu-33 reviewed Jul 23, 2024
View reviewed changes
yaoyu-33
yaoyu-33 reviewed Jul 23, 2024
View reviewed changes
erastorgueva-nv and others added 5 commits July 23, 2024 14:13
@erastorgueva-nv
Merge branch 'r2.0.0rc1' into erastorgueva/docs_fundamentals
7a1e114
@erastorgueva-nv
add link to checkpoints intro
6ee5fad 
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
@erastorgueva-nv
clarify postprocessing and mention loss function
85660ab 
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
@erastorgueva-nv
rephrase key parameters
5fe5e2d 
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
@erastorgueva-nv
fix typo
372139e 
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
yaoyu-33
yaoyu-33 previously approved these changes Jul 23, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
@erastorgueva-nv
mention trainer accelerator param
a663337 
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
@erastorgueva-nv
fix bulletpoint formatting
d2362d3 
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
jgerh
jgerh reviewed Jul 24, 2024
View reviewed changes
Copy link
Collaborator

@jgerh jgerh left a comment

Choose a reason for hiding this comment

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

I completed the Tech Pubs review of fundamentals.rst file and provided copyedits, suggestions for revising text for clarity, and formatting changes. Please review all copyedits, incorporate the changes in the source file, and then resolve all conversations (39). If you disagree with a copyedit, add a comment in the conversation and we can discuss. All comments must be resolved before I can approve the PR.

@erastorgueva-nv
fix bullet points part 2
dcfc9d4 
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
@erastorgueva-nv
quick formatting fixes
0bba8bb 
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
@erastorgueva-nv
fix phrasing
521ea3d 
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
@ericharper ericharper merged commit 5c5c177 into NVIDIA-NeMo:r2.0.0rc1 Jul 25, 2024
github-actions bot pushed a commit that referenced this pull request Jul 25, 2024
@erastorgueva-nv @web-flow
Docs: add "Nemo Fundamentals" page (#9835)
4af337c 
* add nemo fundamentals page

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>

* remove unused reference tag

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>

* add link to checkpoints intro

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>

* clarify postprocessing and mention loss function

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>

* rephrase key parameters

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>

* fix typo

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>

* mention trainer accelerator param

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>

* fix bulletpoint formatting

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>

* fix bullet points part 2

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>

* quick formatting fixes

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>

* fix phrasing

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>

* update based on review plus other small fixes

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>

---------

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
ericharper pushed a commit that referenced this pull request Jul 25, 2024
@github-actions @erastorgueva-nv
Docs: add "Nemo Fundamentals" page (#9835) (#9889)
28a2e52 
* add nemo fundamentals page



* remove unused reference tag



* add link to checkpoints intro



* clarify postprocessing and mention loss function



* rephrase key parameters



* fix typo



* mention trainer accelerator param



* fix bulletpoint formatting



* fix bullet points part 2



* quick formatting fixes



* fix phrasing



* update based on review plus other small fixes



---------

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
Co-authored-by: Elena Rastorgueva <80532067+erastorgueva-nv@users.noreply.github.com>
@erastorgueva-nv erastorgueva-nv deleted the erastorgueva/docs_fundamentals branch July 25, 2024 17:20
akoumpa pushed a commit that referenced this pull request Jul 25, 2024
@github-actions @erastorgueva-nv @akoumpa
Docs: add "Nemo Fundamentals" page (#9835) (#9889)
32ae6f2 
* add nemo fundamentals page

* remove unused reference tag

* add link to checkpoints intro

* clarify postprocessing and mention loss function

* rephrase key parameters

* fix typo

* mention trainer accelerator param

* fix bulletpoint formatting

* fix bullet points part 2

* quick formatting fixes

* fix phrasing

* update based on review plus other small fixes

---------

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
Co-authored-by: Elena Rastorgueva <80532067+erastorgueva-nv@users.noreply.github.com>
Signed-off-by: Alexandros Koumparoulis <akoumparouli@nvidia.com>
BoxiangW pushed a commit to BoxiangW/NeMo that referenced this pull request Jul 30, 2024
@github-actions @erastorgueva-nv @BoxiangW
Docs: add "Nemo Fundamentals" page (NVIDIA-NeMo#9835) (NVIDIA-NeMo#9889)
6834017 
* add nemo fundamentals page

* remove unused reference tag

* add link to checkpoints intro

* clarify postprocessing and mention loss function

* rephrase key parameters

* fix typo

* mention trainer accelerator param

* fix bulletpoint formatting

* fix bullet points part 2

* quick formatting fixes

* fix phrasing

* update based on review plus other small fixes

---------

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
Co-authored-by: Elena Rastorgueva <80532067+erastorgueva-nv@users.noreply.github.com>
Signed-off-by: Boxiang Wang <boxiangw@nvidia.com>
xuanzic pushed a commit to xuanzic/NeMo that referenced this pull request Aug 1, 2024
@github-actions @erastorgueva-nv
Docs: add "Nemo Fundamentals" page (NVIDIA-NeMo#9835) (NVIDIA-NeMo#9889)
34fe83f 
* add nemo fundamentals page

* remove unused reference tag

* add link to checkpoints intro

* clarify postprocessing and mention loss function

* rephrase key parameters

* fix typo

* mention trainer accelerator param

* fix bulletpoint formatting

* fix bullet points part 2

* quick formatting fixes

* fix phrasing

* update based on review plus other small fixes

---------

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
Co-authored-by: Elena Rastorgueva <80532067+erastorgueva-nv@users.noreply.github.com>
Signed-off-by: Vivian Chen <xuanzic@example.com>
monica-sekoyan pushed a commit that referenced this pull request Oct 14, 2024
@github-actions @erastorgueva-nv @monica-sekoyan
Docs: add "Nemo Fundamentals" page (#9835) (#9889)
40390b1 
* add nemo fundamentals page



* remove unused reference tag



* add link to checkpoints intro



* clarify postprocessing and mention loss function



* rephrase key parameters



* fix typo



* mention trainer accelerator param



* fix bulletpoint formatting



* fix bullet points part 2



* quick formatting fixes



* fix phrasing



* update based on review plus other small fixes



---------

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
Co-authored-by: Elena Rastorgueva <80532067+erastorgueva-nv@users.noreply.github.com>
hainan-xv pushed a commit to hainan-xv/NeMo that referenced this pull request Nov 5, 2024
@github-actions @erastorgueva-nv
Docs: add "Nemo Fundamentals" page (NVIDIA-NeMo#9835) (NVIDIA-NeMo#9889)
f6d717d 
* add nemo fundamentals page



* remove unused reference tag



* add link to checkpoints intro



* clarify postprocessing and mention loss function



* rephrase key parameters



* fix typo



* mention trainer accelerator param



* fix bulletpoint formatting



* fix bullet points part 2



* quick formatting fixes



* fix phrasing



* update based on review plus other small fixes



---------

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
Co-authored-by: Elena Rastorgueva <80532067+erastorgueva-nv@users.noreply.github.com>
Signed-off-by: Hainan Xu <hainanx@nvidia.com>
XuesongYang pushed a commit to paarthneekhara/NeMo that referenced this pull request Jan 18, 2025
@github-actions @erastorgueva-nv @XuesongYang
Docs: add "Nemo Fundamentals" page (NVIDIA-NeMo#9835) (NVIDIA-NeMo#9889)
2d33000 
* add nemo fundamentals page



* remove unused reference tag



* add link to checkpoints intro



* clarify postprocessing and mention loss function



* rephrase key parameters



* fix typo



* mention trainer accelerator param



* fix bulletpoint formatting



* fix bullet points part 2



* quick formatting fixes



* fix phrasing



* update based on review plus other small fixes



---------

Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
Co-authored-by: Elena Rastorgueva <80532067+erastorgueva-nv@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jgerh jgerh jgerh approved these changes

@yaoyu-33 yaoyu-33 yaoyu-33 left review comments

@titu1994 titu1994 Awaiting requested review from titu1994

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@erastorgueva-nv @yaoyu-33 @jgerh @ericharper

Comments