NeMo dev doc restructure #8896

yaoyu-33 · 2024-04-12T02:10:58Z

What does this PR do ?

Refactor NeMo Developer Docs 1st PR. In this PR, we restructured the dev doc as screen shot below. More contents yet to be added.

Changelog

Add specific line by line info of high level changes in this PR.

Usage

You can potentially add a usage example below

# Add a code snippet demonstrating how to use this

Jenkins CI

To run Jenkins, a NeMo User with write access must comment jenkins on the PR.

Before your PR is "Ready for review"

Pre checks:

Make sure you read and followed Contributor guidelines
Did you write any new necessary tests?
Did you add or update any necessary documentation?
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)

# Conflicts: # docs/source/collections/tts/data/ngc_models_codec.csv

docs/source/features/parallelisms.rst

docs/source/nlp/nemo_megatron/positional_embeddings.rst

docs/source/starthere/intro.rst

jgerh · 2024-04-25T00:13:18Z

docs/source/starthere/intro.rst

@@ -80,67 +163,19 @@ Once you have :ref:`installed NeMo <installation>`, then you can run the code be
    import soundfile as sf
    sf.write("output_audio.wav", audio.to('cpu').detach().numpy()[0], 22050)

-You can learn more by about specific tasks you are interested in by checking out the NeMo :doc:`tutorials <./tutorials>`, or documentation (e.g. read :doc:`here <../asr/intro>` to learn more about ASR).


Change this sentence: "You can learn . . ." to "To learn more about specific tasks that interest you, check out the NeMo :doc:tutorials <./tutorials> or documentation (for example, read :doc:here <../asr/intro> to learn more about ASR).

jgerh · 2024-04-25T00:16:07Z

docs/source/starthere/intro.rst

@@ -80,67 +163,19 @@ Once you have :ref:`installed NeMo <installation>`, then you can run the code be
    import soundfile as sf
    sf.write("output_audio.wav", audio.to('cpu').detach().numpy()[0], 22050)

-You can learn more by about specific tasks you are interested in by checking out the NeMo :doc:`tutorials <./tutorials>`, or documentation (e.g. read :doc:`here <../asr/intro>` to learn more about ASR).
-
-You can also learn more about NeMo in the `NeMo Primer <https://github.com/NVIDIA/NeMo/blob/stable/tutorials/00_NeMo_Primer.ipynb>`_ tutorial, which introduces NeMo, PyTorch Lightning, and OmegaConf, and shows how to use, modify, save, and restore NeMo models. Additionally, the `NeMo Models <https://github.com/NVIDIA/NeMo/blob/stable/tutorials/01_NeMo_Models.ipynb>`__ tutorial explains the fundamentals of how NeMo models are created. These concepts are also explained in detail in the :doc:`NeMo Core <../core/core>` documentation.


Change this sentence: "You can also learn more about" to "You can also learn more about NeMo in the NeMo Primer <https://github.com/NVIDIA/NeMo/blob/stable/tutorials/00_NeMo_Primer.ipynb>_ tutorial, which introduces NeMo, PyTorch Lightning, and OmegaConf. It also shows how to use, modify, save, and restore NeMo models.

jgerh · 2024-04-25T00:17:05Z

docs/source/starthere/intro.rst

-You can also learn more about NeMo in the `NeMo Primer <https://github.com/NVIDIA/NeMo/blob/stable/tutorials/00_NeMo_Primer.ipynb>`_ tutorial, which introduces NeMo, PyTorch Lightning, and OmegaConf, and shows how to use, modify, save, and restore NeMo models. Additionally, the `NeMo Models <https://github.com/NVIDIA/NeMo/blob/stable/tutorials/01_NeMo_Models.ipynb>`__ tutorial explains the fundamentals of how NeMo models are created. These concepts are also explained in detail in the :doc:`NeMo Core <../core/core>` documentation.
-
-
-Introductory videos


Change to Introductory Videos

jgerh · 2024-04-25T00:18:50Z

docs/source/starthere/intro.rst

-Introductory videos
-------------------
-
-See the two introductory videos below for a high level overview of NeMo.


Change the sentence: "See the two introductory videos below for a high level overview of NeMo." to "For a high level overview of NeMo, refer to the two introductory videos below." BTW, where are the links?

jgerh · 2024-04-25T00:20:49Z

docs/source/starthere/intro.rst

-Installation
------------
-
-The simplest way to install NeMo is via pip, see info below. 


Change this sentence: "The simplest way to install NeMo is via pip, see info below. " to "The easiest method for installing NeMo is via pip. Refer to the details below.

docs/source/starthere/intro.rst

jgerh · 2024-04-25T00:26:00Z

docs/source/starthere/intro.rst

-    conda create --name nemo python==3.10.12
-    conda activate nemo
-
-Install PyTorch using their `configurator <https://pytorch.org/get-started/locally/>`_.


Change this sentence: "Install PyTorch using their configurator <https://pytorch.org/get-started/locally/>_." to "To install PyTorch, follow the instructions provided by the PyTorch configurator."

jgerh

Copyedited content and rewrote some sentences for clarity.

ericharper

LGTM. Thanks!

* Update intro and why nemo in dev doc * Categorize tutorials * Update tutorials link * update index * Restructure * Restructure * Restructure * Restructure * Restructure * Restructure * Restructure * Restructure * Update flash attention * Update flash attention * Fix few structure issue * Fix migration * Fix structure * Fix structure * Few updates * Add few more scripts * Fix scripts * Fix few things * Fix tutorial table * Restructure * Rename * Few fixes and moves * Move sections * Fix bib * Refactor files * Fixes * Fix * Fix few issues * remove scripts * Update docs --------- Co-authored-by: Pablo Garay <palenq@gmail.com>

* Update intro and why nemo in dev doc * Categorize tutorials * Update tutorials link * update index * Restructure * Restructure * Restructure * Restructure * Restructure * Restructure * Restructure * Restructure * Update flash attention * Update flash attention * Fix few structure issue * Fix migration * Fix structure * Fix structure * Few updates * Add few more scripts * Fix scripts * Fix few things * Fix tutorial table * Restructure * Rename * Few fixes and moves * Move sections * Fix bib * Refactor files * Fixes * Fix * Fix few issues * remove scripts * Update docs --------- Co-authored-by: Pablo Garay <palenq@gmail.com> Signed-off-by: Ao Tang <aot@nvidia.com>

* Update intro and why nemo in dev doc * Categorize tutorials * Update tutorials link * update index * Restructure * Restructure * Restructure * Restructure * Restructure * Restructure * Restructure * Restructure * Update flash attention * Update flash attention * Fix few structure issue * Fix migration * Fix structure * Fix structure * Few updates * Add few more scripts * Fix scripts * Fix few things * Fix tutorial table * Restructure * Rename * Few fixes and moves * Move sections * Fix bib * Refactor files * Fixes * Fix * Fix few issues * remove scripts * Update docs --------- Co-authored-by: Pablo Garay <palenq@gmail.com>

yaoyu-33 added 13 commits April 11, 2024 09:51

Update intro and why nemo in dev doc

d18547c

Categorize tutorials

76dd297

Update tutorials link

69aef9e

update index

955546a

Restructure

b0d69c6

Restructure

153cfaf

Restructure

d786227

Restructure

85fcfd8

Restructure

7f3bfba

Restructure

3d87835

Restructure

544b514

Restructure

9b80dfa

Update flash attention

c2a3032

github-actions bot added the NLP label Apr 17, 2024

yaoyu-33 added 16 commits April 16, 2024 17:55

Update flash attention

b1b69c4

Fix few structure issue

425c007

Fix migration

a4da882

Fix structure

e8595ed

Fix structure

5a60afe

Few updates

31b4ff4

Add few more scripts

f1c9cd7

Fix scripts

ac713d0

Fix few things

2c41acb

Fix tutorial table

0d25d04

Restructure

029541c

Rename

8f0c10f

Few fixes and moves

2425aeb

Move sections

c4096ef

Merge branch 'main' into yuya/dev_doc_update

6291286

# Conflicts: # docs/source/collections/tts/data/ngc_models_codec.csv

Fix bib

98cdaa5

jgerh reviewed Apr 24, 2024

View reviewed changes

docs/source/features/parallelisms.rst Outdated Show resolved Hide resolved

jgerh reviewed Apr 24, 2024

View reviewed changes

docs/source/nlp/nemo_megatron/positional_embeddings.rst Outdated Show resolved Hide resolved

jgerh reviewed Apr 24, 2024

View reviewed changes

docs/source/nlp/nemo_megatron/positional_embeddings.rst Outdated Show resolved Hide resolved

jgerh reviewed Apr 24, 2024

View reviewed changes

docs/source/nlp/nemo_megatron/positional_embeddings.rst Outdated Show resolved Hide resolved

jgerh reviewed Apr 24, 2024

View reviewed changes

docs/source/starthere/intro.rst Show resolved Hide resolved

jgerh reviewed Apr 24, 2024

View reviewed changes