Skip to content

Commit dbe99dd

Browse files
committed
made minor modifications to README
1 parent 139849d commit dbe99dd

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

nemo/NeMo-Data-Designer/README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,25 @@
22

33
This directory contains the tutorial notebooks for getting started with NeMo Data Designer.
44

5-
## 🐳 Deploy the NeMo Data Designer microservice locally
5+
## 🚀 Deploying the NeMo Data Designer Microservice
66

7-
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.
7+
To run these notebooks, you'll need the NeMo Data Designer microservice. You have two deployment options:
88

9-
## 📦 Set up the environment
9+
### ⚙️ Using the NeMo Data Designer Managed Service
10+
We have a [managed service of NeMo Data Designer](https://build.nvidia.com/nemo/data-designer) to help you get started quickly.
11+
12+
Please refer to the [intro-tutorials](./intro-tutorials/) notebooks to learn how to connect to this service.
13+
14+
**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)
15+
16+
17+
### 🐳 Deploy the NeMo Data Designer Microservice Locally
18+
19+
Alternatively, you can deploy the NeMo Data Designer microservice locally via Docker Compose.
20+
21+
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.
22+
23+
## 📦 Set Up the Environment
1024

1125
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/).
1226

nemo/NeMo-Data-Designer/intro-tutorials/3-seeding-with-a-dataset.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
"source": [
8383
"data_designer_client = DataDesignerClient(\n",
8484
" client=NeMoMicroservices(\n",
85-
" base_url=\"https://ai.api.nvidia.com/v1/stg/nemo/dd\",\n",
85+
" base_url=\"https://ai.api.nvidia.com/v1/nemo/dd\",\n",
8686
" default_headers={\"Authorization\": f\"Bearer {api_key}\"} # auto-generated API KEY\n",
8787
" )\n",
8888
")"

0 commit comments

Comments
 (0)