Add structure run tool/task #767

collindutter · 2024-05-01T18:16:56Z

Added

StructureRunClient for running other Griptapes via a Tool.
StructureRunTask for running Structures as a Task from within another Structure.
GriptapeCloudStructureRunDriver for running Structures in the Griptape Cloud.
LocalStructureRunDriver for running Structures in the same runtime environment as the code that is running the Structure.
Default run_fn to CodeExecutionTask, making it a suitable no-op Task.

📚 Documentation preview 📚: https://griptape--767.org.readthedocs.build//767/

SavagePencil · 2024-05-02T04:12:26Z

CHANGELOG.md

@@ -24,7 +24,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `AmazonS3FileManagerDriver` for managing files on Amazon S3.
 - `MediaArtifact` as a base class for `ImageArtifact` and future media Artifacts.
 - Optional `exception` field to `ErrorArtifact`.
- `GriptapeCloudStructureRunClient` tool for invoking Griptape Cloud Structure Run APIs.
+- `GriptapeCloudStructureRunClient` Tool for invoking Griptape Cloud Structure Run APIs.
+- `GriptapeStructureRunClient` Tool for through a Tool.


Tool for RUNNING a Structure from within a Structure?

SavagePencil · 2024-05-02T04:14:34Z

docs/examples/multi-agent-workflow.md

+In this example we implement a multi-agent Workflow we have a single "Researcher" Agent that conducts research on a topic, and then fans out to multiple "Writer" Agents to write blog posts based on the research.
+
+By splitting up our workloads across multiple Structures, we can parallelize the work and leverage the strengths of each Agent. The Researcher can focus on gathering data and insights, while the Writers can focus on crafting engaging narratives.
+Additionally, this opens us up to the possibility of having each Agent run on a separate machine or container, allowing us to scale our Workflow as needed. 


I don't think we should be coy here; let's talk about "we can solve these in parallel using Griptape Cloud managed Structures to solve these simultaneously and get it faster" or whatever.

docs/examples/multi-agent-workflow.md

SavagePencil · 2024-05-02T04:41:37Z

docs/examples/multi-agent-workflow.md

+    with open(f"{Path(__file__).parent}/writers.json", "r") as f:
+        writers = json.loads(f.read())
+
+    # Build the crew


...team...?

docs/examples/multi-agent-workflow.md

collindutter · 2024-05-02T16:28:16Z

griptape/tasks/structure_run_task.py

+    """Task to run a Structure.
+
+    Attributes:
+        structure_to_run: Structure to run.


Awkward field name but structure is already taken by BaseTask. Open to suggestions.

target_structure?

collindutter · 2024-05-02T16:28:55Z

griptape/tools/griptape_structure_run_client/tool.py

+    """
+
+    description: str = field(kw_only=True)
+    structure: Structure = field(kw_only=True)


Should we make this consistent with the awkward structure_to_run on the Task?

docs/examples/multi-agent-workflow.md

dylanholmes

Great job!

I really like seeing the doc examples in the same PR (and its also nice that they just happen to show up at the beginning of the list the files).

CHANGELOG.md

docs/examples/multi-agent-workflow.md

docs/griptape-framework/structures/tasks.md

docs/griptape-tools/official-tools/structure-run-client.md

griptape/drivers/structure_run/local_structure_run_driver.py

griptape/tasks/code_execution_task.py

tests/unit/tasks/test_base_multi_text_input_task.py

SavagePencil

Qs only.

SavagePencil · 2024-05-04T04:08:59Z

CHANGELOG.md

- `GriptapeCloudStructureRunClient` tool for invoking Griptape Cloud Structure Run APIs.
+- `StructureRunClient` for running other Structures via a Tool.
+- `StructureRunTask` for running Structures as a Task from within another Structure.
+- `GriptapeCloudStructureRunDriver` for running Structures in the Griptape Cloud.


does this ONLY work for Cloud or will it work for the emulator as well?

SavagePencil · 2024-05-04T04:11:26Z

CHANGELOG.md

@@ -23,7 +23,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `AmazonS3FileManagerDriver` for managing files on Amazon S3.
 - `MediaArtifact` as a base class for `ImageArtifact` and future media Artifacts.
 - Optional `exception` field to `ErrorArtifact`.
- `GriptapeCloudStructureRunClient` tool for invoking Griptape Cloud Structure Run APIs.
+- `StructureRunClient` for running other Structures via a Tool.


ugh why can't it end with Tool

Named it this way for consistency TaskMemoryClient, another Tool that interacts directly with the framework. Agree that it's not ideal but it's at least consistent.

boo but OK. In the future, we don't let consistency hold us back :)

dylanholmes · 2024-05-06T03:53:05Z

docs/griptape-framework/structures/tasks.md

+            Identify key trends, breakthrough technologies, and potential industry impacts.""",
+            ),
+            driver=LocalStructureRunDriver(
+                structure_factory_fn=lambda: researcher,


Learning from the pitfall Jason fell into when reusing the same instance for multiple runs, maybe all the examples should use actually factory functions that return new instances. That way if someone starts out with one of our examples, they'll be on the right path from the beginning.

Good call, updated.

dylanholmes · 2024-05-06T03:55:17Z

docs/examples/multi-agent-workflow.md

+            """Conduct a comprehensive analysis of the latest advancements in AI in 2024.
+                Identify key trends, breakthrough technologies, and potential industry impacts.""",
+            id="research",
+            target_structure=build_researcher(),


Similar to LocalStructureRunDriver, StructureRunTask should accept a structure_factory_fn instead of an actual Structure instance to avoid the pitfalls of shared state between concurrent runs, right?

This was actually a mistake in the examples, target_structure is no longer a field. The Tool takes a Driver just like the Task.

collindutter · 2024-05-06T16:42:49Z

CHANGELOG.md

- **BREADKING**: Removed `mime_type` field from `ImageArtifact`. `mime_type` is now a property constructed using the Artifact type and `format` field.
+- **BREAKING**: Removed `mime_type` field from `ImageArtifact`. `mime_type` is now a property constructed using the Artifact type and `format` field.


Long live Bread King.

SavagePencil · 2024-05-06T16:54:45Z

CHANGELOG.md

@@ -23,7 +23,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `AmazonS3FileManagerDriver` for managing files on Amazon S3.
 - `MediaArtifact` as a base class for `ImageArtifact` and future media Artifacts.
 - Optional `exception` field to `ErrorArtifact`.
- `GriptapeCloudStructureRunClient` tool for invoking Griptape Cloud Structure Run APIs.
+- `StructureRunClient` for running other Structures via a Tool.


boo but OK. In the future, we don't let consistency hold us back :)

Resolved all comments

dylanholmes · 2024-05-06T17:29:01Z

docs/griptape-framework/drivers/structure-run-drivers.md

+    tasks=[
+        StructureRunTask(
+            driver=LocalStructureRunDriver(
+                structure_factory_fn=lambda: joke_teller,


Should this one also return a new instance, for similar reasons to my other comment?

collindutter force-pushed the feature/structure-run-tool branch 3 times, most recently from 46c4d0c to 70eb6db Compare May 2, 2024 00:17

SavagePencil reviewed May 2, 2024

View reviewed changes

collindutter force-pushed the feature/structure-run-tool branch 2 times, most recently from ac94922 to 0ac5bc9 Compare May 2, 2024 16:13

collindutter commented May 2, 2024

View reviewed changes

collindutter requested a review from a team May 2, 2024 16:29

collindutter marked this pull request as ready for review May 2, 2024 16:29

collindutter requested a review from dylanholmes May 2, 2024 19:24

SavagePencil previously approved these changes May 2, 2024

View reviewed changes

docs/examples/multi-agent-workflow.md Show resolved Hide resolved

collindutter dismissed SavagePencil’s stale review via d7f4417 May 2, 2024 20:37

collindutter force-pushed the feature/structure-run-tool branch from 68fce49 to 96005fe Compare May 2, 2024 21:54

collindutter requested a review from a team May 2, 2024 21:59

dylanholmes previously requested changes May 3, 2024

View reviewed changes

collindutter requested review from dylanholmes and SavagePencil May 3, 2024 17:35

collindutter force-pushed the feature/structure-run-tool branch 3 times, most recently from df075cb to fd616f3 Compare May 3, 2024 22:47

collindutter added 9 commits May 3, 2024 16:05

Add structure run tool/task

31ad883

Add workflow recipe

60acc36

Update changelog

6233619

Update changelog

d6a7d3a

Update doc wording

f9a0700

Remove prints

138962a

Mention Griptape Cloud

eb9d20c

Update wording

9c75842

Rename structure field

4a0f45a

collindutter added 12 commits May 3, 2024 16:05

Update changelog

fa78376

Format

1d87cc2

Better words

7c32a8f

Add multi text input task

fd6be29

Update example to use multiple inputs

7734dcd

Fix doc links

abf51e4

Fix PR things

4b8d8ee

Add async run field

30894c3

Remove code execution task as no-op

51e9189

Replace no-op with prompt

e2596b8

Change structure to structure_factory

d3e2d1b

Rename factory fn

0196143

collindutter force-pushed the feature/structure-run-tool branch from fd616f3 to 0196143 Compare May 3, 2024 23:05

SavagePencil previously approved these changes May 4, 2024

View reviewed changes

dylanholmes reviewed May 6, 2024

View reviewed changes

collindutter dismissed SavagePencil’s stale review via 958a0b4 May 6, 2024 16:12

collindutter force-pushed the feature/structure-run-tool branch from 958a0b4 to 9bbbfd3 Compare May 6, 2024 16:27

Fix examples

01732fa

collindutter force-pushed the feature/structure-run-tool branch from 9bbbfd3 to 01732fa Compare May 6, 2024 16:42

collindutter requested review from dylanholmes and vachillo May 6, 2024 16:42

collindutter commented May 6, 2024

View reviewed changes

SavagePencil previously approved these changes May 6, 2024

View reviewed changes

Add missing env var

6e3f13c

collindutter dismissed SavagePencil’s stale review via 6e3f13c May 6, 2024 17:06

SavagePencil approved these changes May 6, 2024

View reviewed changes

collindutter merged commit 0c87ea2 into dev May 6, 2024
8 checks passed

collindutter deleted the feature/structure-run-tool branch May 6, 2024 17:13

dylanholmes reviewed May 6, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add structure run tool/task #767

Add structure run tool/task #767

collindutter commented May 1, 2024 •

edited

Loading

SavagePencil May 2, 2024

SavagePencil May 2, 2024

SavagePencil May 2, 2024

collindutter May 2, 2024

vachillo May 2, 2024

collindutter May 2, 2024

collindutter May 2, 2024

dylanholmes left a comment

SavagePencil left a comment

SavagePencil May 4, 2024

SavagePencil May 4, 2024

collindutter May 6, 2024

SavagePencil May 6, 2024

dylanholmes May 6, 2024

collindutter May 6, 2024

dylanholmes May 6, 2024

collindutter May 6, 2024

collindutter May 6, 2024

SavagePencil May 6, 2024

dylanholmes May 6, 2024

		- BREADKING: Removed `mime_type` field from `ImageArtifact`. `mime_type` is now a property constructed using the Artifact type and `format` field.
		- BREAKING: Removed `mime_type` field from `ImageArtifact`. `mime_type` is now a property constructed using the Artifact type and `format` field.

Add structure run tool/task #767

Add structure run tool/task #767

Conversation

collindutter commented May 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dylanholmes left a comment

Choose a reason for hiding this comment

SavagePencil left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

collindutter commented May 1, 2024 •

edited

Loading