NVIDIA / workbench-example-nemotron-finetune

An NVIDIA AI Workbench example project for fine-tuning a Nemotron-3 8B model

NVIDIA AI Workbench: Introduction

This is an NVIDIA AI Workbench example project that demonstrates how to fine-tune a Nemotron-3 8B large language model (LLM) on a custom dataset in minutes using NVIDIA NeMo Framework. Please note the project requirements:

• Operating System: Ubuntu 22.04, Windows (WSL2), MacOS 12+
• CPU requirements: None, (tested with Intel® Xeon® Platinum 8380 CPU @ 2.30GHz)
• GPU requirements: Minimum 1x NVIDIA A100-80GB

Sizing Guide

GPU VRAM	Example Hardware	Compatible?
24 GB	RTX 3090/4090, RTX A5000/5500, A10/30	N
32 GB	RTX 5000 Ada	N
40 GB	A100-40GB	N
48 GB	RTX 6000 Ada, L40/L40S, A40	N
80 GB	A100-80GB	Y
>80 GB	8x A100-80GB	Y

Project Description

Nemotron-3 is a robust, powerful family of Large Language Models that can provide compelling responses on a wide range of tasks. While the 8B parameter base model serves as a strong baseline for multiple downstream tasks, they can lack in domain-specific knowledge or proprietary or otherwise sensitive information. Fine-tuning is often used as a means to update a model for a specific task or tasks to better respond to domain-specific prompts. These notebooks walk through downloading the Nemotron-3 model from HuggingFace, preparing a custom dataset, and fine-tuning the pretrained base model against this new dataset.

• nemotron-lora.ipynb: This notebook provides a sample workflow for fine-tuning the Nemotron base model for extractive Question-Answering on the SQuAD dataset using Low-Rank Adaptation Fine-tuning (LoRA), a popular parameter-efficient fine-tuning method.

• nemotron-ptuning.ipynb: This notebook provides a sample workflow for fine-tuning the Nemotron base model for extractive Question-Answering on a custom dataset using customized prompt formattings and a p-tuning method.

If you are interested in trying out another model with NeMo Framework, check out this AI Workbench example project for Llama 2.

Quickstart

Prerequisites

1. AI Workbench will prompt you to provide a few pieces of information before running any apps in this project. Ensure you have this information ready.

   • The location where you would like the Nemotron model to live on the underlying host system.
   • The Hugging Face username.
   • The Hugging Face API Key.

Tutorial (Desktop App)

If you do not NVIDIA AI Workbench installed, first complete the installation for AI Workbench here.. Then,

1. Fork this Project to your own GitHub namespace and copy the link

   https://github.com/[your_namespace]/<project_name>
   

2. Open NVIDIA AI Workbench. Select a location to work in.

3. Clone this Project onto your desired machine by selecting "Clone Project" and providing the GitHub link.

4. Wait for the project to build.

5. When the build completes, set the following configurations.

   • Environment → Mounts → Configure. Specify the file path of the mount, eg. where the Nemotron model will live on your host machine.

     eg. if your downloaded Nemotron model directory resides in your home path, enter /home/[user]

   • Environment → Secrets → Configure. Specify the Hugging Face username and API Key secrets.

6. On the top right of the window, select Jupyterlab.

7. Navigate to the code/notebooks directory of the project. Then, open your fine-tuning notebook of choice and get started. Happy coding!

Tutorial (CLI-Only)

Some users may choose to use the CLI tool only instead of the Desktop App. If you do not NVIDIA AI Workbench installed, first complete the installation for AI Workbench here. Then,

1. Fork this Project to your own GitHub namespace and copying the link

   https://github.com/[your_namespace]/<project_name>
   

2. Open a shell and activating the Context you want to clone into by

   $ nvwb list contexts
   
   $ nvwb activate <desired_context>
   

3. Clone this Project onto your desired machine by running

   $ nvwb clone project <your_project_link>
   

4. Open the Project by

   $ nvwb list projects
   
   $ nvwb open <project_name>
   

5. Start Jupyterlab by

   $ nvwb start jupyterlab
   

   • Specify the file path of the mount, eg. where the Nemotron model will live on your host machine.

     eg. if your downloaded Nemotron model directory resides in your home path, enter /home/[user]

   • Specify the Hugging Face username and API Key secrets.

6. Navigate to the code/notebooks directory of the project. Then, open your fine-tuning notebook of choice and get started. Happy coding!

---

Tip: Use nvwb help to see a full list of NVIDIA AI Workbench commands.

---

Tested On

This notebook has been tested with a 1x NVIDIA A100-80gb GPU system and the GA version of NVIDIA AI Workbench: nvwb 0.21.3 (internal; linux; amd64; go1.21.3; Tue Mar 5 03:55:43 UTC 2024)

License

This NVIDIA AI Workbench example project is under the Apache 2.0 License

This project may utilize additional third-party open source software projects. Review the license terms of these open source projects before use. Third party components used as part of this project are subject to their separate legal notices or terms that accompany the components. You are responsible for confirming compliance with third-party component license terms and requirements.

Have questions? Please direct any issues, fixes, suggestions, and discussion on this project to the DevZone Members Only Forum thread here.