NVIDIA NeMo Framework

https://docs.nvidia.com/nemo-framework
Admin
NVIDIA NeMo Framework is a scalable, cloud-native platform for building, customizing, and deploying...
Tokens:587,272
Snippets:3,485
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### NeMo Framework Getting Started Guides

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/overview

Guides for getting started with NeMo Framework 2.0, including quickstart options with NeMo-Run and the NeMo 2.0 API, as well as tutorials.

```markdown
Getting Started
  * [Quickstart with NeMo-Run](https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/quickstart.html)
  * [Quickstart with NeMo 2.0 API](https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/index.html)
  * [Tutorials](https://docs.nvidia.com/nemo-framework/user-guide/latest/playbooks/index.html)
```

--------------------------------

### NeMo Framework Getting Started Guides

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/playbooks/index

Guides for getting started with NeMo Framework, including quickstarts for NeMo-Run and the NeMo 2.0 API, as well as tutorials.

```markdown
[Quickstart with NeMo-Run](https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/quickstart.html)
[Quickstart with NeMo 2.0 API](https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/index.html)
[Tutorials](https://docs.nvidia.com/nemo-framework/user-guide/25.02/playbooks/index.html)
```

--------------------------------

### NeMo Framework Getting Started and Tutorials

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/common/intro

Guides for getting started with NeMo Framework, including quickstarts and tutorials.

```markdown
* [Quickstart with NeMo-Run](https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/quickstart.html)
* [Quickstart with NeMo 2.0 API](https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/index.html)
* [Tutorials](https://docs.nvidia.com/nemo-framework/user-guide/25.02/playbooks/index.html)
```

--------------------------------

### Getting Started with NeMo Framework

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/overview

Guides users on how to get started with the NeMo Framework, including quickstart options with NeMo-Run and the NeMo 2.0 API, as well as a link to tutorials.

```Markdown
[Quickstart with NeMo-Run](https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/quickstart.html)
[Quickstart with NeMo 2.0 API](https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/index.html)
[Tutorials](https://docs.nvidia.com/nemo-framework/user-guide/25.02/playbooks/index.html)
```

--------------------------------

### NeMo Framework Getting Started Guides

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemotoolkit/vision/intro

Guides for getting started with NeMo Framework 2.0, including quickstart instructions for NeMo-Run and the NeMo 2.0 API, as well as access to tutorials.

```markdown
## Getting Started
  * [Quickstart with NeMo-Run](https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/quickstart.html)
  * [Quickstart with NeMo 2.0 API](https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/index.html)
  * [Tutorials](https://docs.nvidia.com/nemo-framework/user-guide/latest/playbooks/index.html)
```

--------------------------------

### NeMo Framework Getting Started Guides

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/core/core

Guides for quickly starting with NeMo Framework, including quickstart with NeMo-Run and NeMo 2.0 API, and tutorials.

```APIDOC
Quickstart with NeMo-Run:
  - Introduces the NeMo-Run tool for rapid model deployment and execution.

Quickstart with NeMo 2.0 API:
  - Guides users through the NeMo 2.0 API for custom model development.

Tutorials:
  - Links to various tutorials covering different aspects of NeMo Framework usage.
```

--------------------------------

### NeMo 2.0 Quickstart and Tutorials

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemotoolkit/tts/intro

Guides users through getting started with NeMo 2.0, including quickstart examples with NeMo-Run and the NeMo 2.0 API. It also links to various tutorials.

```Python
# Example of using NeMo-Run for a quickstart
# nemo-run --config <your_config.yaml>

# Example of NeMo 2.0 API usage (conceptual)
# from nemo.collections.tts.models import Tacotron2Model
# model = Tacotron2Model.from_pretrained('tts_en_tacotron2_ljspeech')
# audio = model.predict('Hello world!')

```

--------------------------------

### NeMo Framework Getting Started

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.09/nemotoolkit/nlp/nemo_megatron/rampup_batch_size

Guides for getting started with NeMo Framework, including quickstarts and tutorials.

```markdown
[Quickstart with NeMo-Run](https://docs.nvidia.com/nemo-framework/user-guide/24.09/nemo-2.0/quickstart.html)
[Quickstart with NeMo 2.0 API](https://docs.nvidia.com/nemo-framework/user-guide/24.09/nemo-2.0/index.html)
[Tutorials](https://docs.nvidia.com/nemo-framework/user-guide/24.09/playbooks/index.html)
```

--------------------------------

### NeMo Framework Getting Started Guides

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/index

Guides for quickly starting with NeMo-Run and the NeMo 2.0 API, including tutorials.

```markdown
[Quickstart with NeMo-Run](https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/quickstart.html)
[Quickstart with NeMo 2.0 API](https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/index.html)
[Tutorials](https://docs.nvidia.com/nemo-framework/user-guide/25.02/playbooks/index.html)
```

--------------------------------

### NeMo 2.0 Getting Started and Tutorials

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemotoolkit/index

Guides users on how to get started with NeMo 2.0, including quickstart options for NeMo-Run and the NeMo 2.0 API. It also links to available tutorials for practical application.

```en
Getting Started
  * [Quickstart with NeMo-Run](https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/quickstart.html)
  * [Quickstart with NeMo 2.0 API](https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/index.html)
  * [Tutorials](https://docs.nvidia.com/nemo-framework/user-guide/latest/playbooks/index.html)
```

--------------------------------

### NeMo Framework Quickstart with NeMo-Run

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.09/playbooks/index

Provides instructions for getting started with the NeMo Framework using NeMo-Run.

```en
Quickstart with NeMo-Run
https://docs.nvidia.com/nemo-framework/user-guide/24.09/nemo-2.0/quickstart.html
```

--------------------------------

### NeMo Framework Quickstart with NeMo-Run

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.09/nemo-2.0/quickstart

Provides instructions for getting started with the NeMo Framework using NeMo-Run, a tool for simplifying model training and deployment.

```en
https://docs.nvidia.com/nemo-framework/user-guide/24.09/nemo-2.0/quickstart.html
```

--------------------------------

### NeMo Framework Quickstart and Playbooks

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.07/overview

Guides users on getting started with the NeMo Framework and utilizing playbooks for various AI tasks. This section is crucial for initial setup and understanding common workflows.

```APIDOC
Quickstart:
  Getting Started
  Playbooks
```

--------------------------------

### NeMo 2.0 Getting Started and Tutorials

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemotoolkit/nlp/nemo_megatron/intro

Guides new users through getting started with NeMo 2.0, including quickstarts with NeMo-Run and the NeMo 2.0 API, as well as a collection of tutorials.

```en
Getting Started:
  * [Quickstart with NeMo-Run](https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/quickstart.html)
  * [Quickstart with NeMo 2.0 API](https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/index.html)
  * [Tutorials](https://docs.nvidia.com/nemo-framework/user-guide/latest/playbooks/index.html)
```

--------------------------------

### NeMo Framework 2.0 Quickstart with NeMo-Run

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/quickstart

Provides instructions and guidance for getting started with the NeMo Framework version 2.0 using the NeMo Run library. This is the recommended approach for new users.

```markdown
[Quickstart with NeMo-Run](https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/quickstart.html)
```

--------------------------------

### Getting Started with NeMo Framework

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/tools/intro

Guides users on how to quickly start using the NeMo Framework with NeMo-Run and the NeMo 2.0 API, including tutorials.

```markdown
[Quickstart with NeMo-Run](https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/quickstart.html)
[Quickstart with NeMo 2.0 API](https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/index.html)
[Tutorials](https://docs.nvidia.com/nemo-framework/user-guide/25.02/playbooks/index.html)
```

--------------------------------

### NeMo Framework Getting Started Guides

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemotoolkit/common/intro

This section provides essential starting points for using the NeMo Framework, including quickstart guides for NeMo-Run and the NeMo 2.0 API, as well as access to various tutorials for hands-on learning.

```APIDOC
Getting Started:
  Quickstart with NeMo-Run: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/quickstart.html
  Quickstart with NeMo 2.0 API: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/index.html
  Tutorials: https://docs.nvidia.com/nemo-framework/user-guide/latest/playbooks/index.html
```

--------------------------------

### NeMo Framework Quickstart with NeMo-Run

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.12/nemotoolkit/tts/intro

Provides instructions for getting started with the NeMo Framework using NeMo-Run, a tool for simplifying the execution of NeMo-based applications.

```python
print('Refer to the NVIDIA NeMo Framework User Guide for detailed instructions on using NeMo-Run.')
```

--------------------------------

### NeMo Framework Quickstart with NeMo-Run

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.12/nemotoolkit/tools/intro

This section provides a quickstart guide for using NeMo-Run, a tool for running NeMo Framework applications. It outlines the initial steps to get started with the framework.

```python
print('This is a placeholder for NeMo-Run quickstart instructions.')
# Actual commands and configurations would be detailed here.
```

--------------------------------

### NeMo Framework Quickstart with NeMo-Run

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.12/nemo-2.0/quickstart

Provides a quickstart guide for using the NeMo Framework with NeMo-Run, a command-line interface for managing and running NeMo experiments. This section likely covers basic setup and execution of pre-defined workflows.

```python
import nemo.cli

# Example command to run a NeMo experiment
nemo.cli.run('experiment.yaml')
```

--------------------------------

### NVIDIA NeMo Framework Getting Started

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/index

Provides links to essential resources for new users of the NVIDIA NeMo Framework, including an introduction, fundamentals, and tutorials to help users get started quickly.

```text
Introduction
NeMo Fundamentals
Tutorials
```

--------------------------------

### NeMo Framework Quickstart with NeMo 2.0 API

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.09/playbooks/index

Provides instructions for getting started with the NeMo Framework using the NeMo 2.0 API.

```en
Quickstart with NeMo 2.0 API
https://docs.nvidia.com/nemo-framework/user-guide/24.09/nemo-2.0/index.html
```

--------------------------------

### Getting Started with NeMo Framework

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.12/nemotoolkit/core/core

Provides quickstart guides for using NeMo-Run and the NeMo 2.0 API, along with access to various tutorials for hands-on learning.

```python
# Quickstart with NeMo-Run
# Quickstart with NeMo 2.0 API
# Tutorials and Playbooks
```

--------------------------------

### NeMo Framework Quickstart with NeMo 2.0 API

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.09/nemo-2.0/quickstart

Guides users through the initial setup and usage of the NeMo 2.0 API for building and training models.

```en
https://docs.nvidia.com/nemo-framework/user-guide/24.09/nemo-2.0/index.html
```

--------------------------------

### NeMo Framework Getting Started Guide

Source: https://docs.nvidia.com/nemo-framework/index

A guide to fundamental concepts of the NeMo Framework, providing resources to help users start building generative AI applications.

```Markdown
[NeMo Framework Getting Started](https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/quickstart.html)

This guide is designed to help you understand some fundamental concepts related to the various components of the framework, and point you to some resources to kickstart your journey in using it to build generative AI applications.
[ Browse ](https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/quickstart.html)
```

--------------------------------

### NeMo Framework 2.0 Quickstart with API

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemotoolkit/core/core

Guides users through the initial setup and usage of NeMo Framework 2.0 directly via its API. This is for users who prefer to interact with the framework programmatically from the outset.

```en
Quickstart with NeMo 2.0 API
https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/index.html
```

--------------------------------

### NeMo Framework 2.0 Quickstart with NeMo-Run

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemotoolkit/core/core

Provides instructions and guidance for getting started with NeMo Framework 2.0 using the NeMo-Run tool. This section is crucial for new users to quickly set up and begin utilizing the framework's capabilities.

```en
Quickstart with NeMo-Run
https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/quickstart.html
```

--------------------------------

### NeMo Framework 2.0 Quickstart with NeMo-Run

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemotoolkit/multimodal/mllm/intro

This section provides a quickstart guide for using NeMo-Run, a new library introduced in NeMo 2.0. It helps users get started with the framework's latest features.

```python
from nemo_run.cli import run

# Example command to run a NeMo job
# run(['--config-path', 'path/to/your/config.yaml'])

```

--------------------------------

### NeMo Framework Quickstart with NeMo-Run

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/quickstart

This section provides a quickstart guide for using NeMo-Run, a tool for running NeMo experiments. It likely involves command-line execution of NeMo configurations.

```bash
nemo-run --config-path=<path_to_config>
```

--------------------------------

### NeMo Framework Overview and Installation

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/core/core

Provides an overview of the NeMo Framework and instructions for installation. Covers core concepts and initial setup.

```APIDOC
Overview:
  - Provides a general introduction to the NVIDIA NeMo Framework.

Install NeMo Framework:
  - Detailed instructions for installing the NeMo Framework.
  - May include prerequisites and environment setup.
```

--------------------------------

### NeMo 2.0 Quickstart with NeMo-Run

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/playbooks/index

Provides instructions and guidance for getting started with NeMo 2.0 using the NeMo Run library. This section is essential for new users to quickly set up and begin utilizing the framework's capabilities.

```APIDOC
NeMo-Run Quickstart:
  - Install NeMo Framework: Refer to the installation guide.
  - Launch NeMo Run: Follow the specific commands provided in the quickstart documentation.
  - Basic Usage: Examples of running pre-trained models and custom training jobs.
```

--------------------------------

### NeMo Framework Tutorials

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.09/playbooks/index

Guides users on getting started with NeMo through various tutorials covering different domains and topics, runnable within the NeMo Framework Docker Container.

```APIDOC
NeMo Framework Tutorials Index: https://docs.nvidia.com/nemo-framework/user-guide/24.09/playbooks/index.html#tutorials
NeMo Framework Large Language Models Tutorials: https://docs.nvidia.com/nemo-framework/user-guide/24.09/playbooks/index.html#large-language-models
```

--------------------------------

### NeMo Framework 2.0 Quickstart with NeMo API

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/quickstart

Offers a guide for users who want to start with the NeMo Framework version 2.0 directly using its API. This section is for those familiar with NeMo's programmatic interface.

```markdown
[Quickstart with NeMo 2.0 API](https://docs.nvidia.com/nemo-framework/user-guide/latest/nemo-2.0/index.html)
```

--------------------------------

### NeMo Framework Overview and Installation

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/tools/intro

Provides an introduction to the NeMo Framework and guides users through the installation process.

```markdown
[Overview](https://docs.nvidia.com/nemo-framework/user-guide/25.02/overview.html)
[Install NeMo Framework](https://docs.nvidia.com/nemo-framework/user-guide/25.02/installation.html)
```

--------------------------------

### NeMo Framework - Getting Started with NeMo-Run

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.12/playbooks/index

Provides guidance on how to quickly start using the NeMo Framework with the NeMo-Run tool. This section is essential for new users to get up and running with basic functionalities.

```python
from nemo.cli import cli

# Example of running a NeMo playbook
cli.run('playbook --config config.yaml')
```

--------------------------------

### NeMo Framework Quickstart with NeMo 2.0 API

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/quickstart

This section details how to get started with the NeMo 2.0 API, likely involving Python code for model definition, training, and inference.

```python
from nemo.core import ...

# Example usage of NeMo 2.0 API
```

--------------------------------

### NeMo Framework 2.0 Quickstart with NeMo-Run

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemotoolkit/asr/intro

This section provides a quickstart guide for using the NeMo Framework version 2.0 with the NeMo Run library. It is intended for users who want to get started quickly with the latest features.

```python
from nemo.run import NemoRun

# Example usage of NeMo Run
nr = NemoRun()
nr.run('your_config.yaml')
```

--------------------------------

### NeMo Framework Installation and Overview

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/index

Provides links to installation guides and an overview of the NeMo Framework.

```markdown
[Install NeMo Framework](https://docs.nvidia.com/nemo-framework/user-guide/25.02/installation.html)
[Overview](https://docs.nvidia.com/nemo-framework/user-guide/25.02/overview.html)
```

--------------------------------

### NeMo Framework Overview and Installation

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/common/intro

Provides an overview of the NeMo Framework and guides for installation.

```markdown
* [Overview](https://docs.nvidia.com/nemo-framework/user-guide/25.02/overview.html)
* [Install NeMo Framework](https://docs.nvidia.com/nemo-framework/user-guide/25.02/installation.html)
```

--------------------------------

### NeMo Framework Overview and Installation

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/playbooks/index

Provides an overview of the NeMo Framework and guides for installation. Covers general information and performance aspects.

```markdown
[Overview](https://docs.nvidia.com/nemo-framework/user-guide/25.02/overview.html)
[Install NeMo Framework](https://docs.nvidia.com/nemo-framework/user-guide/25.02/installation.html)
[Performance](https://docs.nvidia.com/nemo-framework/user-guide/25.02/performance/performance_summary.html)
[Why NeMo Framework?](https://docs.nvidia.com/nemo-framework/user-guide/25.02/why-nemo.html)
```

--------------------------------

### NeMo Framework Overview and Getting Started

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.07/nemotoolkit/tools/intro

Provides an introduction to the NeMo Framework, its performance aspects, and how to get started with playbooks.

```APIDOC
Overview:
  - Access the main overview documentation.

Performance:
  - Review performance benchmarks and summaries.

Getting Started:
  - Follow the quickstart guide to begin using NeMo.

Playbooks:
  - Explore available playbooks for common tasks.
```

--------------------------------

### NeMo Framework Overview and Installation

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.09/nemotoolkit/nlp/nemo_megatron/rampup_batch_size

Provides an overview of the NeMo Framework and guides for installation.

```markdown
[Overview](https://docs.nvidia.com/nemo-framework/user-guide/24.09/overview.html)
[Install NeMo Framework](https://docs.nvidia.com/nemo-framework/user-guide/24.09/installation.html)
```

--------------------------------

### NeMo Framework Overview and Getting Started

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.07/nemotoolkit/asr/intro

Provides an introduction to the NeMo Framework, its core concepts, and initial steps for getting started. Includes links to performance benchmarks and best practices.

```APIDOC
Overview:
  Description: Provides a general introduction to the NeMo Framework.
  URL: https://docs.nvidia.com/nemo-framework/user-guide/24.07/overview.html

Performance:
  Description: Details performance metrics and optimization strategies for NeMo.
  URL: https://docs.nvidia.com/nemo-framework/user-guide/24.07/performance/performance_summary.html

Why NeMo Framework?:
  Description: Explains the advantages and use cases of the NeMo Framework.
  URL: https://docs.nvidia.com/nemo-framework/user-guide/24.07/best-practices.html

Getting Started:
  Description: A step-by-step guide to setting up and beginning with NeMo.
  URL: https://docs.nvidia.com/nemo-framework/user-guide/24.07/getting-started.html

Playbooks:
  Description: Provides example playbooks for common NeMo tasks.
  URL: https://docs.nvidia.com/nemo-framework/user-guide/24.07/playbooks/index.html
```

--------------------------------

### NeMo 2.0 API: Quickstart Training Loop Example

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.12/playbooks/index

Showcases a simple training loop using the NeMo 2.0 API from the NeMo Framework LLM collection. This example demonstrates the basic usage of the training API.

```Python
from nemo.collections.llm.api import Trainer
from nemo.collections.llm.models import LlmModel

# Initialize model and trainer (conceptual)
# model = LlmModel.from_pretrained('gpt-neox-20b')
# trainer = Trainer(max_epochs=3, batch_size=8)

# Example training call (conceptual)
# trainer.fit(model, train_data=train_dataloader, val_data=val_dataloader)
```

--------------------------------

### NeMo Framework Overview and Getting Started

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.07/nemotoolkit/tts/intro

Provides an introduction to the NeMo Framework, its core concepts, and initial steps for getting started. Includes links to performance benchmarks and best practices.

```APIDOC
Overview:
  Description: Provides a general introduction to the NeMo Framework.
  URL: https://docs.nvidia.com/nemo-framework/user-guide/24.07/overview.html

Performance:
  Description: Details performance metrics and optimization strategies for NeMo.
  URL: https://docs.nvidia.com/nemo-framework/user-guide/24.07/performance/performance_summary.html

Why NeMo Framework?:
  Description: Explains the advantages and use cases of the NeMo Framework.
  URL: https://docs.nvidia.com/nemo-framework/user-guide/24.07/best-practices.html

Getting Started:
  Description: A step-by-step guide to setting up and beginning with NeMo.
  URL: https://docs.nvidia.com/nemo-framework/user-guide/24.07/getting-started.html

Playbooks:
  Description: Provides example playbooks for common NeMo tasks.
  URL: https://docs.nvidia.com/nemo-framework/user-guide/24.07/playbooks/index.html
```

--------------------------------

### NeMo Framework Overview and Getting Started

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.07/nemotoolkit/vision/intro

Provides an introduction to the NeMo Framework, its core concepts, and initial steps for getting started. Includes links to performance benchmarks and best practices.

```APIDOC
Overview:
  Description: Provides a general introduction to the NeMo Framework.
  URL: https://docs.nvidia.com/nemo-framework/user-guide/24.07/overview.html

Performance:
  Description: Details performance metrics and optimization strategies for NeMo.
  URL: https://docs.nvidia.com/nemo-framework/user-guide/24.07/performance/performance_summary.html

Why NeMo Framework?:
  Description: Explains the advantages and use cases of the NeMo Framework.
  URL: https://docs.nvidia.com/nemo-framework/user-guide/24.07/best-practices.html

Getting Started:
  Description: A step-by-step guide to setting up and beginning with NeMo.
  URL: https://docs.nvidia.com/nemo-framework/user-guide/24.07/getting-started.html

Playbooks:
  Description: Provides example playbooks for common NeMo tasks.
  URL: https://docs.nvidia.com/nemo-framework/user-guide/24.07/playbooks/index.html
```

--------------------------------

### NeMo Framework Overview and Getting Started

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.07/nemotoolkit/common/intro

Provides an introduction to the NeMo Framework, its purpose, and how to get started with its various components and features.

```APIDOC
NeMo Framework Overview:
  - Introduction to NeMo Framework
  - Performance considerations
  - Key benefits and use cases

Getting Started:
  - Quickstart guide for NeMo Framework
  - Information on Playbooks
```

--------------------------------

### NeMo Framework Overview and Installation

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/overview

Provides an overview of the NeMo Framework and guides users through the installation process. This section is crucial for setting up the environment to use NeMo.

```Markdown
[Overview](https://docs.nvidia.com/nemo-framework/user-guide/25.02/overview.html)
[Install NeMo Framework](https://docs.nvidia.com/nemo-framework/user-guide/25.02/installation.html)
```

--------------------------------

### NeMo Framework Overview and Getting Started

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.07/nemotoolkit/multimodal/mllm/intro

Provides an introduction to the NeMo Framework, its core concepts, and initial steps for users to get started with the toolkit. Covers performance aspects and best practices for utilizing NeMo.

```Markdown
- [Overview](https://docs.nvidia.com/nemo-framework/user-guide/24.07/overview.html)
- [Performance](https://docs.nvidia.com/nemo-framework/user-guide/24.07/performance/performance_summary.html)
- [Why NeMo Framework?](https://docs.nvidia.com/nemo-framework/user-guide/24.07/best-practices.html)
- [Getting Started](https://docs.nvidia.com/nemo-framework/user-guide/24.07/getting-started.html)
- [Playbooks](https://docs.nvidia.com/nemo-framework/user-guide/24.07/playbooks/index.html)
```

--------------------------------

### NeMo Framework 2.0 Quickstart with API

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemotoolkit/asr/intro

This section offers a quickstart guide for the NeMo Framework version 2.0 using its API directly. It's for users who prefer to interact with the framework programmatically.

```python
import nemo.collections.asr as nemo_asr

# Example of initializing an ASR model
model = nemo_asr.models.EncDecCTCModel.from_pretrained(model_name='stt_en_conformer_ctc_large')
```

--------------------------------

### NeMo 2.0 Quickstart with NeMo-Run

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.07/nemotoolkit/index

A quickstart guide for using NeMo 2.0 with NeMo-Run, a tool for simplifying the execution of NeMo training and inference scripts.

```APIDOC
NeMo 2.0 Quickstart with NeMo-Run:
  Guides users through the initial setup and usage of NeMo 2.0 leveraging the NeMo-Run utility.
  Covers basic commands for running models and training jobs.
```

--------------------------------

### NeMo Framework Overview and Installation

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemotoolkit/nlp/nemo_megatron/intro

Provides an overview of the NeMo Framework and guides users through the installation process. It also touches upon performance aspects and the rationale behind choosing NeMo.

```en
NeMo Framework:
  * [Overview](https://docs.nvidia.com/nemo-framework/user-guide/latest/overview.html)
  * [Install NeMo Framework](https://docs.nvidia.com/nemo-framework/user-guide/latest/installation.html)
  * [Performance](https://docs.nvidia.com/nemo-framework/user-guide/latest/performance/performance-summary.html)
  * [Why NeMo Framework?](https://docs.nvidia.com/nemo-framework/user-guide/latest/why-nemo.html)
```

--------------------------------

### NeMo Framework 2.0 Quickstart with API

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemotoolkit/multimodal/mllm/intro

This section offers a quickstart guide for the NeMo 2.0 API, enabling users to begin developing with the framework's core functionalities.

```python
from nemo.core import NeMoConfig
from nemo.collections.nlp.models import TokenClassificationModel

# Example of initializing a model
# model = TokenClassificationModel.from_pretrained(model_name='nerc-bert-base')

```

--------------------------------

### NeMo Framework Quickstart with NeMo 2.0 API

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.12/nemotoolkit/tools/intro

This section offers a quickstart guide for the NeMo 2.0 API, enabling users to begin developing with the latest version of the NeMo Framework.

```python
print('This is a placeholder for NeMo 2.0 API quickstart instructions.')
# Example API usage would be provided here.
```

--------------------------------

### NeMo Framework Migration Guide: Pre-Training

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/quickstart

This guide covers migrating pre-training configurations and workflows to NeMo 2.0. It may include code examples for setting up pre-training jobs.

```python
# NeMo 2.0 Pre-Training Configuration Example
```

--------------------------------

### SpeechLLM Example Link

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/multimodal/mllm/intro

Provides a link to the SpeechLLM example on GitHub for detailed implementation guidance.

```Markdown
[SpeechLLM example](https://github.com/NVIDIA/NeMo/blob/main/examples/multimodal/speech_llm/README.md)
```

--------------------------------

### NeMo 2.0 LLM Quickstart Training

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/playbooks/index

Demonstrates a simple training loop using the NeMo 2.0 API from the NeMo Framework LLM collection. This example is suitable for getting started with NeMo 2.0.

```Python
from nemo.collections.llm.api import train

# Example usage (specifics depend on NeMo 2.0 API)
train.run_training_loop(config='path/to/config.yaml')
```

--------------------------------

### NeMo Framework Quickstart with NeMo 2.0 API

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.12/nemo-2.0/quickstart

Offers a quickstart guide for interacting with the NeMo Framework using its Python API, specifically for version 2.0. This would involve importing NeMo modules and utilizing their functionalities for model definition, training, and inference.

```python
from nemo.collections.nlp.models import ...

# Example of initializing a NeMo model
model = ...()
```

--------------------------------

### NeMo Framework Quickstart and Execution

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.07/nemo-2.0/quickstart

Guides users through setting up prerequisites, configuring recipes by overriding attributes or swapping recipes, and executing tasks locally or on a Slurm cluster. It also covers adjusting the number of GPUs for execution.

```APIDOC
NeMo Framework Quickstart:

Set up the Prerequisites:
  - Instructions for preparing the environment and dependencies.

Configure the Recipe:
  - Override attributes: Modify configuration parameters within existing recipes.
  - Swap Recipes: Replace entire recipe files to change functionality.

Execute Locally:
  - Change the number of GPUs: Adjust resource allocation for local runs.

Execute on a Slurm Cluster:
  - Submit NeMo jobs to a Slurm workload manager for distributed execution.
```

--------------------------------

### NeMo Framework Image Curation Guides

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.12/nemotoolkit/nlp/nemo_megatron/intro

Guides for image curation within the NeMo Framework, covering getting started, image-text pair datasets, and classifiers for aesthetics and NSFW content.

```APIDOC
Get Started: https://docs.nvidia.com/nemo-framework/user-guide/24.12/datacuration/image/gettingstarted.html
Image-Text Pair Datasets: https://docs.nvidia.com/nemo-framework/user-guide/24.12/datacuration/image/datasets.html
Aesthetic Classifier: https://docs.nvidia.com/nemo-framework/user-guide/24.12/datacuration/image/classifiers/aesthetic.html
NSFW Classifier: https://docs.nvidia.com/nemo-framework/user-guide/24.12/datacuration/image/classifiers/nsfw.html
```

--------------------------------

### NeMo Framework Migration Guide: Nsys Profiling

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/quickstart

This guide explains how to migrate Nsys profiling setups for NeMo 2.0. It could include command-line examples for using Nsys with NeMo.

```bash
# Nsys Profiling Command Example with NeMo
```

--------------------------------

### Setup Workspace and Files

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.07/nemo-2.0/quickstart

Commands to set up the workspace, create a directory, navigate into it, and create a Python file for pre-training. This is a prerequisite for running NeMo recipes.

```bash
# Check GPU access
nvidia-smi

# Create and go to workspace
mkdir -p /workspace/nemo-run
cd /workspace/nemo-run

# Create a python file to run pre-training
touch nemotron_pretraining.py

```

--------------------------------

### NeMo Curator Image Curation

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/overview

Guides for curating image data using NeMo Curator. Covers getting started, working with image-text pairs, and using aesthetic and NSFW classifiers.

```Python
# Example: Working with Image-Text Pair Datasets
from nemo.collections.common.data.image_dataset import ImageTextDataset

# Assuming you have a CSV file with image paths and captions
dataset = ImageTextDataset(image_path_col='image_path', caption_col='caption', csv_file='path/to/your/dataset.csv')

# Example: Using Aesthetic Classifier
from nemo.collections.common.data.image_classifier import AestheticClassifier

aesthetic_classifier = AestheticClassifier()

# Assuming 'image_path' is the path to an image file
score = aesthetic_classifier.predict(image_path='path/to/image.jpg')

# Example: Using NSFW Classifier
from nemo.collections.common.data.image_classifier import NSFWClassifier

nswf_classifier = NSFWClassifier()

# Assuming 'image_path' is the path to an image file
nsfw_prediction = nswf_classifier.predict(image_path='path/to/image.jpg')
```

--------------------------------

### NeMo Curator Image Curation

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/playbooks/index

Guides for curating image data using NeMo Curator. Covers getting started, working with image-text pairs, and using aesthetic and NSFW classifiers.

```Python
# Example: Working with Image-Text Pair Datasets
from nemo.collections.common.data.image_dataset import ImageTextDataset

# Assuming you have a CSV file with image paths and captions
dataset = ImageTextDataset(image_path_col='image_path', caption_col='caption', csv_file='path/to/your/dataset.csv')

# Example: Using Aesthetic Classifier
from nemo.collections.common.data.image_classifier import AestheticClassifier

aesthetic_classifier = AestheticClassifier()

# Assuming 'image_path' is the path to an image file
score = aesthetic_classifier.predict(image_path='path/to/image.jpg')

# Example: Using NSFW Classifier
from nemo.collections.common.data.image_classifier import NSFWClassifier

nswf_classifier = NSFWClassifier()

# Assuming 'image_path' is the path to an image file
nsfw_prediction = nswf_classifier.predict(image_path='path/to/image.jpg')
```

--------------------------------

### NeMo Curator Image Curation

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/core/core

Guides for curating image data using NeMo Curator. Covers getting started, working with image-text pairs, and using aesthetic and NSFW classifiers.

```Python
# Example: Working with Image-Text Pair Datasets
from nemo.collections.common.data.image_dataset import ImageTextDataset

# Assuming you have a CSV file with image paths and captions
dataset = ImageTextDataset(image_path_col='image_path', caption_col='caption', csv_file='path/to/your/dataset.csv')

# Example: Using Aesthetic Classifier
from nemo.collections.common.data.image_classifier import AestheticClassifier

aesthetic_classifier = AestheticClassifier()

# Assuming 'image_path' is the path to an image file
score = aesthetic_classifier.predict(image_path='path/to/image.jpg')

# Example: Using NSFW Classifier
from nemo.collections.common.data.image_classifier import NSFWClassifier

nswf_classifier = NSFWClassifier()

# Assuming 'image_path' is the path to an image file
nsfw_prediction = nswf_classifier.predict(image_path='path/to/image.jpg')
```

--------------------------------

### NeMo Curator Image Curation

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/quickstart

Guides for curating image data using NeMo Curator. Covers getting started, working with image-text pairs, and using aesthetic and NSFW classifiers.

```Python
# Example: Working with Image-Text Pair Datasets
from nemo.collections.common.data.image_dataset import ImageTextDataset

# Assuming you have a CSV file with image paths and captions
dataset = ImageTextDataset(image_path_col='image_path', caption_col='caption', csv_file='path/to/your/dataset.csv')

# Example: Using Aesthetic Classifier
from nemo.collections.common.data.image_classifier import AestheticClassifier

aesthetic_classifier = AestheticClassifier()

# Assuming 'image_path' is the path to an image file
score = aesthetic_classifier.predict(image_path='path/to/image.jpg')

# Example: Using NSFW Classifier
from nemo.collections.common.data.image_classifier import NSFWClassifier

nswf_classifier = NSFWClassifier()

# Assuming 'image_path' is the path to an image file
nsfw_prediction = nswf_classifier.predict(image_path='path/to/image.jpg')
```

--------------------------------

### NeMo Framework Overview and Installation

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/nemotoolkit/vision/intro

Provides an overview of the NeMo Framework, its purpose, and instructions for installation. It also links to performance-related documentation and explains the benefits of using NeMo.

```markdown
Project: /websites/nvidia_nemo-framework

## NeMo Framework
  * [Overview](https://docs.nvidia.com/nemo-framework/user-guide/latest/overview.html)
  * [Install NeMo Framework](https://docs.nvidia.com/nemo-framework/user-guide/latest/installation.html)
  * [Performance](https://docs.nvidia.com/nemo-framework/user-guide/latest/performance/performance-summary.html)
  * [Why NeMo Framework?](https://docs.nvidia.com/nemo-framework/user-guide/latest/why-nemo.html)
```

--------------------------------

### NeMo Curator Image Curation

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/tts/intro

Guides for curating image data using NeMo Curator. Covers getting started, working with image-text pairs, and using aesthetic and NSFW classifiers.

```Python
# Example: Working with Image-Text Pair Datasets
from nemo.collections.common.data.image_dataset import ImageTextDataset

# Assuming you have a CSV file with image paths and captions
dataset = ImageTextDataset(image_path_col='image_path', caption_col='caption', csv_file='path/to/your/dataset.csv')

# Example: Using Aesthetic Classifier
from nemo.collections.common.data.image_classifier import AestheticClassifier

aesthetic_classifier = AestheticClassifier()

# Assuming 'image_path' is the path to an image file
score = aesthetic_classifier.predict(image_path='path/to/image.jpg')

# Example: Using NSFW Classifier
from nemo.collections.common.data.image_classifier import NSFWClassifier

nswf_classifier = NSFWClassifier()

# Assuming 'image_path' is the path to an image file
nsfw_prediction = nswf_classifier.predict(image_path='path/to/image.jpg')
```

--------------------------------

### NeMo Framework Quickstart with NeMo 2.0 API

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.12/nemotoolkit/tts/intro

Guides users on how to begin using the NeMo Framework through its 2.0 API, enabling programmatic interaction with NeMo's capabilities.

```python
print('Refer to the NVIDIA NeMo Framework User Guide for detailed instructions on using the NeMo 2.0 API.')
```

--------------------------------

### NeMo Curator Image Curation

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/tools/intro

Guides for curating image data using NeMo Curator. Covers getting started, working with image-text pairs, and using aesthetic and NSFW classifiers.

```Python
# Example: Working with Image-Text Pair Datasets
from nemo.collections.common.data.image_dataset import ImageTextDataset

# Assuming you have a CSV file with image paths and captions
dataset = ImageTextDataset(image_path_col='image_path', caption_col='caption', csv_file='path/to/your/dataset.csv')

# Example: Using Aesthetic Classifier
from nemo.collections.common.data.image_classifier import AestheticClassifier

aesthetic_classifier = AestheticClassifier()

# Assuming 'image_path' is the path to an image file
score = aesthetic_classifier.predict(image_path='path/to/image.jpg')

# Example: Using NSFW Classifier
from nemo.collections.common.data.image_classifier import NSFWClassifier

nswf_classifier = NSFWClassifier()

# Assuming 'image_path' is the path to an image file
nsfw_prediction = nswf_classifier.predict(image_path='path/to/image.jpg')
```

--------------------------------

### NeMo Curator Image Curation

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/index

Guides for curating image data using NeMo Curator. Covers getting started, working with image-text pairs, and using aesthetic and NSFW classifiers.

```Python
# Example: Working with Image-Text Pair Datasets
from nemo.collections.common.data.image_dataset import ImageTextDataset

# Assuming you have a CSV file with image paths and captions
dataset = ImageTextDataset(image_path_col='image_path', caption_col='caption', csv_file='path/to/your/dataset.csv')

# Example: Using Aesthetic Classifier
from nemo.collections.common.data.image_classifier import AestheticClassifier

aesthetic_classifier = AestheticClassifier()

# Assuming 'image_path' is the path to an image file
score = aesthetic_classifier.predict(image_path='path/to/image.jpg')

# Example: Using NSFW Classifier
from nemo.collections.common.data.image_classifier import NSFWClassifier

nswf_classifier = NSFWClassifier()

# Assuming 'image_path' is the path to an image file
nsfw_prediction = nswf_classifier.predict(image_path='path/to/image.jpg')
```

--------------------------------

### NeMo 2.0 Quickstart with API

Source: https://docs.nvidia.com/nemo-framework/user-guide/latest/playbooks/index

Guides users through the initial steps of using the NeMo 2.0 API directly. This is for developers who prefer to interact with NeMo through its programmatic interface.

```APIDOC
NeMo 2.0 API Quickstart:
  - Import NeMo modules: `import nemo.collections.nlp as nemo_nlp`
  - Initialize a model: `model = nemo_nlp.models.EncDecCTCModel.from_pretrained(model_name='stt_en_conformer_ctc_large')`
  - Perform inference: `output = model.transcribe(audio_file)`
```

--------------------------------

### NeMo Curator Image Curation

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/multimodal/mllm/intro

Guides for curating image data using NeMo Curator. Covers getting started, working with image-text pairs, and using aesthetic and NSFW classifiers.

```Python
# Example: Working with Image-Text Pair Datasets
from nemo.collections.common.data.image_dataset import ImageTextDataset

# Assuming you have a CSV file with image paths and captions
dataset = ImageTextDataset(image_path_col='image_path', caption_col='caption', csv_file='path/to/your/dataset.csv')

# Example: Using Aesthetic Classifier
from nemo.collections.common.data.image_classifier import AestheticClassifier

aesthetic_classifier = AestheticClassifier()

# Assuming 'image_path' is the path to an image file
score = aesthetic_classifier.predict(image_path='path/to/image.jpg')

# Example: Using NSFW Classifier
from nemo.collections.common.data.image_classifier import NSFWClassifier

nswf_classifier = NSFWClassifier()

# Assuming 'image_path' is the path to an image file
nsfw_prediction = nswf_classifier.predict(image_path='path/to/image.jpg')
```

--------------------------------

### NeMo Curator Image Curation

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/common/intro

Guides for curating image data using NeMo Curator. Covers getting started, working with image-text pairs, and using aesthetic and NSFW classifiers.

```Python
# Example: Working with Image-Text Pair Datasets
from nemo.collections.common.data.image_dataset import ImageTextDataset

# Assuming you have a CSV file with image paths and captions
dataset = ImageTextDataset(image_path_col='image_path', caption_col='caption', csv_file='path/to/your/dataset.csv')

# Example: Using Aesthetic Classifier
from nemo.collections.common.data.image_classifier import AestheticClassifier

aesthetic_classifier = AestheticClassifier()

# Assuming 'image_path' is the path to an image file
score = aesthetic_classifier.predict(image_path='path/to/image.jpg')

# Example: Using NSFW Classifier
from nemo.collections.common.data.image_classifier import NSFWClassifier

nswf_classifier = NSFWClassifier()

# Assuming 'image_path' is the path to an image file
nsfw_prediction = nswf_classifier.predict(image_path='path/to/image.jpg')
```

--------------------------------

### NeMo Framework Fundamentals and Tutorials

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/quickstart

Guides for understanding the core concepts of the NeMo Framework and following practical tutorials.

```APIDOC
Fundamentals and Tutorials:
  - NeMo Fundamentals: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/starthere/fundamentals.html
  - Tutorials: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemotoolkit/starthere/tutorials.html
```

--------------------------------

### NeMo 2.0 Experimental Feature

Source: https://docs.nvidia.com/nemo-framework/user-guide/24.07/nemotoolkit/common/intro

Information on the experimental NeMo 2.0 feature, available in the dev container, with a link to an overview and getting started guide.

```APIDOC
NeMo 2.0:
  - Experimental feature available in the dev container.
  - Dev Container Image: nvcr.io/nvidia/nemo:dev
  - Overview and Getting Started: https://docs.nvidia.com/nemo-framework/user-guide/24.07/nemo-2.0/index.html#nemo-2-overview
```

--------------------------------

### Nemotron 3 4B Pretraining Recipe

Source: https://docs.nvidia.com/nemo-framework/user-guide/25.02/nemo-2.0/quickstart

Example of a pretraining recipe for the Nemotron 3 4B model, used in the NeMo-Run quickstart.

```Python
import nemo.collections.llm.recipes

# Example usage (conceptual, actual recipe is a script)
# nemo.collections.llm.recipes.nemotron3_4b.py
```
Tokens:
Raw