Skip to content

Commit 36b8bc4

Browse files
authored
Merge pull request #32 from docker/cm/readme-2
New readme
2 parents 70d0c60 + d0c16f1 commit 36b8bc4

File tree

2 files changed

+49
-19
lines changed

2 files changed

+49
-19
lines changed

README.md

Lines changed: 49 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,44 @@
1+
**This README is an agentic workflow**
2+
13
# AI Tools for Developers
24

35
Agentic AI workflows enabled by Docker containers.
46

7+
Just Docker. Just Markdown. BYOLLM.
8+
59
![overall architecture diagram preview](img1.png)
610

711
Source for many experiments in our [LinkedIn newsletter](https://www.linkedin.com/newsletters/docker-labs-genai-7204877599427194882/)
812

9-
Docker Desktop Extension: https://hub.docker.com/extensions/docker/labs-ai-tools-for-devs
13+
[**VSCode Extension**](https://github.com/docker/labs-ai-tools-vscode)
1014

11-
VSCode Extension: https://github.com/docker/labs-make-runbook
15+
[**Docs**](https://vonwig.github.io/prompts.docs/)
1216

1317
# What is this?
1418

19+
This is a simple Docker image which enables infinite possibilities for novel workflows by combining Dockerized Tools, Markdown, and the LLM of your choice.
20+
21+
## Markdown is the language
22+
23+
Humans already speak it. So do LLM's. This software allows you to write complex workflows in a markdown files, and then run them with your own LLM in your editor or terminal...or any environment, thanks to Docker.
24+
25+
## Dockerized Tools
26+
![dockerized tools](img4.png)
27+
28+
OpenAI API compatiable LLM's already support tool calling. We believe these tools could just be Docker images. Some of the benefits using Docker based on our [research](https://www.linkedin.com/newsletters/docker-labs-genai-7204877599427194882/) are enabling the LLM to:
29+
- take more complex actions
30+
- get more context with fewer tokens
31+
- work across a wider range of environments
32+
- operate in a sandboxed environment
33+
34+
## Conversation *Loop*
35+
The conversation loop is the core of each workflow. Tool results, agent responses, and of course, the markdown prompts, are all passed through the loop. If an agent sees an error, it will try running the tool with different parameters, or even different tools until it gets the right result.
36+
37+
## Multi-Model Agents
38+
Each prompt can be configured to be run with different LLM models, or even different model families. This allows you to use the best tool for the job. When you combine these tools, you can create multi-agent workflows where each agent runs with the model best suited for that task.
39+
40+
With Docker, it is possible to have frontier models plan, while lightweight local models execute.
41+
1542
## Project-First Design
1643
To get help from an assistant in your software development loop, the only context necessary is the project you are working on.
1744

@@ -23,27 +50,24 @@ An extractor is a Docker image that runs against a project and extracts informat
2350
## Prompts as a trackable artifact
2451
![prompts as a trackable artifact](img3.png)
2552

26-
Prompts are stored in a git repo and can be versioned, tracked, and shared.
27-
28-
## Dockerized Tools
29-
![dockerized tools](img4.png)
30-
31-
OpenAI API compatiable LLM's already support function calling. This is our workbench to test the same spec, but with functions as Docker images. Some of the benefits using Docker based on our [research](https://www.linkedin.com/newsletters/docker-labs-genai-7204877599427194882/) are enabling the LLM to:
32-
- take more complex actions
33-
- deliver relevant context to the LLM without too many tokens
34-
- work across a wider range of environments
35-
- operate in a sandboxed environment
53+
Prompts are stored in a git repo and can be versioned, tracked, and shared for anyone to run in their own environment.
3654

3755
# Get Started
56+
We highly recommend using the VSCode extension to get started. It will help you create prompts, and run them with your own LLM.
57+
58+
You can install it in one-click with our Docker Desktop Extension:
59+
https://hub.docker.com/extensions/docker/labs-vscode-installer
3860

39-
## Running a Conversation Loop
61+
## Running your first loop
62+
Instructions assume you have a terminal open, and Docker Desktop running.
4063

41-
Set OpenAI key
64+
1. Set OpenAI key
4265
```sh
4366
echo $OPENAI_API_KEY > $HOME/.openai-api-key
4467
```
68+
Note: we assume this file exists, so you must set a dummy value for local models.
4569

46-
Run
70+
2. Run the container in your project directory
4771

4872
```sh
4973
docker run
@@ -61,10 +85,7 @@ docker run
6185
--prompts "github:docker/labs-githooks?ref=main&path=prompts/git_hooks"
6286
```
6387

64-
See [docs](https://vonwig.github.io/prompts.docs/#/page/running%20the%20prompt%20engine) for more details on how to run the conversation loop,
65-
and especially how to use it to run local prompts that are not yet in GitHub.
66-
67-
[PROMPTS KNOWLEDGE GRAPH](https://vonwig.github.io/prompts.docs/#/page/index)
88+
See [docs](https://vonwig.github.io/prompts.docs/#/page/running%20the%20prompt%20engine) for more details on how to run the conversation loop.
6889

6990
## Building
7091

@@ -74,3 +95,12 @@ and especially how to use it to run local prompts that are not yet in GitHub.
7495
docker build -t vonwig/prompts:local -f Dockerfile .
7596
```
7697

98+
Now, for the agentic workflow...
99+
100+
# prompt system
101+
102+
You are an expert at software development, so of course you know how great Docker is. Just tell people how great Docker is.
103+
104+
# prompt user
105+
106+
Why is Docker great?

img4.png

192 KB
Loading

0 commit comments

Comments
 (0)