Merge pull request #345 from raosukrit67/main

Porting Legacy Notebooks to NeMo Microservices v25.09 Design Spec

Author: kirit93

nemo/NeMo-Data-Designer/README.md

@@ -2,11 +2,7 @@
 
 This directory contains the tutorial notebooks for getting started with NeMo Data Designer.
 
-## 🐳 Deploy the NeMo Data Designer microservice locally
-
-In order to run these notebooks, you must have the NeMo Data Designer microservice deployed locally via docker compose. See the [deployment guide](http://docs.nvidia.com/nemo/microservices/latest/set-up/deploy-as-microservices/data-designer/docker-compose.html) for more details.
-
-## 📦 Set up the environment
+## 📦 Set Up the Environment
 
 We will use the `uv` package manager to set up our environment and install the necessary dependencies. If you don't have `uv` installed, you can follow the installation instructions from the [uv documentation](https://docs.astral.sh/uv/getting-started/installation/).
 
@@ -23,3 +19,51 @@ source .venv/bin/activate
 ```
 
 Be sure to select this virtual environment as your kernel when running the notebooks.
+
+## 🚀 Deploying the NeMo Data Designer Microservice
+
+To run these notebooks, you'll need the NeMo Data Designer microservice. You have two deployment options:
+
+### ⚙️ Using the NeMo Data Designer Managed Service
+We have a [managed service of NeMo Data Designer](https://build.nvidia.com/nemo/data-designer) to help you get started quickly.
+
+Please refer to the [intro-tutorials](./intro-tutorials/) notebooks to learn how to connect to this service.
+
+**Note**: This managed service of NeMo Data Designer is intended to only help you get started. As a result, it can only be used to launch `preview` jobs. It can **not** be used to launch long running jobs. If you need to launch long-running jobs please deploy an instance of [NeMo Data Designer locally](#-deploy-the-nemo-data-designer-microservice-locally)
+
+
+### 🐳 Deploy the NeMo Data Designer Microservice Locally
+
+Alternatively, you can deploy the NeMo Data Designer microservice locally via Docker Compose.
+
+To run the tutorial notebooks in the [advanced](./advanced/), you will need to have NeMo Data Designer deployed locally. Please see the [deployment guide](http://docs.nvidia.com/nemo/microservices/latest/set-up/deploy-as-microservices/data-designer/docker-compose.html) for more details.
+
+
+## 📚 Tutorial Directory
+
+### 🚀 Intro Tutorials
+
+| Notebook                                          | Description                                                                      |
+|---------------------------------------------------|----------------------------------------------------------------------------------|
+| [1-the-basics.ipynb](./intro-tutorials/1-the-basics.ipynb) | Learn the basics of Data Designer by generating a simple product review dataset |
+| [2-structured-outputs-and-jinja-expressions.ipynb](./intro-tutorials/2-structured-outputs-and-jinja-expressions.ipynb) | Explore advanced data generation using structured outputs and Jinja expressions |
+| [3-seeding-with-a-dataset.ipynb](./intro-tutorials/3-seeding-with-a-dataset.ipynb) | Discover how to seed synthetic data generation with an external dataset         |
+| [4-custom-model-configs.ipynb](./intro-tutorials/4-custom-model-configs.ipynb) | Master creating and using custom model configurations                           |
+
+### 🎯 Advanced Tutorials
+
+| Notebook                                          | Domain              | Description                                                     |
+|---------------------------------------------------|---------------------|-----------------------------------------------------------------|
+| [person-sampler-tutorial.ipynb](./advanced/person-samplers/person-sampler-tutorial.ipynb) | Persona Samplers    | Generate realistic personas using the person sampler |
+| [clinical-trials.ipynb](./advanced/healthcare-datasets/clinical-trials.ipynb) | Healthcare          | Build synthetic clinical trial datasets with realistic PII for testing data protection |
+| [insurance-claims.ipynb](./advanced/healthcare-datasets/insurance-claims.ipynb) | Healthcare          | Create synthetic insurance claims datasets with realistic claim data and processing information |
+| [physician-notes-with-realistic-personal-details.ipynb](./advanced/healthcare-datasets/physician-notes-with-realistic-personal-details.ipynb) | Healthcare          | Generate realistic patient data and physician notes with embedded personal information |
+| [w2-dataset.ipynb](./advanced/forms/w2-dataset.ipynb) | Forms & Documents   | Generate synthetic W-2 tax form datasets with realistic employee and employer information |
+| [multi-turn-conversation.ipynb](./advanced/multi-turn-chat/multi-turn-conversation.ipynb) | Conversational AI   | Build synthetic conversational data with realistic person details and multi-turn dialogues |
+| [visual-question-answering-using-vlm.ipynb](./advanced/multimodal/visual-question-answering-using-vlm.ipynb) | Multimodal          | Create visual question answering datasets using Vision Language Models |
+| [product-question-answer-generator.ipynb](./advanced/qa-generation/product-question-answer-generator.ipynb) | Q&A Generation      | Build product information datasets with corresponding questions and answers |
+| [generate-rag-evaluation-dataset.ipynb](./advanced/rag-examples/generate-rag-evaluation-dataset.ipynb) | RAG & Retrieval     | Generate diverse RAG evaluation datasets for testing retrieval-augmented generation systems |
+| [reasoning-traces.ipynb](./advanced/reasoning/reasoning-traces.ipynb) | Reasoning           | Build synthetic reasoning traces to demonstrate step-by-step problem-solving processes |
+| [text-to-python.ipynb](./advanced/text-to-code/text-to-python.ipynb) | Text-to-Code        | Generate Python code from natural language instructions with validation and evaluation |
+| [text-to-python-evol.ipynb](./advanced/text-to-code/text-to-python-evol.ipynb) | Text-to-Code        | Build advanced Python code generation with evolutionary improvements and iterative refinement |
+| [text-to-sql.ipynb](./advanced/text-to-code/text-to-sql.ipynb) | Text-to-Code        | Create SQL queries from natural language descriptions with validation and testing |