-
Notifications
You must be signed in to change notification settings - Fork 193
docs: dev note for workflow chaining #775
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
Open
andreatgretel
wants to merge
3
commits into
main
Choose a base branch
from
andreatgretel/docs/hitl-document-extraction
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,250
β9
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
825 changes: 825 additions & 0 deletions
825
docs/assets/recipes/workflow_chaining/document_review_gate.py
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
237 changes: 237 additions & 0 deletions
237
fern/versions/latest/pages/devnotes/posts/annotate-hard-pages-review-gates.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,237 @@ | ||
| --- | ||
| title: "Pause, Inspect, Resume: Workflow Chaining as a Control Surface" | ||
| description: "" | ||
| --- | ||
|
|
||
| import { Authors } from "@/components/Authors"; | ||
|
|
||
| <Authors ids={["amanoel"]} /> | ||
|
|
||
| One of the traps in synthetic data generation is treating the run as the unit of work. The button goes green, a dataset appears, and the system looks finished. | ||
|
|
||
| Real pipelines are rarely that tidy. The interesting moment often happens halfway through: an evaluator finds a risky slice, a reviewer needs to fix a small subset, a team wants to compare two downstream strategies, or an expensive upstream stage should not be replayed just because the last step changed. | ||
|
|
||
| Running two separate Data Designer workflows can pass one dataset into another, but the caller owns the handoff: selecting and persisting the output, loading it as the next seed, correlating the artifacts, and deciding what can be reused. The pipeline has a checkpoint in practice, but Data Designer does not know how to operate around it. | ||
|
|
||
| Workflow chaining is the control surface for those moments. It lets a Data Designer workflow pause at a named stage, export the stage output as a durable artifact, allow something outside the workflow to inspect or replace that artifact, and then resume downstream from the replacement. | ||
|
|
||
|  | ||
|
|
||
| {/* more */} | ||
|
|
||
| ## Workflow Chaining In One Minute | ||
|
|
||
| A workflow chain is a sequence of named stages. Each stage is still an ordinary Data Designer config: it can generate columns, run processors, write artifacts, and choose which output becomes the seed dataset for the next stage. | ||
|
|
||
| The new part is the boundary. Because the boundary has a name, you can stop there, inspect the selected output, replace it with an approved artifact, and resume downstream without rerunning the trusted upstream work. | ||
|
|
||
| ```python | ||
| import data_designer.config as dd | ||
|
|
||
| workflow = data_designer.compose_workflow(name="quality-gated-candidates") | ||
| workflow.add_stage("draft_rows", draft_rows_builder, num_records=1_000) | ||
| workflow.add_stage("quality_gate", quality_gate_builder) | ||
| workflow.add_stage("final_dataset", final_dataset_builder) | ||
|
|
||
| checkpoint = workflow.run(targets="quality_gate") | ||
| checkpoint.export_stage("quality_gate", "quality_gate.parquet") | ||
|
|
||
| results = workflow.run( | ||
| resume=dd.ResumeMode.ALWAYS, | ||
| stage_output_overrides={ | ||
| "quality_gate": "approved_output.parquet", | ||
| }, | ||
| ) | ||
| ``` | ||
|
|
||
| In that shape, `quality_gate` is both a normal stage and a contract. Upstream work promises a schema. Downstream work consumes that schema. A reviewer, evaluator, dashboard, or cleanup script only has to preserve the contract. | ||
|
|
||
|  | ||
|
|
||
| ### Why Not Just Run Two Workflows? | ||
|
|
||
| Two independent workflows can reproduce the happy path: export from one, then load the result as the seed for the next. Workflow chaining does not make that data transformation newly possible. It makes the relationship operationally first-class. | ||
|
|
||
| | Two independent workflows | One workflow chain | | ||
| | --- | --- | | ||
| | Caller selects, persists, loads, and passes the intermediate output | The stage declares its selected output, and the chain seeds the next stage | | ||
| | Caller correlates separate configs and artifact directories | Workflow metadata records stage order, configs, selected outputs, statuses, and fingerprints | | ||
| | Stop, replace, and restart behavior is custom orchestration | `targets`, `resume`, `rerun_from`, and `stage_output_overrides` provide one pause/inspect/replace/resume path | | ||
| | Reuse and invalidation rules live in application code | Compatible completed stages are reused, while changed stages invalidate downstream work | | ||
|
|
||
| The advantage is not fewer generation calls. It is that Data Designer understands those calls as stages of one workflow, so it can manage the handoff and retain the information needed to resume or audit it. Separate workflows remain useful when they do not share an execution lifecycle. | ||
|
|
||
| ## The Story | ||
|
|
||
| Picture a long generation workflow that starts with source data, proposes labels, scores quality, repairs weak examples, and writes a final training dataset. The early stages are expensive and deterministic enough to trust once they finish. The later stages are where judgment enters. | ||
|
|
||
| Maybe the quality scorer says 25 percent of rows need human eyes. Maybe a policy evaluator says one cluster should be removed. Maybe the team wants to try two cleanup strategies against the same upstream candidates. In each case, the useful operation is not "rerun the whole pipeline." It is: | ||
|
|
||
| 1. Stop at the boundary. | ||
| 2. Look at the boundary artifact. | ||
| 3. Change or approve it. | ||
| 4. Resume from there. | ||
|
|
||
| That is one workflow-chaining pattern. | ||
|
|
||
| The stage name becomes a contract. Upstream work produces a dataset with a known schema. Downstream work consumes that schema. Anything in between can participate as long as it preserves the contract. | ||
|
|
||
| ## What It Enables | ||
|
|
||
| Human-in-the-loop review is the easiest pattern to recognize, but it is not the only one. The same boundary mechanism makes several operational moves feel native: | ||
|
|
||
| | Pattern | What changes at the boundary | | ||
| | --- | --- | | ||
| | Human review | A reviewer edits only rows selected by uncertainty or policy | | ||
| | Evaluation gate | A judge score decides which rows continue | | ||
| | Cleanup pass | A separate tool normalizes or removes rows before resume | | ||
| | A/B comparison | Two downstream branches resume from the same upstream output | | ||
| | Cost control | Expensive upstream generations are reused across experiments | | ||
| | Team handoff | One person exports a stage; another resumes from it | | ||
|
|
||
| The value is not only that these things are possible. Two workflows and glue code can reproduce the happy path. Chaining gives Data Designer enough context to name the handoff, track it, and resume from it consistently. | ||
|
|
||
| For fully automated, per-row routing, [conditional generation](/tutorials/structured-outputs-jinja-expressions-and-conditional-generation) is simpler: `skip=dd.SkipConfig(when="{{ not selected_for_review }}")` can run a downstream column only for rows chosen by an earlier score, all within one stage. It does not pause the workflow or expose a replaceable artifact. Use workflow chaining when a human or external system must inspect or change the data, or when the checkpoint needs to be resumed, reused, or audited. | ||
|
|
||
| ## A Review Gate Example | ||
|
|
||
| The demo task is document field extraction: generate synthetic invoices and forms, propose boxes around the fields to extract, and turn those boxes into structured rows. A weak detector proposes boxes on each page and assigns uncertainty. The workflow pauses at `review_candidates`, where all rows are still present but only the uncertain rows are marked for review. | ||
|
|
||
| The reviewer corrects the proposed boxes for that uncertain slice. They do not relabel the whole dataset, and they do not change the workflow shape. They write a replacement artifact with the same row count and schema, then the downstream stages use human-corrected boxes where they exist and calibrated detector boxes everywhere else. | ||
|
andreatgretel marked this conversation as resolved.
|
||
|
|
||
|  | ||
|
|
||
| The implementation is deliberately ordinary Data Designer. The review gate is a custom column that proposes boxes, scores uncertainty, and marks the rows that should leave the automated path for a moment. This snippet is simplified for readability; the downloadable recipe implements the same steps inline. | ||
|
|
||
| ```python | ||
| @dd.custom_column_generator( | ||
| required_columns=["page_id", "image_path", "ground_truth_boxes"], | ||
| side_effect_columns=["box_confidences", "uncertainty", "selected_for_review", "human_boxes"], | ||
| ) | ||
| def select_review_candidates(df: pd.DataFrame, generator_params: ReviewSelectionParams) -> pd.DataFrame: | ||
| df = df.copy() | ||
| df["proposed_boxes"] = propose_boxes(df, jitter_px=generator_params.jitter_px) | ||
| df["uncertainty"] = score_uncertainty(df["proposed_boxes"]) | ||
| df["selected_for_review"] = pick_highest_uncertainty(df, limit=generator_params.max_review_pages) | ||
| df["human_boxes"] = "[]" | ||
| return df | ||
| ``` | ||
|
|
||
| In the demo, the "classifier" is a small calibration profile learned from reviewed rows. In a real pipeline, this stage could train a classifier, fit thresholds, update prompts, or build a routing policy. The important thing is that it is still just a downstream custom column consuming the reviewed artifact: | ||
|
|
||
| ```python | ||
| @dd.custom_column_generator( | ||
| required_columns=["human_boxes", "proposed_boxes", "selected_for_review"], | ||
| ) | ||
| def calibrate_from_reviewed_boxes(df: pd.DataFrame, generator_params: CalibrationParams) -> pd.DataFrame: | ||
| profile = fit_calibration_profile(rows_with_human_boxes(df), generator_params) | ||
| df["calibration_profile"] = json.dumps(profile) | ||
| return df | ||
|
|
||
|
|
||
| @dd.custom_column_generator( | ||
| required_columns=["calibration_profile", "human_boxes", "proposed_boxes", "uncertainty"], | ||
| side_effect_columns=["extraction_confidence", "extraction_source", "final_boxes"], | ||
| ) | ||
| def extract_with_calibrated_boxes(df: pd.DataFrame) -> pd.DataFrame: | ||
| df = df.copy() | ||
| df["final_boxes"] = choose_human_or_calibrated_boxes(df) | ||
| df["extraction_source"] = source_for_each_row(df) | ||
| return df | ||
| ``` | ||
|
|
||
| The workflow wires those custom columns into named stages, so `review_candidates` becomes the pause/resume boundary: | ||
|
|
||
| ```python | ||
| workflow.add_stage("review_candidates", review_candidates_builder()) | ||
| workflow.add_stage("calibrate_extractor", calibration_builder()) | ||
| workflow.add_stage("extract_remaining", extraction_builder()) | ||
| workflow.add_stage("final_dataset", final_dataset_builder()) | ||
| ``` | ||
|
|
||
| Downstream stages do not need a special "review mode." They read the same columns either way: | ||
|
|
||
| | Stage | Role | | ||
| | --- | --- | | ||
| | `document_pages` | Load generated page metadata | | ||
| | `review_candidates` | Propose boxes, score uncertainty, mark review rows | | ||
| | `calibrate_extractor` | Read reviewed rows and build a calibration profile | | ||
| | `extract_remaining` | Use human boxes where present and calibrated boxes elsewhere | | ||
| | `final_dataset` | Emit fields, boxes, confidence, source, and provenance | | ||
|
|
||
| The important detail is that `review_candidates` is not just a dataframe in memory. It is the handoff point. A dashboard, annotation vendor, evaluation job, or cleanup script can all produce the replacement as long as the replacement honors the stage contract. | ||
|
|
||
| ## What Happened In The Demo | ||
|
|
||
| The demo is intentionally small. It measures the workflow mechanics rather than extraction quality: did the boundary concentrate attention, preserve the dataset contract, and resume with traceable provenance? | ||
|
|
||
|  | ||
|
|
||
| For the 12-page run used in the screenshots: | ||
|
|
||
| | Metric | Result | | ||
| | --- | --- | | ||
| | Pages generated | 12 | | ||
| | Pages selected for review | 3 | | ||
| | Manual review budget | 25% of rows | | ||
| | Rows preserved through the reviewed artifact | 12 of 12 | | ||
| | Final `human_review` rows | 3 | | ||
| | Final `calibrated_weak_detector` rows | 9 | | ||
| | Mean confidence for reviewed rows | 0.990 | | ||
| | Mean confidence for resumed detector rows | 0.555 | | ||
|
|
||
| The selected rows were the highest-uncertainty pages: | ||
|
|
||
| | page_id | document_type | uncertainty | | ||
| | --- | --- | --- | | ||
| | synthetic-page-001 | service_form | 0.739 | | ||
| | synthetic-page-005 | service_form | 0.606 | | ||
| | synthetic-page-010 | invoice | 0.597 | | ||
|
|
||
| The final output keeps the source of each row explicit: | ||
|
|
||
|  | ||
|
|
||
| That provenance is the pay-off. Later consumers can distinguish "a person corrected this" from "the calibrated extractor handled this," without needing to know how the review happened. | ||
|
|
||
| ## Why This Matters | ||
|
|
||
| As generation systems get larger, the cost of throwing everything into one run goes up. You lose the ability to stop at a meaningful point, reuse trusted work, compare downstream strategies, or invite a person into the loop without breaking the workflow apart. | ||
|
|
||
| Workflow chaining lets the pipeline stay declarative while the process around it becomes more realistic. A stage can be a checkpoint, an interface, an approval gate, a cache key, or a team handoff. The document example is just one concrete version of that pattern. | ||
|
|
||
| The real feature is not "review these forms." It is "make the middle of the workflow operable." | ||
|
|
||
| ## What Comes Next | ||
|
|
||
| The current workflow-chaining API is intentionally linear: stage A hands a selected output to stage B, then stage B hands a selected output to stage C. That is enough to make review gates, cleanup passes, and cached downstream experiments feel natural. | ||
|
|
||
| The same boundary idea gets more interesting once the workflow shape grows. Planned DAG support would let a workflow fan out into independent evaluators, checks, or downstream experiments, then join their outputs back into a named downstream artifact. The contract stays the same: every edge is still an output that another stage can consume. | ||
|
|
||
|  | ||
|
|
||
| The goal is the same as the review gate: make the workflow's middle visible enough for a reviewer or evaluator to act without breaking the pipeline apart. | ||
|
|
||
| ## Try The Workflow Chain | ||
|
|
||
| The dashboard in this post is a visual review surface for the story. The reusable artifact is a headless recipe that runs the same workflow-chaining pattern: run to a named review stage, write a reviewed artifact, and resume downstream from that artifact. | ||
|
|
||
| Recipe page: [Document Review Gate](/recipes/workflow-chaining/document-review-gate) | ||
|
|
||
| Script: | ||
|
|
||
| ```text | ||
| docs/assets/recipes/workflow_chaining/document_review_gate.py | ||
| ``` | ||
|
|
||
| It writes runtime-generated images, intermediate parquet files, reviewed parquet files, and final outputs under `--artifact-path`. Keep those artifacts out of the repo. From the repo root with the dev environment active: | ||
|
|
||
| ```bash | ||
| .venv/bin/python docs/assets/recipes/workflow_chaining/document_review_gate.py \ | ||
| --artifact-path /tmp/datadesigner-workflow-chaining \ | ||
| --num-records 12 \ | ||
| --overwrite | ||
|
|
||
| .venv/bin/pytest packages/data-designer/tests/docs/test_document_review_gate_recipe.py | ||
| rm -rf /tmp/datadesigner-workflow-chaining | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 41 additions & 0 deletions
41
fern/versions/latest/pages/recipes/workflow_chaining/document_review_gate.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| title: "Document Review Gate" | ||
| description: "" | ||
| --- | ||
| <Info title="Download Recipe"> | ||
| [Download the complete recipe script](https://github.com/NVIDIA-NeMo/DataDesigner/blob/main/docs/assets/recipes/workflow_chaining/document_review_gate.py) | ||
| </Info> | ||
|
|
||
| This recipe demonstrates workflow chaining with a review boundary. It generates synthetic document pages, runs a weak detector to a named `review_candidates` stage, exports that intermediate dataset, writes a simulated reviewed artifact, and resumes the downstream stages from that reviewed artifact. | ||
|
|
||
| The recipe is headless and does not call a model provider. It accepts `--model-alias` for compatibility with the recipe runner, but all stages use local custom columns. | ||
|
|
||
| ## Run the Recipe | ||
|
|
||
| ```bash | ||
| uv run document_review_gate.py --artifact-path ./workflow-artifacts --num-records 12 --overwrite | ||
| uv run document_review_gate.py --artifact-path ./workflow-artifacts --num-records 12 --review-pages 4 --overwrite | ||
| uv run document_review_gate.py --help | ||
| ``` | ||
|
|
||
| The run writes generated images, exported stage parquet files, the simulated reviewed parquet file, and the final dataset under `--artifact-path`. | ||
|
|
||
| ## Workflow Pattern | ||
|
|
||
| The important part is the boundary contract. The downstream workflow does not care whether `review_candidates` came from the original detector, a dashboard, a script, or another service. It only consumes the selected stage output. | ||
|
|
||
| ```python | ||
| import data_designer.config as dd | ||
|
|
||
| results = workflow.run(targets="review_candidates") | ||
| results.export_stage("review_candidates", review_path) | ||
|
|
||
| reviewed_path = write_simulated_review_artifact(base_dir) | ||
|
|
||
| workflow.run( | ||
| resume=dd.ResumeMode.ALWAYS, | ||
| stage_output_overrides={"review_candidates": reviewed_path}, | ||
| ) | ||
| ``` | ||
|
|
||
| Use this pattern when an intermediate dataset needs inspection, policy checks, cleanup, or human review before downstream stages should run. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Something seems off here....

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.
This is GitHub's rendered diff resolving Fern's root-relative
/assets/...path againstgithub.com. The tracked image is valid and renders in the Fern preview, so I kept the established Fern asset path.