-
Notifications
You must be signed in to change notification settings - Fork 20
fix: address review feedback for submit-only migration #1383
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,7 +7,7 @@ description: "" | |
| --- | ||
| <a id="data-designer-cli"></a> | ||
|
|
||
| The NeMo Data Designer plugin adds the `nemo data-designer` command group. Use it to execute Data Designer workloads locally in the CLI process or submit them to NeMo Services. | ||
| The NeMo Data Designer plugin adds the `nemo data-designer` command group. Use it to submit preview and create workloads to NeMo Services. | ||
|
|
||
| ## Configuration Sources | ||
|
|
||
|
|
@@ -16,6 +16,7 @@ The `preview` and `create` commands accept a configuration source path. The most | |
| ```python | ||
| import data_designer.config as dd | ||
|
|
||
|
|
||
| def load_config_builder() -> dd.DataDesignerConfigBuilder: | ||
| model_configs = [ | ||
| dd.ModelConfig( | ||
|
|
@@ -30,41 +31,17 @@ def load_config_builder() -> dd.DataDesignerConfigBuilder: | |
| return config_builder | ||
| ``` | ||
|
|
||
| The same configuration source can usually be used with `run` or `submit`. Resource choices determine whether it is compatible with NeMo Services execution; see [Execution Modes](/documentation/design-synthetic-data/execution-modes). | ||
|
|
||
| ## Run Versus Submit | ||
| The same configuration source is used with `submit`. Resource choices determine whether it is compatible with NeMo Services execution; see [Execution Modes](/documentation/design-synthetic-data/execution-modes). | ||
|
|
||
| `run` executes the Data Designer workload locally, in the CLI process. This can be fully local, but it is not an offline-only mode. A local run can still use the Files API, Secrets API, and Inference Gateway API from a running NeMo Services cluster when the configuration references the corresponding resources. | ||
| ## Submit Versus Platform Execution | ||
|
Comment on lines
+34
to
+36
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These don't make sense semantically |
||
|
|
||
| `submit` sends the workload to NeMo Services. The Data Designer API and Jobs API coordinate execution, job lifecycle, logs, and artifact persistence. The NeMo Services deployment may itself be local or remote. | ||
|
|
||
| | Command | Workload execution | NeMo Services required? | | ||
| |---------|--------------------|-------------------------| | ||
| | `preview submit` | Local CLI process | Optional | | ||
| | `create submit` | Local CLI process | Optional | | ||
|
Comment on lines
-43
to
-44
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. lol at this table as it exists on the target branch, just totally borked. But also this entire table is pointless now, since the platform services (again that "NeMo Services" noun!) are always required. |
||
| | `preview submit` | Data Designer API | Yes | | ||
| | `create submit` | Jobs worker | Yes | | ||
|
|
||
| ## Preview Locally | ||
|
|
||
| Use local preview for fast iteration: | ||
|
|
||
| ```bash | ||
| nemo data-designer preview submit product_reviews.py --num-records 5 | ||
| ``` | ||
|
|
||
| The workload runs in your current Python environment. It can use local-only resources, NeMo resources, or both. | ||
|
|
||
| ## Create Locally | ||
|
|
||
| Use local create when you want to generate a larger dataset without submitting work to NeMo Services: | ||
|
|
||
| ```bash | ||
| nemo data-designer create submit product_reviews.py --num-records 1000 | ||
| ``` | ||
|
|
||
| This executes the plugin job locally. It is useful for development and for workloads that should stay in the local environment. | ||
|
|
||
| ## Submit Preview to NeMo Services | ||
|
|
||
| Submit preview when you want to exercise the Data Designer API path: | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably makes more sense something like...
(Side note, I see "NeMo Services" already exists... is that a legit proper noun?)