Skip to content
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

Clarifying Core Component Cooperation #149

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

AndrewBKang
Copy link
Contributor

This PR contains daily documentation updates based on the following suggestion:
Ensure readers are clear on the differences and usage of Actions, Generators, and Agents as the framework's foundation. Currently, the distinctions could be more vividly portrayed with examples and use cases where multiple of these components work in tandem.
description of file changes: Revise docs/concepts/index.md to expand on how actions, generators, and agents cooperate:\n\n### How Components Cooperate\n\n1. Generators: Focused on data transformation by generating outputs without complex decision-making capabilities.\n\n2. Actions: Perform operations outside of data transformation: data retrieval, file writing, etc. Typical in conjunction with generators for data pre and post-processing.\n\n3. Agents: Autonomous units that execute tasks or monitor systems using generators and actions, triggered by conditions like file changes or time intervals.\n\n#### Example Showcase\nA task that involves an action extracting data, a generator transforming it, and an agent handling the execution based on triggers would clarify the workflow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant