Skip to content

Docs: add "Nemo Fundamentals" page#9889

Merged
ericharper merged 1 commit intomainfrom
cherry-pick-main-5c5c177b23e731cff2fba813394e0224a6f98809
Jul 25, 2024
Merged

Docs: add "Nemo Fundamentals" page#9889
ericharper merged 1 commit intomainfrom
cherry-pick-main-5c5c177b23e731cff2fba813394e0224a6f98809

Conversation

@github-actions
Copy link
Contributor

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)

* 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>
@github-actions github-actions bot requested a review from erastorgueva-nv July 25, 2024 16:01
@ericharper ericharper merged commit 28a2e52 into main Jul 25, 2024
@ericharper ericharper deleted the cherry-pick-main-5c5c177b23e731cff2fba813394e0224a6f98809 branch July 25, 2024 16:09
akoumpa pushed a commit that referenced this pull request Jul 25, 2024
* 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
* 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
* 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
* 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
* 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
* 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments