Elgato_dark/DataDesigner
1
0
Fork 0
mirror of https://github.com/NVIDIA-NeMo/DataDesigner synced 2026-05-24 09:48:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
DataDesigner/docs/code_reference/engine/seed_readers.md

102 lines
3.5 KiB
Markdown
Raw Normal View History

docs: graduate plugins out of experimental mode (#603) * chore: add __init__.py to engine namespace subpackages Griffe (used by mkdocstrings) skips directories without __init__.py when resolving module paths, which prevented the new plugins code reference from rendering SeedReader, FileSystemSeedReader, and Processor. Adding empty __init__.py files in engine/resources/, engine/processing/, and engine/processing/processors/ aligns with the convention already used in engine/mcp/, engine/models/, etc. * docs: flesh out docstrings on plugin extension-point classes Plugin authors now see meaningful descriptions for every field and method on the bases rendered in the plugins code reference: - Plugin and PluginType: class docstrings + Attributes tables for fields and enum members; fix typo in config_qualified_name field description. - SingleColumnConfig: document allow_resize. - ProcessorConfig: document processor_type discriminator. - SeedSource: document seed_type discriminator. - FileSystemSeedSource: add class docstring + Attributes table for path / file_pattern / recursive. - ColumnGeneratorFullColumn and ColumnGeneratorCellByCell: add class docstrings explaining when to use each base, plus method docstrings on the abstract generate() implementations. * docs: graduate plugins out of experimental mode Restructures plugin documentation around the now-stable extension points (column generator, seed reader, processor) and treats plugins as a first-class story for customizing Data Designer. - Add code_reference/plugins.md: single-stop reference for the Plugin object and the config + implementation base classes used by all three plugin types. - Add code_reference/generators.md: column generator implementation base classes, separated from column configs. - Surface SingleColumnConfig in code_reference/column_configs.md. - Add plugins/implement.md ("Build Your Own"): per-type implementation instructions across column generators, seed readers, and processors. - Add plugins/processor.md: complete processor plugin package example. - Rewrite plugins/overview.md: open with why plugins exist, drop the internal-helpers note (PluginRegistry / PluginManager), and focus the guide on what plugin builders need. - Refresh plugins/available.md (Catalog) and plugins/filesystem_seed_reader.md to match the new structure. - Delete plugins/example.md (replaced by per-type guides). - Reorder Code Reference nav alphabetically and add the new pages. - Minor link / wording fixes in concepts/processors.md and concepts/deployment-options.md. * docs: simplify plugin docs structure Replace the overview's how-to walkthrough and the per-type plugin guides with a single Build Your Own page that covers all three plugin types side-by-side. Add a dedicated Using Models in Plugins guide and a seed_readers code reference, and trim the overview down to what the plugin types are, how to use one, and how discovery works. - Rename plugins/implement.md to plugins/build_your_own.md. - Delete plugins/filesystem_seed_reader.md and plugins/processor.md (their content is now in build_your_own.md and the per-type code references). - Add plugins/models.md for model-backed column generator authoring. - Add code_reference/seed_readers.md for seed reader implementation base classes. - Rewrite plugins/overview.md: shorter intro, type bullets link to the relevant code reference, drop the multi-step "How do you create plugins" walkthrough in favor of a single Build a Plugin pointer, tighten Discovery troubleshooting. - Refresh plugins/available.md (Available Plugins): point to the DataDesignerPlugins catalog and explain how to request a community listing. - Update cross-page links in concepts/processors.md, concepts/seed-datasets.md, recipes/plugin_development/markdown_seed_reader.md, code_reference/plugins.md, and code_reference/generators.md to match the new structure. - Update mkdocs.yml nav: rename to Build Your Own, add Using Models, add seed_readers code reference. * docs: scroll wide tables horizontally instead of wrapping Code-heavy reference tables (plugin bases, column generators, etc.) were wrapping aggressively on narrow viewports, breaking long identifiers across multiple lines. Switch the table container to horizontal overflow and prevent code cells from wrapping so identifiers stay readable. * docs: address PR #603 review feedback - Add an Implementation base section to code_reference/processors.md rendering the engine-side Processor class. This justifies the engine/processing/__init__.py files added earlier and gives processor plugin authors an auto-rendered API reference, matching the pattern used by code_reference/generators.md and seed_readers.md. - build_your_own.md: replace the placeholder "x" emoji on the IndexMultiplier example with the actual multiplication sign. - build_your_own.md: drop the manual `re.compile + apply(lambda)` pattern in the regex-filter processor in favor of the idiomatic `Series.str.contains(..., regex=True)`. - build_your_own.md: add a kernel-restart caveat after the editable install instructions — PluginRegistry caches discovery on first import, so notebooks need a fresh kernel to pick up freshly installed plugins. - build_your_own.md: state explicitly what `assert_valid_plugin` checks (config base + plugin-type-appropriate impl base). - code_reference/plugins.md: link out to the processors code reference alongside generators and seed_readers. * docs: split code reference by package * docs: add interface code reference * docs: add code reference overviews * docs: refine code reference pages * docs: improve code reference tables * docs: correct reference docstrings * docs: embed plugin catalog table * docs: note plugin discovery restart caveat * docs: explain generator base class choice * docs: mention async cell generator examples * docs: clarify plugin model usage * docs: clarify plugin model aliases * docs: address plugin review feedback * docs: update available plugins page
2026-05-06 22:12:44 +00:00
# Seed Readers
Seed readers are engine-side adapters that turn a configured seed source into tabular seed rows. The engine attaches a `SeedSource` and secret resolver, asks the reader for column names and dataset size, then streams batches into generation.
Related pages: [seeds](../config/seeds.md), [Seed Datasets](../../concepts/seed-datasets.md), and [Build Your Own](../../plugins/build_your_own.md).
## Core Contracts
### `SeedReader` {#data_designer.engine.resources.seed_reader.SeedReader}
::: data_designer.engine.resources.seed_reader.SeedReader
options:
show_root_toc_entry: false
### `FileSystemSeedReader` {#data_designer.engine.resources.seed_reader.FileSystemSeedReader}
::: data_designer.engine.resources.seed_reader.FileSystemSeedReader
options:
show_root_toc_entry: false
### `SeedReaderFileSystemContext` {#data_designer.engine.resources.seed_reader.SeedReaderFileSystemContext}
::: data_designer.engine.resources.seed_reader.SeedReaderFileSystemContext
options:
show_root_toc_entry: false
### `SeedReaderBatch` {#data_designer.engine.resources.seed_reader.SeedReaderBatch}
::: data_designer.engine.resources.seed_reader.SeedReaderBatch
options:
show_root_toc_entry: false
### `SeedReaderBatchReader` {#data_designer.engine.resources.seed_reader.SeedReaderBatchReader}
::: data_designer.engine.resources.seed_reader.SeedReaderBatchReader
options:
show_root_toc_entry: false
### `PandasSeedReaderBatch` {#data_designer.engine.resources.seed_reader.PandasSeedReaderBatch}
::: data_designer.engine.resources.seed_reader.PandasSeedReaderBatch
options:
show_root_toc_entry: false
### `create_seed_reader_output_dataframe` {#data_designer.engine.resources.seed_reader.create_seed_reader_output_dataframe}
::: data_designer.engine.resources.seed_reader.create_seed_reader_output_dataframe
options:
show_root_toc_entry: false
## Built-In Readers
### `LocalFileSeedReader` {#data_designer.engine.resources.seed_reader.LocalFileSeedReader}
::: data_designer.engine.resources.seed_reader.LocalFileSeedReader
options:
show_root_toc_entry: false
### `HuggingFaceSeedReader` {#data_designer.engine.resources.seed_reader.HuggingFaceSeedReader}
::: data_designer.engine.resources.seed_reader.HuggingFaceSeedReader
options:
show_root_toc_entry: false
### `DataFrameSeedReader` {#data_designer.engine.resources.seed_reader.DataFrameSeedReader}
::: data_designer.engine.resources.seed_reader.DataFrameSeedReader
options:
show_root_toc_entry: false
### `DirectorySeedReader` {#data_designer.engine.resources.seed_reader.DirectorySeedReader}
::: data_designer.engine.resources.seed_reader.DirectorySeedReader
options:
show_root_toc_entry: false
### `FileContentsSeedReader` {#data_designer.engine.resources.seed_reader.FileContentsSeedReader}
::: data_designer.engine.resources.seed_reader.FileContentsSeedReader
options:
show_root_toc_entry: false
### `AgentRolloutSeedReader` {#data_designer.engine.resources.seed_reader.AgentRolloutSeedReader}
::: data_designer.engine.resources.seed_reader.AgentRolloutSeedReader
options:
show_root_toc_entry: false
## Registry and Errors
### `SeedReaderRegistry` {#data_designer.engine.resources.seed_reader.SeedReaderRegistry}
::: data_designer.engine.resources.seed_reader.SeedReaderRegistry
options:
show_root_toc_entry: false
### `SeedReaderError` {#data_designer.engine.resources.seed_reader.SeedReaderError}
::: data_designer.engine.resources.seed_reader.SeedReaderError
options:
show_root_toc_entry: false
Reference in a new issue Copy permalink