Clean up dev docs collection section (#9205)

* Update examples Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> * Update index Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> * Update index Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> * update Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> * update Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> * fix Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> * update Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> --------- Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>
NVIDIA · May 17, 2024 · 659e025 · 659e025
1 parent 51c2c3f
commit 659e025
Show file tree

Hide file tree

Showing 11 changed files with 48 additions and 52 deletions.
diff --git a/docs/source/core/core_index.rst → docs/source/apis.rst b/docs/source/core/core_index.rst → docs/source/apis.rst
@@ -14,14 +14,26 @@ You can learn more about aspects of the NeMo "core" by following the links below
    :name: core
    :titlesonly:
 
-   core
-   neural_modules
-   exp_manager
-   neural_types
-   export
-   adapters/intro
-   api
+   core/core
+   core/neural_modules
+   core/exp_manager
+   core/neural_types
+   core/export
+   core/adapters/intro
 
+You can learn more about aspects of the NeMo APIs by following the links below:
+
+.. toctree::
+   :maxdepth: 1
+   :name: API
+   :titlesonly:
+
+   core/api
+   common/intro
+   nlp/api
+   multimodal/api
+   asr/api
+   tts/api
 
 
 Alternatively, you can jump straight to the documentation for the individual collections:

diff --git a/docs/source/asr/api.rst b/docs/source/asr/api.rst
@@ -1,5 +1,5 @@
-NeMo ASR Collection API
-=======================
+NeMo ASR API
+============
 
 
 Model Classes

diff --git a/docs/source/asr/ssl/intro.rst b/docs/source/asr/ssl/intro.rst
@@ -1,5 +1,5 @@
-Self-Supervised Learning
-=================================
+Speech Self-Supervised Learning
+===============================
 
 Self-Supervised Learning (SSL) refers to the problem of learning without explicit labels. As 
 any learning process require feedback, without explit labels, SSL derives supervisory signals from 

diff --git a/docs/source/collections.rst b/docs/source/collections.rst
@@ -11,26 +11,9 @@ Documentation for the individual collections
    :titlesonly:
 
    nlp/nemo_megatron/intro
-   nlp/models
    nlp/machine_translation/machine_translation
    nlp/megatron_onnx_export
    nlp/quantization
-   nlp/api
-
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Speech AI
-   :name: Speech AI
-   :titlesonly:
-
-   asr/intro
-   asr/speech_classification/intro
-   asr/speaker_recognition/intro
-   asr/speaker_diarization/intro
-   asr/ssl/intro
-   asr/speech_intent_slot/intro
-
 
 .. toctree::
    :maxdepth: 1
@@ -42,29 +25,32 @@ Documentation for the individual collections
    multimodal/vlm/intro
    multimodal/text2img/intro
    multimodal/nerf/intro
-   multimodal/api
-
 
 .. toctree::
    :maxdepth: 1
-   :caption: Text To Speech (TTS)
-   :name: Text To Speech
+   :caption: Vision (CV)
+   :name: vision
    :titlesonly:
 
-   tts/intro
+   vision/intro
 
 .. toctree::
    :maxdepth: 1
-   :caption: Vision (CV)
-   :name: vision
+   :caption: Speech AI
+   :name: Speech AI
    :titlesonly:
 
-   vision/intro
+   asr/intro
+   asr/speech_classification/intro
+   asr/speaker_recognition/intro
+   asr/speaker_diarization/intro
+   asr/ssl/intro
+   asr/speech_intent_slot/intro
 
 .. toctree::
    :maxdepth: 1
-   :caption: Common
-   :name: Common
+   :caption: Text To Speech (TTS)
+   :name: Text To Speech
    :titlesonly:
 
-   common/intro
+   tts/intro
diff --git a/docs/source/common/intro.rst b/docs/source/common/intro.rst
@@ -1,5 +1,5 @@
-Common Collection
-=================
+NeMo Common Collection API
+==========================
 
 The common collection contains things that could be used across all collections.
 

diff --git a/docs/source/core/api.rst b/docs/source/core/api.rst
@@ -1,6 +1,6 @@
 
-Core APIs
-=========
+NeMo Core APIs
+==============
 
 Base class for all NeMo models
 ------------------------------

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -69,7 +69,7 @@ For more information, browse the developer docs for your area of interest in the
    :name: APIs
    :titlesonly:
 
-   core/core_index
+   apis
 
 .. toctree::
    :maxdepth: 1

diff --git a/docs/source/multimodal/api.rst b/docs/source/multimodal/api.rst
@@ -1,5 +1,5 @@
-Multimodal API
-=======================
+NeMo Multimodal API
+===================
 
 Model Classes
 -------------

diff --git a/docs/source/nlp/api.rst b/docs/source/nlp/api.rst
@@ -1,5 +1,5 @@
-Large language Model API
-========================
+NeMo Large language Model API
+=============================
 
 Pretraining Model Classes
 -------------------------

diff --git a/docs/source/tts/api.rst b/docs/source/tts/api.rst
@@ -1,5 +1,5 @@
-NeMo TTS Collection API
-=======================
+NeMo TTS API
+============
 
 Model Classes
 -------------

diff --git a/docs/source/tts/intro.rst b/docs/source/tts/intro.rst
@@ -15,8 +15,6 @@ We will illustrate details in the following sections.
     datasets
     checkpoints
     configs
-    api
-    resources
     g2p
 
 .. include:: resources.rst