Feature/api rework#1
Merged
Merged
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.
This pull request significantly improves the documentation and examples for
flowrun, clarifying its positioning, strengths, and tradeoffs, while also simplifying and updating the usage patterns. It introduces a new micro-batch ETL example and removes deprecated or confusing features from both the documentation and code examples. The overall goal is to make the framework's intended use cases, limitations, and API surface much clearer for users.Documentation and Positioning Updates:
README.mdto clarifyflowrun's intended use cases, strengths, and tradeoffs, positioning it as a lightweight, in-process DAG engine for small to medium ETL jobs, not as a distributed scheduler or orchestration platform.API and Usage Simplification:
retain_result,task_template, and global@taskdecorator usage from both documentation and examples, focusing on the preferred, simpler API. [1] [2] Faaeb5a6L225R276, [3] [4] [5] [6] [7]New and Improved Examples:
examples/micro_batch_demo.pyillustrating the micro-batch pattern, where the DAG is run once per chunk from an external async source, with clear separation between chunk fetching and DAG execution.Clarification of Execution Semantics:
Removal of Deprecated Features:
These changes make the documentation and examples more focused, easier to follow, and better aligned with the intended use cases for
flowrun.