Skip to content

Commit 9f619ed

Browse files
committed
update system design docs + assets
1 parent 033b69f commit 9f619ed

146 files changed

Lines changed: 1980 additions & 276 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

01_foundations/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@ Core concepts and foundational knowledge for building agentic AI systems.
4141
4. Study `llms/` for model integration
4242
5. Review `python/` for best practices -->
4343

44-
## 📖 Resources
44+
<!-- ## 📖 Resources
4545
4646
- [OpenAI Docs](https://platform.openai.com/docs)
4747
- [Hugging Face](https://huggingface.co/docs/transformers)
4848
- [LangChain](https://python.langchain.com/docs/get_started/introduction)
49-
- [CrewAI](https://docs.crewai.com)
49+
- [CrewAI](https://docs.crewai.com) -->
5050

5151
## 🔧 Tools & Resources
5252

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1+
# LlamaIndex
2+
3+
## Overview
4+
LlamaIndex is a framework for building AI agents that can use external data sources.
5+
6+
<!-- ## Prerequisites
7+
8+
## Usage
9+
<!-- -->
10+
## Code
111
[ ] [TBD]
212

3-
### Code
4-
- Starter codes for building agents with LangGraph can be found in the [code](./code/README.md) including:
5-
- `0_hello_world_graph.py`: Simple "Hello World" example for LangGraph.
6-
- `0_langgraph_hello_world.py`: Another basic example for LangGraph.
7-
- `1_build_basic_chatbot.py`: Basic chatbot implementation.
8-
- `2_add_tools_chatbot.py`: Chatbot with tool integration.
9-
- `3_add_memory_chatbot.py`: Chatbot with memory and context management.
10-
- `advanced_workflow.py`: Advanced workflow example.
11-
- `basic_workflow.py`: Basic workflow example.
12-
- `complete_chatbot.py`: Full-featured chatbot implementation.
13-
- `customer_support_bot.py`: Customer support bot example.
13+
## Docs
14+
- [LlamaIndex Agent Workflow](./docs/llama-index-agent-workflow.md)
15+
- [LlamaIndex Multi-Agent Workflow](./docs/llama-index-multi-agent-workflow.md)
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
"""
2+
CrewAI Starter Project Package
3+
"""
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
"""
2+
Configuration files for the CrewAI project
3+
"""

02_frameworks/5_crewai/code/starter_project/src/starter_project/main.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
#!/usr/bin/env python
22
import os
33
from dotenv import load_dotenv
4-
from starter_project.crew import ResearchAndWritingCrew
4+
from .crew import ResearchAndWritingCrew
55

66
def main():
77
"""Run the research and writing crew."""
88
# Load environment variables
99
load_dotenv()
1010

11-
# Define the topic for research and writing
11+
# Set the research topic
1212
topic = "Artificial Intelligence in Healthcare"
1313

1414
# Create and run the crew
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
"""
2+
Custom tools for the CrewAI project
3+
"""

02_frameworks/5_crewai/code/starter_template.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,26 +40,29 @@
4040
research_task = Task(
4141
description="""Research the topic 'The Impact of Artificial Intelligence on Healthcare'
4242
and gather key information about recent developments, benefits, and challenges.""",
43-
agent=researcher
43+
agent=researcher,
44+
expected_output="A summary of recent developments, benefits, and challenges of AI in healthcare."
4445
)
4546

4647
write_task = Task(
4748
description="""Write a comprehensive article about 'The Impact of Artificial Intelligence
4849
on Healthcare' based on the research provided. Focus on making it engaging and informative.""",
49-
agent=writer
50+
agent=writer,
51+
expected_output="A well-structured, engaging, and informative article about AI in healthcare."
5052
)
5153

5254
review_task = Task(
5355
description="""Review the article about AI in healthcare. Check for accuracy, clarity,
5456
and engagement. Provide suggestions for improvement.""",
55-
agent=reviewer
57+
agent=reviewer,
58+
expected_output="A list of suggestions and corrections to improve the article's accuracy, clarity, and engagement."
5659
)
5760

5861
# Create Crew
5962
crew = Crew(
6063
agents=[researcher, writer, reviewer],
6164
tasks=[research_task, write_task, review_task],
62-
verbose=2,
65+
verbose=True,
6366
process=Process.sequential
6467
)
6568

03_system_design/RAGs/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Multi-Modal RAGs
2+
![Multi-Modal RAGs](../../assets/RAGs/multimodal-RAG-o3-1.png)
3+
![Multi-Modal RAGs](../../assets/RAGs/multimodal-RAG-o1-1.png)
4+
![Multi-Modal RAGs](../../assets/RAGs/multimodal-RAG-o3-2.png)
5+
![Multi-Modal RAGs](../../assets/RAGs/multimodal-RAG-o3-3.png)
6+
### CRAGS
7+
![CRAGs](../../assets/RAGs/CRAG.png)
8+
### Self-RAGs
9+
![Self-RAGs](../../assets/RAGs/Self-RAG.png)
10+
### Agentic-RAGs
11+
![Agentic-RAGs](../../assets/RAGs/Agentic-RAG.png)
12+
![Agentic-RAGs](../../assets/RAGs/Agentic-RAG-2.png)
13+
![Agentic-RAGs](../../assets/RAGs/Agentic-RAG-3.png)
14+
### Adaptive-RAGs
15+
![Adaptive-RAGs](../../assets/RAGs/adaptive-RAG.png)
16+
### KG-RAGs
17+
![KG-RAGs](../../assets/RAGs/KG-RAG.png)
18+
19+
20+
## Examples
21+
### Uber
22+
- [Enhanced Agentic RAG at Uber (Uber Blog)](https://www.uber.com/blog/enhanced-agentic-rag/?utm_source=chatgpt.com)
23+
![Agentic RAG Architecture](../../assets/RAGs/uber-agentic-rag-architecture.png)
24+
<!-- - [ ] summary (tba) -->
25+
26+
27+
28+

03_system_design/README.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# System Design for Agentic AI Systems
2+
3+
This directory contains comprehensive resources for designing and architecting agentic AI systems. It covers everything from high-level architectural patterns to specific implementation cookbooks and evaluation methodologies.
4+
5+
## Directory Structure
6+
7+
### [Architectures](./architectures/)
8+
Comprehensive system architecture designs and blueprints for agentic AI systems.
9+
10+
**Key Resources:**
11+
- [12-Step Agentic System Design Methodology](./architectures/ASD-12-step-v1.5.md) - Complete methodology for designing agentic systems
12+
- [Future Trends in Agentic Architecture](./architectures/agentic-arch-future.md) - Emerging trends and future directions
13+
- [Philosophical Agent System Design](./architectures/philoagent_system_architecture.md) - Philosophical foundations for agent design
14+
- [Modern AI Technology Stack](./architectures/AI-stack.md) - Overview of current AI technology stack
15+
- [AI-Native Application Design](./architectures/ai-native-1.md) - Principles for AI-native applications
16+
- [NVIDIA's Agentic AI Approach](./architectures/agentic-ai-nvidia.md) - NVIDIA's perspective on agentic AI
17+
18+
### [Design Patterns](./design-patterns/)
19+
Design patterns and templates for building agentic systems with code examples and implementation details.
20+
21+
**Key Resources:**
22+
- [Extended Design Patterns with Code](./design-patterns/AI-Agent-Design-Patterns-v1.3.md) - Design patterns with implementation examples
23+
- [Design Patterns with Code Examples](./design-patterns/patterns_w_codes.md) - Practical code examples for design patterns
24+
- [Reflexion Pattern Implementation](./design-patterns/Reflexion.md) - Implementation guide for the Reflexion pattern
25+
- [Design Patterns Overview](./design-patterns/README.md) - Overview of available design patterns
26+
27+
### [Cookbooks](./cookbooks/)
28+
Practical implementation guides and tutorials for building agentic systems.
29+
30+
**Key Resources:**
31+
- [A Practical Guide to AI Agents](./cookbooks/A-Practical-Guide-to-AI-Agents-updated.pdf) - Snowflake's comprehensive practical guide
32+
- [Building Effective Agents](./cookbooks/anthropic-build_effective_agents.md) - Anthropic's guide to building effective agents
33+
- [Compound AI Systems Implementation](./cookbooks/compund-ai-systems.md) - Implementation guide for compound AI systems
34+
35+
### [Agentic AI](./agentic-ai/)
36+
Specialized resources focused on agentic AI system design.
37+
38+
**Key Resources:**
39+
- [Agentic System Design Methodology](./agentic-ai/ASD-12-step-v1.5.md) - Specialized version of the 12-step methodology
40+
41+
### [Layers](./layers/)
42+
Architectural layer designs and cognitive layer implementations.
43+
44+
**Key Resources:**
45+
- [Cognitive Layer Architecture](./layers/_cognition_layer.md) - Design patterns for cognitive layers
46+
- [Reasoning and Planning Layer](./layers/_cognition_reason+plan.md) - Reasoning and planning layer design
47+
48+
### [RAGs](./RAGs/)
49+
Retrieval-Augmented Generation systems and architectures.
50+
51+
**Key Resources:**
52+
- [RAG Architectures Overview](./RAGs/README.md) - Comprehensive overview of RAG architectures
53+
- Multi-modal RAG implementations
54+
- CRAGs, Self-RAGs, Agentic-RAGs, Adaptive-RAGs, KG-RAGs
55+
- Real-world examples including Uber's Enhanced Agentic RAG
56+
57+
### [Evals](./evals/)
58+
Evaluation methodologies and frameworks for agentic systems.
59+
60+
**Key Resources:**
61+
- [Agent Evaluation Frameworks](./evals/agents_evals.md) - Comprehensive evaluation methodologies for agents
62+
63+
### [Protocols](./protocols/)
64+
Communication protocols and standards for agentic systems.
65+
66+
**Key Resources:**
67+
- [AI Communication Protocols](./protocols/protocols-AI.md) - Standards and protocols for AI communication
68+
69+
### [Memory](./memory/)
70+
Memory systems and architectures for agentic AI.
71+
72+
*Currently empty - placeholder for memory system designs*
73+
74+
<!-- ## Getting Started
75+
76+
1. **Start with Architectures**: Begin with the 12-step ASD methodology in [architectures/ASD-12-step-v1.5.md](./architectures/ASD-12-step-v1.5.md)
77+
2. **Explore Design Patterns**: Review the design patterns in [design-patterns/](./design-patterns/)
78+
3. **Study Real Examples**: Check out the cookbooks for practical implementation guides
79+
4. **Understand RAG Systems**: Explore the RAGs directory for retrieval-augmented generation patterns
80+
5. **Evaluate Your System**: Use the evaluation frameworks in the evals directory
81+
82+
## Additional Resources
83+
84+
See [SD_resources.md](./SD_resources.md) for curated external resources including:
85+
- Industry guides from Snowflake, Anthropic, and others
86+
- Big company implementations (AWS, Airbnb, Uber, NVIDIA)
87+
- Academic and research papers
88+
- Video tutorials and walkthroughs
89+
90+
## Key Design Principles
91+
92+
- **Modularity**: Design systems with clear separation of concerns
93+
- **Scalability**: Plan for growth and performance at scale
94+
- **Reliability**: Implement robust error handling and fallback mechanisms
95+
- **Security**: Consider safety and security from the ground up
96+
- **Evaluability**: Build systems that can be measured and improved
97+
98+
## Contributing
99+
100+
When adding new content:
101+
1. Follow the existing directory structure
102+
2. Include comprehensive documentation
103+
3. Provide code examples where applicable
104+
4. Update this README with new sections
105+
5. Ensure all files are properly referenced -->
106+
107+
---
108+
109+
*This directory serves as a comprehensive resource for designing, implementing, and evaluating agentic AI systems. Each subdirectory contains specialized knowledge and practical examples to help you build robust, scalable, and effective AI agent systems.*

03_system_design/SD_resources.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
- [A Practical Guide to AI Agents (Snowflake)](https://www.snowflake.com/thankyou/a-practical-guide-to-ai-agents/)
2+
- [Introduction to Agentic AI and Its Design Patterns (Lekha Bhan, Medium)](https://lekha-bhan88.medium.com/introduction-to-agentic-ai-and-its-design-patterns-af8b7b3ef738)
3+
- [Designing Agentic AI Systems, Part 1: Agent Architectures (Vectorize.io)](https://vectorize.io/designing-agentic-ai-systems-part-1-agent-architectures/)
4+
- [Design Considerations of Advanced Agentic AI for Real-World Applications (Indrajit Kar, Medium)](https://medium.com/@official.indrajit.kar/design-considerations-of-advanced-agentic-ai-for-real-world-applications-c5ef317ba1e1)
5+
6+
## Agentic AI at Big Companies
7+
- [Agentic AI Design Patterns Introduction and walkthrough | AWS (YouTube)](https://www.youtube.com/watch?v=MrD9tCNpOvU&ab_channel=AmazonWebServices)
8+
- [Automation Platform v2: Improving Conversational AI at Airbnb (Airbnb Engineering, Medium)](https://medium.com/airbnb-engineering/automation-platform-v2-improving-conversational-ai-at-airbnb-d86c9386e0cb)
9+
- [Enhanced Agentic RAG at Uber (Uber Blog)](https://www.uber.com/blog/enhanced-agentic-rag/?utm_source=chatgpt.com)
10+
- [Intelligent Automation Platform: Empowering Conversational AI and Beyond at Airbnb (Airbnb Tech Blog)](https://airbnb.tech/ai-ml/intelligent-automation-platform-empowering-conversational-ai-and-beyond-at-airbnb/?utm_source=chatgpt.com)
11+
- [What is Agentic AI? (NVIDIA Blog)](https://blogs.nvidia.com/blog/what-is-agentic-ai/?utm_source=chatgpt.com)

0 commit comments

Comments
 (0)