Skip to content

Commit 378acb4

Browse files
committed
address feedback
1 parent 44b8860 commit 378acb4

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/plugins/example.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
!!! warning "Experimental Feature"
2-
The plugin system is currently **experimental** and under active development. The documentation, examples, and plugin interface are subject to significant changes in future releases. If you encounter any issues, have questions, or have ideas for improvement, please [open an issue on GitHub](https://github.com/NVIDIA-NeMo/DataDesigner/issues/new/choose).
2+
The plugin system is currently **experimental** and under active development. The documentation, examples, and plugin interface are subject to significant changes in future releases. If you encounter any issues, have questions, or have ideas for improvement, please consider starting [a discussion on GitHub](https://github.com/NVIDIA-NeMo/DataDesigner/discussions).
33

44

55
# Example Plugin: Index Multiplier
@@ -109,17 +109,17 @@ class IndexMultiplierColumnGenerator(ColumnGenerator[IndexMultiplierColumnConfig
109109
- Generic type `ColumnGenerator[IndexMultiplierColumnConfig]` connects the task to its config
110110
- `metadata()` describes your generator and its requirements
111111
- `generation_strategy` can be `FULL_COLUMN`, `CELL_BY_CELL`
112-
- `required_resources` lists any required resources (models, artifact storage, etc.). This parameter will change in the future, so keeping it as `None` is safe for now.
113-
- Access configuration parameters via `self.config`
112+
- You have access to the configuration parameters via `self.config`
113+
- `required_resources` lists any required resources (models, artifact storages, etc.). This parameter will evolve in the near future, so keeping it as `None` is safe for now. That said, if your task will use the model registry, adding `data_designer.engine.resources.ResourceType.MODEL_REGISTRY` will enable automatic model health checking for your column generation task.
114114

115115
!!! info "Understanding generation_strategy"
116116
The `generation_strategy` specifies how the column generator will generate data.
117117

118-
- **`FULL_COLUMN`**: Generates the entire column at once
119-
- `generate` must take a `pd.DataFrame` as input and return a `pd.DataFrame`
118+
- **`FULL_COLUMN`**: Generates the full column (at the batch level) in a single call to `generate`
119+
- `generate` must take as input a `pd.DataFrame` with all previous columns and return a `pd.DataFrame` with the generated column appended
120120

121121
- **`CELL_BY_CELL`**: Generates one cell at a time
122-
- `generate` must take a `dict` as input and return a `dict`
122+
- `generate` must take as input a `dict` with key/value pairs for all previous columns and return a `dict` with an additional key/value for the generated cell
123123
- Supports concurrent workers via a `max_parallel_requests` parameter on the configuration
124124

125125
## Step 4: Create the plugin object

docs/plugins/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Data Designer Plugins
22

33
!!! warning "Experimental Feature"
4-
The plugin system is currently **experimental** and under active development. The documentation, examples, and plugin interface are subject to significant changes in future releases. If you encounter any issues, have questions, or have ideas for improvement, please [open an issue on GitHub](https://github.com/NVIDIA-NeMo/DataDesigner/issues/new/choose).
4+
The plugin system is currently **experimental** and under active development. The documentation, examples, and plugin interface are subject to significant changes in future releases. If you encounter any issues, have questions, or have ideas for improvement, please consider starting [a discussion on GitHub](https://github.com/NVIDIA-NeMo/DataDesigner/discussions).
55

66
## What are plugins?
77

0 commit comments

Comments
 (0)