From 3b6200642b9aedee32a7588a5ea6bb2b585c3a52 Mon Sep 17 00:00:00 2001 From: zachary62 Date: Mon, 3 Mar 2025 11:00:30 -0500 Subject: [PATCH] update the doc --- docs/guide.md | 13 ++++++------- docs/index.md | 2 +- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/guide.md b/docs/guide.md index 31093cc..db87999 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -1,6 +1,6 @@ --- layout: default -title: "Development Playbook" +title: "Build your LLM App" --- # LLM Application Development Playbook @@ -22,12 +22,11 @@ These system designs should be a collaboration between humans and AI assistants: | 6. Optimization | ★★☆ Medium | ★★☆ Medium | The human reviews the code and evaluates the results, while the AI helps optimize. | | 7. Reliability | ★☆☆ Low | ★★★ High | The AI helps write test cases and address corner cases. | -1. **Project Requirements**: Clarify the requirements for your project, and evaluate whether an AI system is a good fit. - - An AI system is suitable for routine tasks that require common sense (e.g., filling out forms, replying to emails). - - An AI system is suitable for creative tasks where all inputs are provided (e.g., building slides, writing SQL). - - An AI system is **not** suitable for tasks that are highly ambiguous and require complex information inputs (e.g., building a startup). - - > **If a human can’t solve it, an LLM can’t automate it!** - Before building an LLM system, thoroughly understand the problem by manually solving example inputs to develop intuition. +1. **Project Requirements**: Clarify the requirements for your project, and evaluate whether an AI system is a good fit. An AI systems are: + - suitable for routine tasks that require common sense (e.g., filling out forms, replying to emails). + - suitable for creative tasks where all inputs are provided (e.g., building slides, writing SQL). + - **NOT** suitable for tasks that are highly ambiguous and require complex information (e.g., building a startup). + - > **If a human can’t solve it, an LLM can’t automate it!** Before building an LLM system, thoroughly understand the problem by manually solving example inputs to develop intuition. {: .best-practice } 2. **Utility Functions**: AI system is the decision-maker and relies on *external utility functions* to: diff --git a/docs/index.md b/docs/index.md index 847b1c5..e975fe8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -59,4 +59,4 @@ We model the LLM workflow as a **Nested Directed Graph**: - [(Advanced) Multi-Agents](./multi_agent.md) - Evaluation -## [LLM Application Development Playbook](./guide.md) \ No newline at end of file +## [Build your LLM App](./guide.md) \ No newline at end of file