Build applications that make decisions (chatbots, agents, simulations, etc...). Monitor, trace, persist, and execute on your own infrastructure.
Python aiburrchatbot-frameworkdagsgenerative-aigraphshacktoberfestllmopsllmsmlopspersistent-data-structurestate-machinestate-managementvisibility
Adds image telephone example
Stefan Krawczyk36ad3e805db6
diff --git a/examples/cowsay/application.py b/examples/cowsay/application.pyindex f5f36555..c2bc2bd5 100644--- a/examples/cowsay/application.py+++ b/examples/cowsay/application.py@@ -73,4 +73,4 @@ if __name__ == "__main__":app = application(in_terminal=True)app.visualize(output_file_path="digraph", include_conditions=True, view=True, format="png")while True:- action, result, state = app.step()+ action, result, state = app.step()diff --git a/examples/image-telephone/README.md b/examples/image-telephone/README.mdnew file mode 100644index 00000000..23864316--- /dev/null+++ b/examples/image-telephone/README.md@@ -0,0 +1,24 @@+# Image Telephone++This example demonstrates how to play telephone with DALL-E and ChatGPT.++You provide an initial image to ChatGPT, which then generates a caption. The caption+is saved to state. That caption is then provided to DALL-E, which generates an image, which is saved to state.+You then provide that image to ChatGPT, and so on.++Right now the teriminal state is set to 2, so the game will end after 2 iterations:++++## Modifying the game+There are two levels you can modify:++1. The high-level orchestration and state management+2. What each action actually does.++For the high-level orchestration you can add more nodes, change conditions, etc.++For the low-level actions, you can change the prompt, the template, etc. too. To do so see the+documentation for the Hamilton dataflows that are used: [captioning](https://hub.dagworks.io/docs/Users/elijahbenizzy/caption_images/) and+[generating image](https://hub.dagworks.io/docs/Users/elijahbenizzy/generate_images/). You can easily modify the prompt and+template by overriding values, or by copying the code and modifying it yourself in 2 minutes - see instructions on the [hub](https://hub.dagworks.io/).diff --git a/examples/image-telephone/application.py b/examples/image-telephone/application.pynew file mode 100644index 00000000..2f482e20--- /dev/null+++ b/examples/image-telephone/application.py@@ -0,0 +1,155 @@+from typing import Tuple++from burr.core import Action, ApplicationBuilder, State, default, expr+from burr.core.action import action+from burr.integrations import hamilton+from burr.lifecycle import PostRunStepHook+from hamilton import dataflows, driver++caption_images = dataflows.import_module("caption_images", "elijahbenizzy")+generate_images = dataflows.import_module("generate_images", "elijahbenizzy")+++caption_image_driver = driver.Builder().with_config({}).with_modules(caption_images).build()++generate_image_driver = driver.Builder().with_config({}).with_modules(generate_images).build()+++class PrintStepHook(PostRunStepHook):+ def post_run_step(self, *, state: "State", action: "Action", **future_kwargs):+ print("action=====\n", action)+ print("state======\n", state)+++# procedural way to do this+@action(+ reads=["current_image_location"],+ writes=["current_image_caption", "image_location_history"],+)+def image_caption(state: State) -> Tuple[dict, State]:+ current_image = state["current_image_location"]+ result = caption_image_driver.execute(+ ["generated_caption"], inputs={"image_url": current_image}+ )+ updates = {+ "current_image_caption": result["generated_caption"],+ }+ return result, state.update(**updates).append(image_location_history=current_image)+++# procedural way to do this+@action(+ reads=["current_image_caption"],+ writes=["current_image_location", "image_caption_history"],+)+def image_generation(state: State) -> Tuple[dict, State]:+ current_caption = state["current_image_caption"]+ result = generate_image_driver.execute(+ ["generated_image"], inputs={"image_generation_prompt": current_caption}+ )+ updates = {+ "current_image_location": result["generated_image"],+ }+ return result, state.update(**updates).append(image_caption_history=current_caption)+++@action(reads=[], writes=[])+def terminal_step(state: State) -> Tuple[dict, State]:+ return {}, state+++def regular_action_main():+ """This shows how one might define functions to be nodes."""+ app = (+ ApplicationBuilder()+ .with_state(+ current_image_location="telephone_graph.png",+ current_image_caption="",+ image_location_history=[],+ image_caption_history=[],+ )+ .with_actions(+ caption=image_caption,+ image=image_generation,+ terminal=terminal_step,+ )+ .with_transitions(+ ("caption", "image", default),+ ("image", "terminal", expr("len(image_caption_history) == 2")),+ ("image", "caption", default),+ )+ .with_entrypoint("caption")+ .with_hooks(PrintStepHook())+ .with_tracker("image-telephone")+ .build()+ )+ return app+++def hamilton_action_main():+ """This shows how to use the Hamilton syntactic wrapper for the nodes."""++ _caption = hamilton.Hamilton(+ inputs={"image_url": hamilton.from_state("current_image_location")},+ outputs={+ "generated_caption": hamilton.update_state("current_image_caption"),+ "image_url": hamilton.append_state("image_location_history"),+ },+ driver=caption_image_driver,+ )+ _image = hamilton.Hamilton(+ inputs={"image_generation_prompt": hamilton.from_state("current_image_caption")},+ outputs={+ "generated_image": hamilton.update_state("current_image_location"),+ "image_generation_prompt": hamilton.append_state("image_caption_history"),+ },+ driver=generate_image_driver,+ )+ app = (+ ApplicationBuilder()+ .with_state(+ current_image_location="telephone_graph.png",+ current_image_caption="",+ image_location_history=[],+ image_caption_history=[],+ )+ .with_actions(+ caption=_caption,+ image=_image,+ terminal=terminal_step,+ )+ .with_transitions(+ ("caption", "image", default),+ ("image", "terminal", expr("len(image_caption_history) == 2")),+ ("image", "caption", default),+ )+ .with_entrypoint("caption")+ .with_hooks(PrintStepHook())+ .with_tracker("image-telephone")+ .build()+ )+ return app+++if __name__ == "__main__":+ import random++ coin_flip = random.choice([True, False])+ if coin_flip:+ app = hamilton_action_main()+ else:+ app = regular_action_main()+ app.visualize(+ output_file_path="telephone_graph", include_conditions=True, view=True, format="png"+ )+ if coin_flip:+ app.run(until=["terminal"])+ else:+ # alternate way to run:+ while True:+ action, result, state = app.step()+ print("action=====\n", action)+ print("result=====\n", result)+ print("state======\n", state)+ if action.name == "terminal":+ breakdiff --git a/examples/image-telephone/telephone_graph.png b/examples/image-telephone/telephone_graph.pngnew file mode 100644index 00000000..eacaa87cBinary files /dev/null and b/examples/image-telephone/telephone_graph.png differ