diff --git a/docs/example.md b/docs/apps.md similarity index 72% rename from docs/example.md rename to docs/apps.md index 934daf3..7ca6d11 100644 --- a/docs/example.md +++ b/docs/apps.md @@ -1,6 +1,6 @@ --- layout: default -title: "Example" +title: "Apps" nav_order: 5 has_children: true --- \ No newline at end of file diff --git a/docs/essay.md b/docs/essay.md index cef9baa..8051e59 100644 --- a/docs/essay.md +++ b/docs/essay.md @@ -1,8 +1,8 @@ --- layout: default title: "Essay" -parent: "Example" -nav_order: 1 +parent: "Apps" +nav_order: 2 --- # Summarization + QA agent for Paul Graham Essay diff --git a/docs/guide.md b/docs/guide.md new file mode 100644 index 0000000..711f3e9 --- /dev/null +++ b/docs/guide.md @@ -0,0 +1,37 @@ +--- +layout: default +title: "Essay" +parent: "Apps" +nav_order: 1 +--- + +# LLM System Design Guidance + +**Use LLMs to help with system design and implementation wherever possible.** + +1. **Understand Requirements** + - Clarify the app’s needs and workflow. + - Determine data access (e.g., from files or databases). + +2. **High-Level Flow Design** + - Represent the process as a *Nested Directed Graph*. + - Identify possible branching for *Node Action*. + - Identify data-heavy steps for *Batch*. + +3. **Shared Memory Structure** + - For small apps, in-memory data is sufficient. + - For larger or persistent needs, use a database. + - Define schemas or data structures and plan how states will be stored and updated. + +4. **Implementation** + - Rely on LLMs for coding tasks. + - Start with minimal, straightforward code (e.g., avoid heavy type checking initially). + +5. **Optimization** + - *Prompt Engineering:* Provide clear instructions and examples to reduce ambiguity. + - *Task Decomposition:* Break complex tasks into manageable steps. + +6. **Reliability** + - *Structured Output:* Verify outputs match the desired format, and increase `max_retries`. + - *Test Cases:* Create tests for parts of the flow with clear inputs/outputs. + - *Self-Evaluation:* For unclear areas, add another Node for LLMs to review the results. diff --git a/docs/index.md b/docs/index.md index f34e225..7a715b5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -60,7 +60,9 @@ We model the LLM workflow as a **Nested Directed Graph**: - [(Advanced) Multi-Agents](./multi_agent.md) - Evaluation -## Example Projects +## Example LLM Apps + +[LLM System Design Guidance](./guide.md) - [Summarization + QA agent for Paul Graham Essay](./essay.md) - More coming soon...