Add request param overrides for pipeline operators by CamronStaley · Pull Request #7277 · voxel51/fiftyone

CamronStaley · 2026-03-31T15:24:59Z

🔗 Related Issues

📋 What changes are proposed in this pull request?

Update docs for request param overrides.

🧪 How is this patch tested? If it is not, please explain why.

n/a

📝 Release Notes

Is this a user-facing change that should be mentioned in the release notes?

No. You can skip the rest of this section.
Yes. Give a description of this change to be included in the release
notes for FiftyOne users.

Added instructions to docs for how to use request param overrides in pipeline operators.

What areas of FiftyOne does this PR affect?

App: FiftyOne application changes
Build: Build and test infrastructure changes
Core: Core fiftyone Python library changes
Documentation: FiftyOne documentation changes
Other

Summary by CodeRabbit

Documentation
- Added guidance on overriding pipeline stage-level request parameters using request_params_overrides.
- Documented parameter inheritance and shadowing behavior for pipeline stages.
- Included code example demonstrating multi-view pipeline configuration with different execution contexts.

coderabbitai · 2026-03-31T15:27:40Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 2df8dd80-95dc-4684-9deb-4209a799729d

📥 Commits

Reviewing files that changed from the base of the PR and between 6d52a1c and 370eccb.

📒 Files selected for processing (1)

docs/source/plugins/developing_plugins.rst

Walkthrough

A documentation section was added to explain how pipeline stages can override request parameters using request_params_overrides on PipelineStage. The section details the inheritance behavior where stages inherit top-level pipeline operator context by default, defines shadowing semantics for overridden keys, specifies supported overridable parameters (view, view_name, filters, and other execution-context parameters), and includes a note restricting params from request_params_overrides while directing users to use PipelineStage.params instead. A Python code example (MultiViewPipeline) demonstrates three pipeline stages with different view contexts using request_params_overrides.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	The description is incomplete. While it identifies the change as documentation-only and includes release notes, it lacks detail about what is documented and omits the 'Related Issues' section entirely.	Add related issue links (if any exist) and provide more specifics about what request param override behavior/parameters are documented in the PR.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically identifies the main change: adding request parameter override functionality for pipeline operators, matching the documentation additions in the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch docs/request-param-overrides

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

swheaton

lgtm but see what @AdonaiVera wants to do with it
(We have a docs addition but don't want to target today's release which is underway already)

AdonaiVera

I just committed some small doc style improvements @CamronStaley, this PR is ready!
Feel free to merge whenever you think it makes sense to have it in production. Once it’s merged, I can add a tag to deploy the docs.

brimoor

@CamronStaley @swheaton I might have missed the boat on providing feedback on the functional implementation of this feature, but please note I have a small FR on the view parameter 😄

brimoor · 2026-04-01T13:55:17Z

docs/source/plugins/developing_plugins.rst

+                request_params_overrides={"view_name": "val_split"},
+            )
+
+            # Stage 3 runs against the full dataset (no view applied)


Can you add a case where where a view is provided?

I imagine a typical case would be something like view=ctx.view[i:j], ie manual batching.

brimoor · 2026-04-01T13:55:34Z

docs/source/plugins/developing_plugins.rst

+
+-   `view` — a list of view stages to apply
+-   `view_name` — the name of a saved view to use
+-   `filters` — a dictionary of filters to apply


filters is not an officially documented thing. How would users figure out how to successfully use this?

They wouldn't. We can remove this example from the documentation

brimoor · 2026-04-01T13:56:10Z

docs/source/plugins/developing_plugins.rst

+shadow the corresponding value from the top-level request for that stage only;
+all other stages are unaffected.
+
+Overridable parameters include:


Can dataset or dataset_name be overridden? That would be powerful, but may be dubious too.

I was thinking about disallowing that but i guess we never did it. Probably should have an allow or block list.

Allowed and potentially useful

view_name

view (*****)

selected

current_sample

active_fields

group_slice

num_distributed_tasks

Allowed (not exactly useful but not harmful either)

filters

extended

workspace_name

spaces

selected_labels

extended_selection

query_performance

Disallowed

dataset_id

dataset_name

delegated

request_delegation

results

Unsure

delegation target - I'm not sure if this would cause downstream issues. Thinking not, but we may want a more official way to change delegation targets rather than the pipeline operator doing it under the hood

Changing delegation target would be useful in the sense that certain stages may need to use GPU.

Certainly it would be an anti-pattern for pipeline operators to hard-code the name of a delegation target in them, however.

yeah this would be a cool feature whenever we have more information about orcs in the collection. Would be cool if they could say something like "delegate_criteria: must have gpu, X storage, blah" and then we could select an appropriate orc on their behalf.

yep exactly!

brimoor · 2026-04-01T13:58:05Z

docs/source/plugins/developing_plugins.rst

+
+Overridable parameters include:
+
+-   `view` — a list of view stages to apply


Can we please support view being provided as a DatasetView object? Which would be serialized into view stages internally by our interface.

I think our public interfaces should always work with FO's main types, ie support DatasetView, not require lists of ViewStages and certainly not requiring lists of serialized view stage dicts.

(it is fwm if the view parameter supports the latter two possibilities as undocumented syntaxes though)

yeah i agree

agreed currently you have to serialize it (we don't do that on behalf of the user) which isn't intuitive. I can open a PR to fix that mb

CamronStaley · 2026-04-01T15:40:56Z

Going to leave this PR open / undocumented to users until I can address Bmoore's comments in the next release. Current plan is:

serialize on behalf of the user if they didn't provide a serialized view
clearly document / test more allowed fields and explicitly not allow some fields

swheaton · 2026-04-03T13:23:22Z

holding off docs until code matches what's expected from above

add request param overrides for pipeline operators

370eccb

CamronStaley self-assigned this Mar 31, 2026

CamronStaley requested a review from a team as a code owner March 31, 2026 15:25

CamronStaley mentioned this pull request Mar 31, 2026

Add docs for request param overrides #7276

Closed

7 tasks

swheaton approved these changes Mar 31, 2026

View reviewed changes

docs: fix inline code style in pipeline section

c9ceb44

AdonaiVera approved these changes Mar 31, 2026

View reviewed changes

brimoor reviewed Apr 1, 2026

View reviewed changes

swheaton marked this pull request as draft April 3, 2026 13:22


		Overridable parameters include:

		- `view` — a list of view stages to apply

Conversation

CamronStaley commented Mar 31, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Related Issues

📋 What changes are proposed in this pull request?

🧪 How is this patch tested? If it is not, please explain why.

📝 Release Notes

Is this a user-facing change that should be mentioned in the release notes?

What areas of FiftyOne does this PR affect?

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Estimated code review effort

❌ Failed checks (1 inconclusive)

Uh oh!

swheaton left a comment

Choose a reason for hiding this comment

Uh oh!

AdonaiVera left a comment

Choose a reason for hiding this comment

Uh oh!

brimoor left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brimoor Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CamronStaley commented Apr 1, 2026

Uh oh!

swheaton commented Apr 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

CamronStaley commented Mar 31, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 31, 2026 •

edited

Loading

brimoor left a comment •

edited

Loading

brimoor Apr 1, 2026 •

edited

Loading