From 27c779751e22a902972b889d4de8653431d56d3f Mon Sep 17 00:00:00 2001 From: zachary62 Date: Wed, 26 Feb 2025 02:11:27 -0500 Subject: [PATCH] try callouts --- docs/_config.yml | 2 +- docs/agent.md | 2 +- docs/communication.md | 2 +- docs/decomp.md | 2 +- docs/multi_agent.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index 24a3427..0786a65 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -29,7 +29,7 @@ callouts: note: title: Note color: blue - best_practice: + best-practice: title: Best Practice color: green diff --git a/docs/agent.md b/docs/agent.md index 774e66a..c12701a 100644 --- a/docs/agent.md +++ b/docs/agent.md @@ -15,7 +15,7 @@ To express an agent, create a Node (the agent) with [branching](./flow.md) to ot > 1. **Context Management:** Provide *clear, relevant context* so agents can understand the problem.E.g., Rather than dumping an entire chat history or entire files, use a [Workflow](./decomp.md) that filters out and includes only the most relevant information. > > 2. **Action Space:** Define *a well-structured, unambiguous, and easy-to-use* set of actions. For instance, avoid creating overlapping actions like `read_databases` and `read_csvs`. Instead, unify data sources (e.g., move CSVs into a database) and design a single action. The action can be parameterized (e.g., string for search) or programmable (e.g., SQL queries). -{: .best_practice } +{: .best-practice } ### Example: Search Agent diff --git a/docs/communication.md b/docs/communication.md index efa415c..d7a1a89 100644 --- a/docs/communication.md +++ b/docs/communication.md @@ -23,7 +23,7 @@ Nodes and Flows **communicate** in two ways: If you know memory management, think of the **Shared Store** like a **heap** (shared by all function calls), and **Params** like a **stack** (assigned by the caller). > Use `Shared Store` for almost all cases. It's flexible and easy to manage. It separates *Data Schema* from *Compute Logic*, making the code easier to maintain. `Params` is more a syntax sugar for [Batch](./batch.md). -{: .best_practice } +{: .best-practice } --- diff --git a/docs/decomp.md b/docs/decomp.md index a747a6e..ad6536e 100644 --- a/docs/decomp.md +++ b/docs/decomp.md @@ -14,7 +14,7 @@ Many real-world tasks are too complex for one LLM call. The solution is to decom > - You don't want to make each task **too granular**, because then *the LLM call doesn't have enough context* and results are *not consistent across nodes*. > > You usually need multiple *iterations* to find the *sweet spot*. If the task has too many *edge cases*, consider using [Agents](./agent.md). -{: .best_practice } +{: .best-practice } ### Example: Article Writing diff --git a/docs/multi_agent.md b/docs/multi_agent.md index 9067f3f..ed64c4a 100644 --- a/docs/multi_agent.md +++ b/docs/multi_agent.md @@ -11,7 +11,7 @@ Multiple [Agents](./flow.md) can work together by handling subtasks and communic Communication between agents is typically implemented using message queues in shared storage. > Most of time, you don't need Multi-Agents. Start with a simple solution first. -{: .best_practice } +{: .best-practice } ### Example Agent Communication: Message Queue