Skip to content

Commit 5070893

Browse files
committed
fix: lint adk-cerebras README
1 parent 9010be7 commit 5070893

File tree

1 file changed

+33
-13
lines changed

1 file changed

+33
-13
lines changed

adk-cerebras/README.md

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,39 @@
11
# DevDuck agents
22

3-
A multi-agent system for Go programming assistance built with Google Agent Development Kit (ADK). This project features a coordinating agent (DevDuck) that manages two specialized sub-agents (Bob and Cerebras) for different programming tasks.
3+
A multi-agent system for Go programming assistance built with Google Agent Development Kit (ADK). This
4+
project features a coordinating agent (DevDuck) that manages two specialized sub-agents (Bob and
5+
Cerebras) for different programming tasks.
46

57
## Architecture
68

7-
The system consists of three main agents orchestrated by Docker Compose, which plays a **primordial role** in launching and coordinating all agent services:
9+
The system consists of three main agents orchestrated by Docker Compose, which plays a
10+
**primordial role** in launching and coordinating all agent services:
811

912
### 🐙 Docker Compose Orchestration
13+
1014
- **Central Role**: Docker Compose serves as the foundation for the entire multi-agent system
1115
- **Service Orchestration**: Manages the lifecycle of all three agents (DevDuck, Bob, and Cerebras)
12-
- **Configuration Management**: Defines agent prompts, model configurations, and service dependencies directly in the compose file
16+
- **Configuration Management**: Defines agent prompts, model configurations, and service dependencies
17+
directly in the compose file
1318
- **Network Coordination**: Establishes secure inter-agent communication channels
1419
- **Environment Management**: Handles API keys, model parameters, and runtime configurations
1520

16-
### Agent Components:
21+
### Agent Components
1722

1823
### 🦆 DevDuck (Main Agent)
24+
1925
- **Role**: Main development assistant and project coordinator
2026
- **Model**: Qwen3 (unsloth/qwen3-gguf:4B-UD-Q4_K_XL)
2127
- **Capabilities**: Routes requests to appropriate sub-agents based on user needs
2228

2329
### 👨‍💻 Bob Agent
30+
2431
- **Role**: General development tasks and project coordination
2532
- **Model**: Qwen2.5 (ai/qwen2.5:latest)
2633
- **Specialization**: Go programming expert for understanding code, explaining concepts, and generating code snippets
2734

2835
### 🧠 Cerebras Agent
36+
2937
- **Role**: Advanced computational tasks and complex problem-solving
3038
- **Model**: Llama-4 Scout (llama-4-scout-17b-16e-instruct)
3139
- **Provider**: Cerebras API
@@ -43,21 +51,25 @@ The system consists of three main agents orchestrated by Docker Compose, which p
4351

4452
### Prerequisites
4553

46-
+ **[Docker Desktop](https://www.docker.com/products/docker-desktop/) 4.43.0+ or [Docker Engine](https://docs.docker.com/engine/)** installed
47-
+ **A laptop or workstation with a GPU** (e.g., a MacBook) for running open models locally. If you don't have a GPU, you can alternatively use [**Docker Offload**](https://www.docker.com/products/docker-offload).
48-
+ If you're using Docker Engine on Linux or Docker Desktop on Windows, ensure that the [Docker Model Runner requirements](https://docs.docker.com/ai/model-runner/) are met (specifically that GPU support is enabled) and the necessary drivers are installed
49-
+ If you're using Docker Engine on Linux, ensure you have Compose 2.38.1 or later installed
54+
- **[Docker Desktop] 4.43.0+ or [Docker Engine]** installed.
55+
- **A laptop or workstation with a GPU** (e.g., a MacBook) for running open models locally. If you
56+
don't have a GPU, you can alternatively use **[Docker Offload]**.
57+
- If you're using [Docker Engine] on Linux or [Docker Desktop] on Windows, ensure that the
58+
[Docker Model Runner requirements] are met (specifically that GPU
59+
support is enabled) and the necessary drivers are installed.
60+
- If you're using Docker Engine on Linux, ensure you have [Docker Compose] 2.38.1 or later installed.
5061

5162
### Configuration
5263

53-
1. **You need a Cerebras API Key**: https://cloud.cerebras.ai/
64+
1. **You need a Cerebras API Key**: <https://cloud.cerebras.ai/>
5465
2. Create a `.env` file with the following content:
5566

5667
```env
5768
CEREBRAS_API_KEY=<your_cerebras_api_key>
5869
CEREBRAS_BASE_URL=https://api.cerebras.ai/v1
5970
CEREBRAS_CHAT_MODEL=llama-4-scout-17b-16e-instruct
6071
```
72+
6173
> look at the `.env.sample` file
6274
6375
### ✋ All the prompts are defined in the 🐙 compose file
@@ -71,14 +83,14 @@ docker compose up
7183

7284
The application will be available at [http://0.0.0.0:8000](http://0.0.0.0:8000)
7385

74-
7586
### Usage
7687

7788
The agents can be accessed through the web interface or API endpoints.
7889

7990
> Activate Token Streaming
8091
8192
**You can try this**:
93+
8294
```text
8395
Hello I'm Phil
8496
@@ -90,20 +102,28 @@ Cerebras can you analyse and comment this code
90102
91103
Can you generate the tests
92104
```
105+
93106
> ✋ For a public demo, stay simple, the above examples are working.
94107
95108
**🎥 How to use the demo**: [https://youtu.be/WYB31bzfXnM](https://youtu.be/WYB31bzfXnM)
96109

97110
#### Routing Requests
98111

99112
- **General requests**: Handled by DevDuck, who routes to appropriate sub-agents
100-
- **Specific agent requests**:
101-
- "I want to speak with Bob" → Routes to Bob agent
102-
- "I want to speak with Cerebras" → Routes to Cerebras agent
113+
- **Specific agent requests**
114+
+ "I want to speak with Bob" → Routes to Bob agent
115+
+ "I want to speak with Cerebras" → Routes to Cerebras agent
103116

104117
## Tips
105118

106119
If for any reason, you cannot go back from the Cerebras agent to the Bob agent, try this:
120+
107121
```text
108122
go back to devduck
109123
```
124+
125+
[Docker Compose]: https://github.com/docker/compose
126+
[Docker Desktop]: https://www.docker.com/products/docker-desktop/
127+
[Docker Engine]: https://docs.docker.com/engine/
128+
[Docker Model Runner requirements]: https://docs.docker.com/ai/model-runner/
129+
[Docker Offload]: https://www.docker.com/products/docker-offload/

0 commit comments

Comments
 (0)