phowell
/
pocketflow
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update utility

This commit is contained in:
zachary62 2025-03-17 12:11:19 -04:00
parent 21744b7a3f
commit bd31c6ae80
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/index.md
View File

@ -49,13 +49,7 @@ From there, it’s easy to implement popular design patterns:
## Utility Function ## Utility Function
We **DON'T** provide built-in utility functions. Instead, please implement your own. I believe it is a **bad practice** to provide vendor-specific implementations in a general framework: We **do not** provide built-in utilities. Instead, we offer **example** implementations for common needs—please **implement your own**.
- **Vendor APIs change frequently**. Hardcoding them makes maintenance a nightmare.
- You may need **flexibility** to switch vendors, use fine-tuned models, or deploy local LLMs.
- You may need **optimizations** like prompt caching, request batching, or response streaming.
However, we provide example implementations for commonly used utility functions.
- [LLM Wrapper](./utility_function/llm.md) - [LLM Wrapper](./utility_function/llm.md)
- [Viz and Debug](./utility_function/viz.md) - [Viz and Debug](./utility_function/viz.md)
@ -65,4 +59,9 @@ However, we provide example implementations for commonly used utility functions.
- [Vector Databases](./utility_function/vector.md) - [Vector Databases](./utility_function/vector.md)
- [Text-to-Speech](./utility_function/text_to_speech.md) - [Text-to-Speech](./utility_function/text_to_speech.md)
**Why not built-in utilities?**: I believe it's a *bad practice* to embed vendor-specific APIs in a general framework:
- **API Volatility**: Frequent changes lead to heavy maintenance for hardcoded APIs.
- **Flexibility**: You may want to switch vendors, use fine-tuned models, or run them locally.
- **Optimizations**: Prompt caching, batching, and streaming are easier when you’re not locked into a single vendor.
## Ready to build your Apps? [Learn Agentic Coding!](./guide.md) ## Ready to build your Apps? [Learn Agentic Coding!](./guide.md)