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

NeMo dev doc restructure #8896

Merged
merged 38 commits into from
Apr 25, 2024
Merged

NeMo dev doc restructure #8896

merged 38 commits into from
Apr 25, 2024

Conversation

yaoyu-33
Copy link
Collaborator

@yaoyu-33 yaoyu-33 commented Apr 12, 2024 •
edited
Loading

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.

image

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)

@github-actions github-actions bot added the NLP label Apr 17, 2024
jgerh
jgerh reviewed Apr 25, 2024
View reviewed changes
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).
Copy link
Collaborator

Choose a reason for hiding this comment

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

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
jgerh reviewed Apr 25, 2024
View reviewed changes
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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

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
jgerh reviewed Apr 25, 2024
View reviewed changes
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
Copy link
Collaborator

Choose a reason for hiding this comment

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

Change to Introductory Videos

jgerh
jgerh reviewed Apr 25, 2024
View reviewed changes
docs/source/starthere/intro.rst
Introductory videos
-------------------

See the two introductory videos below for a high level overview of NeMo.
Copy link
Collaborator

@jgerh jgerh Apr 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

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
jgerh reviewed Apr 25, 2024
View reviewed changes
docs/source/starthere/intro.rst
Installation
------------

The simplest way to install NeMo is via pip, see info below.
Copy link
Collaborator

Choose a reason for hiding this comment

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

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.

jgerh
jgerh reviewed Apr 25, 2024
View reviewed changes
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/>`_.
Copy link
Collaborator

Choose a reason for hiding this comment

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

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
jgerh reviewed Apr 25, 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.

Copyedited content and rewrote some sentences for clarity.

ericharper
ericharper approved these changes Apr 25, 2024
View reviewed changes
Copy link
Collaborator

@ericharper ericharper left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@ericharper ericharper merged commit 83ef77c into main Apr 25, 2024
99 of 127 checks passed
@ericharper ericharper deleted the yuya/dev_doc_update branch April 25, 2024 19:25
BoxiangW pushed a commit to BoxiangW/NeMo that referenced this pull request Apr 25, 2024
@yaoyu-33 @pablo-garay @BoxiangW
NeMo dev doc restructure (NVIDIA#8896)
92af85c 
* 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 <[email protected]>
alxzhang-amazon pushed a commit to alxzhang-amazon/NeMo that referenced this pull request Apr 26, 2024
@yaoyu-33 @pablo-garay @alxzhang-amazon
NeMo dev doc restructure (NVIDIA#8896)
4d28f15 
* 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 <[email protected]>
suiyoubi pushed a commit that referenced this pull request May 2, 2024
@yaoyu-33 @pablo-garay @suiyoubi
NeMo dev doc restructure (#8896)
c4d32ad 
* 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 <[email protected]>
Signed-off-by: Ao Tang <[email protected]>
rohitrango pushed a commit to rohitrango/NeMo that referenced this pull request Jun 25, 2024
@yaoyu-33 @pablo-garay
NeMo dev doc restructure (NVIDIA#8896)
557ab0d 
* 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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@erastorgueva-nv erastorgueva-nv erastorgueva-nv left review comments

@jgerh jgerh jgerh left review comments

@ericharper ericharper ericharper approved these changes

Assignees
No one assigned
Labels
ASR Multi Modal NLP
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@yaoyu-33 @ericharper @erastorgueva-nv @jgerh @pablo-garay