updated docs for showing runtime compatibility#2391
Open
rafel-roboflow wants to merge 1 commit into
Open
Conversation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
Adds documentation for the runtime compatibility mechanism that already lives in the workflow-block API (
get_restrictions()/get_air_gapped_availability()), so block users can see — and block authors can understand — where each block degrades or fails outright.Concretely, three things land together:
docs/workflows/create_workflow_block.md(### Runtime restrictions) explainingSeverity.SOFT/Severity.HARD, the three scoping axes (Runtime,StepExecutionMode,RuntimeInputMode), the shared presets (STATEFUL_VIDEO_HTTP_SOFT_RESTRICTION,COOLDOWN_HTTP_SOFT_RESTRICTION,STILL_IMAGE_INPUT_SOFT_RESTRICTION), and two concrete examples (preset reuse + a customSeverity.HARDrestriction).development/docs/build_block_docs.py) now readsget_restrictions()andget_air_gapped_availability()off each manifest and renders them as a### Runtime compatibilityheading +??? tip "Restrictions"admonition (matching the existing "Compatible Blocks" pattern), with a definition list inside that uses severity-colored Material icons (red shield forhard, amber alert-circle forsoft, blue-grey cloud-off forrequires_internet). Pages without caveats render no section at all, so existing blocks gain no boilerplate. Enabled thedef_listmarkdown extension inmkdocs.ymlto support the new layout.And yet found another bug:
qwen3_5vl/v2.pywas missing theget_restrictions()override that v1 already declared. v2's manifest extendsWorkflowBlockManifestdirectly (not v1'sBlockManifest), so nothing was inherited.I also audited the rest of blocks trying to find other ones missing.
Related Issue(s): /resolve DG-521
Type of Change
qwen3_5vl/v2.pymissingget_restrictions()overrideTesting
Test details:
Tested and checked locally
Checklist
Additional Context
N/A
Note
Low Risk
Mostly documentation and doc generation; the only runtime code change is declarative restrictions on Qwen3.5-VL v2 for schema/gallery surfacing, not execution behavior changes in this PR.
Overview
Documents and surfaces runtime compatibility for workflow blocks: when they fail or degrade by runtime, execution mode, or input mode, and when they are unavailable offline.
Author docs:
create_workflow_block.mdadds a Runtime restrictions section coveringget_restrictions(),Severity.SOFT/HARD, scoping axes, shared presets, and examples—aligned withdescribe_interfaceand the execution engine.Generated gallery:
build_block_docs.pyinjects an optional Runtime compatibility section after Properties by callingget_air_gapped_availability()andget_restrictions()on each manifest (severity icons, scoped notes; omitted when empty).mkdocs.ymlenablesdef_listfor that layout.Bug fix:
qwen3_5vl/v2.pynow declaresget_restrictions()(GPU required for local CPU; hosted remote 404 whenQWEN_3_5_ENABLEDis false)—matching v1 behavior that v2 did not inherit.Reviewed by Cursor Bugbot for commit 566a0fa. Bugbot is set up for automated code reviews on this repo. Configure here.