This commit is contained in:
zachary62 2024-12-31 01:26:52 +00:00
parent 34fede64bf
commit c1ba9dd0d4
4 changed files with 99 additions and 96 deletions

View File

@ -7,57 +7,60 @@ nav_order: 5
# Async # Async
**Async** pattern allows the `post()` step to be asynchronous: `post_async()`. This is especially helpful if you need to `await` something—for example, user feedback or external async requests. **Mini LLM Flow** allows fully asynchronous nodes by implementing `prep_async()`, `exec_async()`, and/or `post_async()`. This is useful for:
**⚠️ Warning**: Only `post_async()` is async. `prep()` and `exec()` must be sync. ## Implementation
--- 1. **prep_async()**
- For *fetching/reading data (files, APIs, DB)* in an I/O-friendly way.
## 1. AsyncNode 2. **exec_async()**
- Typically used for async LLM calls.
Below is a minimal **AsyncNode** that calls an LLM in `exec()` to summarize texts, and then awaits user feedback in `post_async()`: 3. **post_async()**
- For *awaiting user feedback*, *coordinating across multi-agents* or any additional async steps after `exec_async()`.
Each step can be either sync or async; the framework automatically detects which to call.
**Note**: `AsyncNode` must be wrapped in `AsyncFlow`. `AsyncFlow` can also include regular (sync) nodes.
### Example
```python ```python
class SummarizeThenVerify(AsyncNode): class SummarizeThenVerify(AsyncNode):
def prep(self, shared): async def prep_async(self, shared):
return shared.get("doc", "") # Example: read a file asynchronously
doc_text = await read_file_async(shared["doc_path"])
return doc_text
def exec(self, prep_res): async def exec_async(self, prep_res):
return call_llm(f"Summarize: {prep_res}") # Example: async LLM call
summary = await call_llm_async(f"Summarize: {prep_res}")
return summary
async def post_async(self, shared, prep_res, exec_res): async def post_async(self, shared, prep_res, exec_res):
user_decision = await gather_user_feedback(exec_res) # Example: wait for user feedback
if user_decision == "approve": decision = await gather_user_feedback(exec_res)
if decision == "approve":
shared["summary"] = exec_res shared["summary"] = exec_res
return "approve" return "approve"
else: return "deny"
return "deny"
```
- `exec()`: Summarizes text (sync LLM call).
- `post_async()`: Waits for user approval (async).
---
## 2. AsyncFlow
We can build an **AsyncFlow** around this node. If the user denies, we loop back for another attempt; if approved, we pass to a final node:
```python
summarize_node = SummarizeThenVerify() summarize_node = SummarizeThenVerify()
final_node = Finalize() final_node = Finalize()
# Chain conditions # Define transitions
summarize_node - "approve" >> final_node summarize_node - "approve" >> final_node
summarize_node - "deny" >> summarize_node # retry loop summarize_node - "deny" >> summarize_node # retry
flow = AsyncFlow(start=summarize_node) flow = AsyncFlow(start=summarize_node)
async def main(): async def main():
shared = {"doc": "Mini LLM Flow is a lightweight LLM framework."} shared = {"doc_path": "document.txt"}
await flow.run_async(shared) await flow.run_async(shared)
print("Final stored summary:", shared.get("final_summary")) print("Final Summary:", shared.get("summary"))
asyncio.run(main()) asyncio.run(main())
``` ```
Keep it simple: go async only when needed, handle errors gracefully, and leverage Pythons `asyncio`.

View File

@ -6,16 +6,13 @@ class BaseNode:
def add_successor(self,node,action="default"): def add_successor(self,node,action="default"):
if action in self.successors: warnings.warn(f"Overwriting successor for action '{action}'") if action in self.successors: warnings.warn(f"Overwriting successor for action '{action}'")
self.successors[action]=node;return node self.successors[action]=node;return node
def prep(self,shared): return None def prep(self,shared): pass
def exec(self,prep_res): return None def exec(self,prep_res): pass
def post(self,shared,prep_res,exec_res): pass
def _exec(self,prep_res): return self.exec(prep_res) def _exec(self,prep_res): return self.exec(prep_res)
def post(self,shared,prep_res,exec_res): return "default" def _run(self,shared): p=self.prep(shared);e=self._exec(p);return self.post(shared,p,e)
def _run(self,shared): def run(self,shared):
prep_res=self.prep(shared) if self.successors: warnings.warn("Node won't run successors. Use Flow.")
exec_res=self._exec(prep_res)
return self.post(shared,prep_res,exec_res)
def run(self,shared):
if self.successors: warnings.warn("Node won't run successors. Use a parent Flow instead.")
return self._run(shared) return self._run(shared)
def __rshift__(self,other): return self.add_successor(other) def __rshift__(self,other): return self.add_successor(other)
def __sub__(self,action): def __sub__(self,action):
@ -27,74 +24,77 @@ class _ConditionalTransition:
def __rshift__(self,tgt): return self.src.add_successor(tgt,self.action) def __rshift__(self,tgt): return self.src.add_successor(tgt,self.action)
class Node(BaseNode): class Node(BaseNode):
def __init__(self,max_retries=1): def __init__(self,max_retries=1): super().__init__();self.max_retries=max_retries
super().__init__()
self.max_retries=max_retries
def process_after_fail(self,prep_res,exc): raise exc def process_after_fail(self,prep_res,exc): raise exc
def _exec(self,prep_res): def _exec(self,prep_res):
for i in range(self.max_retries): for i in range(self.max_retries):
try:return super()._exec(prep_res) try: return super()._exec(prep_res)
except Exception as e: except Exception as e:
if i==self.max_retries-1:return self.process_after_fail(prep_res,e) if i==self.max_retries-1: return self.process_after_fail(prep_res,e)
class BatchNode(Node): class BatchNode(Node):
def prep(self,shared): return []
def _exec(self,items): return [super(Node,self)._exec(i) for i in items] def _exec(self,items): return [super(Node,self)._exec(i) for i in items]
class Flow(BaseNode): class Flow(BaseNode):
def __init__(self,start): def __init__(self,start): super().__init__();self.start=start
super().__init__()
self.start=start
def get_next_node(self,curr,action): def get_next_node(self,curr,action):
nxt=curr.successors.get(action if action is not None else "default") nxt=curr.successors.get(action or "default")
if not nxt and curr.successors: warnings.warn(f"Flow ends: action '{action}' not found in {list(curr.successors)}") if not nxt and curr.successors:
warnings.warn(f"Flow ends: '{action}' not found in {list(curr.successors)}")
return nxt return nxt
def _orchestrate(self,shared,params=None): def _orch(self,shared,params=None):
curr,p=self.start,(params if params else {**self.params}) curr,p=self.start,(params or {**self.params})
while curr: while curr: curr.set_params(p);c=curr._run(shared);curr=self.get_next_node(curr,c)
curr.set_params(p) def _run(self,shared): pr=self.prep(shared);self._orch(shared);return self.post(shared,pr,None)
curr=self.get_next_node(curr,curr._run(shared)) def exec(self,prep_res): raise RuntimeError("Flow can't exec.")
def _run(self,shared):
self._orchestrate(shared)
return self.post(shared,self.prep(shared),None)
def exec(self,prep_res):
raise RuntimeError("Flow should not exec directly. Create a child Node instead.")
class BatchFlow(Flow): class BatchFlow(Flow):
def prep(self,shared): return []
def _run(self,shared): def _run(self,shared):
prep_res=self.prep(shared) pr=self.prep(shared) or []
for batch_params in prep_res:self._orchestrate(shared,{**self.params,**batch_params}) for bp in pr: self._orch(shared,{**self.params,**bp})
return self.post(shared,prep_res,None) return self.post(shared,pr,None)
class AsyncNode(Node): class AsyncNode(Node):
def post(self,shared,prep_res,exec_res): def prep(self,shared): raise RuntimeError("Use prep_async.")
raise RuntimeError("AsyncNode should post using post_async instead.") def exec(self,prep_res): raise RuntimeError("Use exec_async.")
async def post_async(self,shared,prep_res,exec_res): def post(self,shared,prep_res,exec_res): raise RuntimeError("Use post_async.")
await asyncio.sleep(0);return "default" def _run(self,shared): raise RuntimeError("Use run_async.")
async def run_async(self,shared): async def prep_async(self,shared): pass
if self.successors: async def exec_async(self,prep_res): pass
warnings.warn("Node won't run successors. Use a parent AsyncFlow instead.") async def post_async(self,shared,prep_res,exec_res): pass
async def _exec(self,prep_res): return await self.exec_async(prep_res)
async def run_async(self,shared):
if self.successors: warnings.warn("Node won't run successors. Use AsyncFlow.")
return await self._run_async(shared) return await self._run_async(shared)
async def _run_async(self,shared): async def _run_async(self,shared):
prep_res=self.prep(shared) p=await self.prep_async(shared);e=await self._exec(p)
exec_res=self._exec(prep_res) return await self.post_async(shared,p,e)
return await self.post_async(shared,prep_res,exec_res)
def _run(self,shared): raise RuntimeError("AsyncNode should run using run_async instead.") class AsyncBatchNode(AsyncNode):
async def _exec(self,items): return [await super()._exec(i) for i in items]
class AsyncParallelBatchNode(AsyncNode):
async def _exec(self,items): return await asyncio.gather(*(super()._exec(i) for i in items))
class AsyncFlow(Flow,AsyncNode): class AsyncFlow(Flow,AsyncNode):
async def _orchestrate_async(self,shared,params=None): async def _orch_async(self,shared,params=None):
curr,p=self.start,(params if params else {**self.params}) curr,p=self.start,(params or {**self.params})
while curr: while curr:
curr.set_params(p) curr.set_params(p)
c=await curr._run_async(shared) if hasattr(curr,"run_async") else curr._run(shared) c=await curr._run_async(shared) if isinstance(curr,AsyncNode) else curr._run(shared)
curr=self.get_next_node(curr,c) curr=self.get_next_node(curr,c)
async def _run_async(self,shared): async def _run_async(self,shared):
await self._orchestrate_async(shared) pr=await self.prep_async(shared);await self._orch_async(shared)
return await self.post_async(shared,self.prep(shared),None) return await self.post_async(shared,pr,None)
class BatchAsyncFlow(BatchFlow,AsyncFlow): class AsyncBatchFlow(AsyncFlow):
async def _run_async(self,shared): async def _run_async(self,shared):
prep_res=self.prep(shared) pr=await self.prep_async(shared) or []
for batch_params in prep_res:await self._orchestrate_async(shared,{**self.params,**batch_params}) for bp in pr: await self._orch_async(shared,{**self.params,**bp})
return await self.post_async(shared,prep_res,None) return await self.post_async(shared,pr,None)
class AsyncParallelBatchFlow(AsyncFlow):
async def _run_async(self,shared):
pr=await self.prep_async(shared) or []
await asyncio.gather(*(self._orch_async(shared,{**self.params,**bp}) for bp in pr))
return await self.post_async(shared,pr,None)

View File

@ -4,10 +4,10 @@ import sys
from pathlib import Path from pathlib import Path
sys.path.insert(0, str(Path(__file__).parent.parent)) sys.path.insert(0, str(Path(__file__).parent.parent))
from minillmflow import AsyncNode, BatchAsyncFlow from minillmflow import AsyncNode, AsyncBatchFlow
class AsyncDataProcessNode(AsyncNode): class AsyncDataProcessNode(AsyncNode):
def prep(self, shared_storage): async def prep_async(self, shared_storage):
key = self.params.get('key') key = self.params.get('key')
data = shared_storage['input_data'][key] data = shared_storage['input_data'][key]
if 'results' not in shared_storage: if 'results' not in shared_storage:
@ -34,8 +34,8 @@ class TestAsyncBatchFlow(unittest.TestCase):
def test_basic_async_batch_processing(self): def test_basic_async_batch_processing(self):
"""Test basic async batch processing with multiple keys""" """Test basic async batch processing with multiple keys"""
class SimpleTestAsyncBatchFlow(BatchAsyncFlow): class SimpleTestAsyncBatchFlow(AsyncBatchFlow):
def prep(self, shared_storage): async def prep_async(self, shared_storage):
return [{'key': k} for k in shared_storage['input_data'].keys()] return [{'key': k} for k in shared_storage['input_data'].keys()]
shared_storage = { shared_storage = {
@ -58,8 +58,8 @@ class TestAsyncBatchFlow(unittest.TestCase):
def test_empty_async_batch(self): def test_empty_async_batch(self):
"""Test async batch processing with empty input""" """Test async batch processing with empty input"""
class EmptyTestAsyncBatchFlow(BatchAsyncFlow): class EmptyTestAsyncBatchFlow(AsyncBatchFlow):
def prep(self, shared_storage): async def prep_async(self, shared_storage):
return [{'key': k} for k in shared_storage['input_data'].keys()] return [{'key': k} for k in shared_storage['input_data'].keys()]
shared_storage = { shared_storage = {
@ -73,8 +73,8 @@ class TestAsyncBatchFlow(unittest.TestCase):
def test_async_error_handling(self): def test_async_error_handling(self):
"""Test error handling during async batch processing""" """Test error handling during async batch processing"""
class ErrorTestAsyncBatchFlow(BatchAsyncFlow): class ErrorTestAsyncBatchFlow(AsyncBatchFlow):
def prep(self, shared_storage): async def prep_async(self, shared_storage):
return [{'key': k} for k in shared_storage['input_data'].keys()] return [{'key': k} for k in shared_storage['input_data'].keys()]
shared_storage = { shared_storage = {
@ -110,8 +110,8 @@ class TestAsyncBatchFlow(unittest.TestCase):
await asyncio.sleep(0.01) await asyncio.sleep(0.01)
return "done" return "done"
class NestedAsyncBatchFlow(BatchAsyncFlow): class NestedAsyncBatchFlow(AsyncBatchFlow):
def prep(self, shared_storage): async def prep_async(self, shared_storage):
return [{'key': k} for k in shared_storage['input_data'].keys()] return [{'key': k} for k in shared_storage['input_data'].keys()]
# Create inner flow # Create inner flow
@ -147,8 +147,8 @@ class TestAsyncBatchFlow(unittest.TestCase):
shared_storage['results'][key] = shared_storage['input_data'][key] * multiplier shared_storage['results'][key] = shared_storage['input_data'][key] * multiplier
return "done" return "done"
class CustomParamAsyncBatchFlow(BatchAsyncFlow): class CustomParamAsyncBatchFlow(AsyncBatchFlow):
def prep(self, shared_storage): async def prep_async(self, shared_storage):
return [{ return [{
'key': k, 'key': k,
'multiplier': i + 1 'multiplier': i + 1

View File

@ -17,7 +17,7 @@ class AsyncNumberNode(AsyncNode):
super().__init__() super().__init__()
self.number = number self.number = number
def prep(self, shared_storage): async def prep_async(self, shared_storage):
# Synchronous work is allowed inside an AsyncNode, # Synchronous work is allowed inside an AsyncNode,
# but final 'condition' is determined by post_async(). # but final 'condition' is determined by post_async().
shared_storage['current'] = self.number shared_storage['current'] = self.number
@ -34,7 +34,7 @@ class AsyncIncrementNode(AsyncNode):
""" """
Demonstrates incrementing the 'current' value asynchronously. Demonstrates incrementing the 'current' value asynchronously.
""" """
def prep(self, shared_storage): async def prep_async(self, shared_storage):
shared_storage['current'] = shared_storage.get('current', 0) + 1 shared_storage['current'] = shared_storage.get('current', 0) + 1
return "incremented" return "incremented"