You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .devcontainer/README.md
+28-13
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,43 @@
1
-
# README for AutoGen Docker Samples
1
+
# Dockerfiles and Devcontainer Configurations for AutoGen
2
2
3
-
Welcome to the `autogen/samples/dockers` directory! Here you'll find Dockerfiles that are essential for setting up your AutoGen development environment. Each Dockerfile is tailored for different use cases and requirements. Below is a brief overview of each and how you can utilize them effectively.
3
+
Welcome to the `.devcontainer` directory! Here you'll find Dockerfiles and devcontainer configurations that are essential for setting up your AutoGen development environment. Each Dockerfile is tailored for different use cases and requirements. Below is a brief overview of each and how you can utilize them effectively.
4
+
5
+
These configurations can be used with Codespaces and locally.
4
6
5
7
## Dockerfile Descriptions
6
8
7
-
### Dockerfile.base
9
+
### base
8
10
9
-
-**Purpose**: This Dockerfile is designed for basic setups. It includes common Python libraries and essential dependencies required for general usage of AutoGen.
11
+
-**Purpose**: This Dockerfile, i.e., `./Dockerfile`, is designed for basic setups. It includes common Python libraries and essential dependencies required for general usage of AutoGen.
10
12
-**Usage**: Ideal for those just starting with AutoGen or for general-purpose applications.
11
-
-**Building the Image**: Run `docker build -f Dockerfile.base -t autogen_base_img .` in this directory.
13
+
-**Building the Image**: Run `docker build -f ./Dockerfile -t autogen_base_img .` in this directory.
14
+
-**Using with Codespaces**: `Code > Codespaces > Click on +` By default + creates a Codespace on the current branch.
12
15
13
-
### Dockerfile.full
16
+
### full
14
17
15
-
-**Purpose**: This Dockerfile is for advanced features. It includes additional dependencies and is configured for more complex or feature-rich AutoGen applications.
18
+
-**Purpose**: This Dockerfile, i.e., `./full/Dockerfile` is for advanced features. It includes additional dependencies and is configured for more complex or feature-rich AutoGen applications.
16
19
-**Usage**: Suited for advanced users who need the full range of AutoGen's capabilities.
-**Using with Codespaces**: `Code > Codespaces > Click on ...> New with options > Choose "full" as devcontainer configuration`. This image may require a Codespace with at least 64GB of disk space.
18
22
19
-
### Dockerfile.dev
23
+
### dev
20
24
21
-
-**Purpose**: Tailored for AutoGen project developers, this Dockerfile includes tools and configurations aiding in development and contribution.
25
+
-**Purpose**: Tailored for AutoGen project developers, this Dockerfile, i.e., `./dev/Dockerfile` includes tools and configurations aiding in development and contribution.
22
26
-**Usage**: Recommended for developers who are contributing to the AutoGen project.
23
-
-**Building the Image**: Run `docker build -f Dockerfile.dev -t autogen_dev_img .`.
27
+
-**Building the Image**: Run `docker build -f dev/Dockerfile -t autogen_dev_img .`.
28
+
-**Using with Codespaces**: `Code > Codespaces > Click on ...> New with options > Choose "dev" as devcontainer configuration`. This image may require a Codespace with at least 64GB of disk space.
24
29
-**Before using**: We highly encourage all potential contributors to read the [AutoGen Contributing](https://microsoft.github.io/autogen/docs/Contribute) page prior to submitting any pull requests.
25
30
31
+
32
+
### studio
33
+
34
+
-**Purpose**: Tailored for AutoGen project developers, this Dockerfile, i.e., `./studio/Dockerfile`, includes tools and configurations aiding in development and contribution.
35
+
-**Usage**: Recommended for developers who are contributing to the AutoGen project.
36
+
-**Building the Image**: Run `docker build -f studio/Dockerfile -t autogen_studio_img .`.
37
+
-**Using with Codespaces**: `Code > Codespaces > Click on ...> New with options > Choose "studio" as devcontainer configuration`.
38
+
-**Before using**: We highly encourage all potential contributors to read the [AutoGen Contributing](https://microsoft.github.io/autogen/docs/Contribute) page prior to submitting any pull requests.
39
+
40
+
26
41
## Customizing Dockerfiles
27
42
28
43
Feel free to modify these Dockerfiles for your specific project needs. Here are some common customizations:
@@ -33,9 +48,9 @@ Feel free to modify these Dockerfiles for your specific project needs. Here are
33
48
`FROM python:3.11-slim-bookworm` to `FROM python:3.10-slim-bookworm`
34
49
-**Setting Environment Variables**: Add environment variables using the `ENV` command for any application-specific configurations. We have prestaged the line needed to inject your OpenAI_key into the docker environment as a environmental variable. Others can be staged in the same way. Just uncomment the line.
35
50
`# ENV OPENAI_API_KEY="{OpenAI-API-Key}"` to `ENV OPENAI_API_KEY="{OpenAI-API-Key}"`
36
-
-**Need a less "Advanced" Autogen build**: If the Dockerfile.full is to much but you need more than advanced then update this line in the Dockerfile.full file.
51
+
-**Need a less "Advanced" Autogen build**: If the `./full/Dockerfile` is to much but you need more than advanced then update this line in the Dockerfile file.
37
52
`RUN pip install pyautogen[teachable,lmm,retrievechat,mathchat,blendsearch] autogenra` to install just what you need. `RUN pip install pyautogen[retrievechat,blendsearch] autogenra`
38
-
-**Can't Dev without your favorite CLI tool**: if you need particular OS tools to be installed in your Docker container you can add those packages here right after the sudo for the Dockerfile.base and Dockerfile.full files. In the example below we are installing net-tools and vim to the environment.
53
+
-**Can't Dev without your favorite CLI tool**: if you need particular OS tools to be installed in your Docker container you can add those packages here right after the sudo for the `./base/Dockerfile` and `./full/Dockerfile` files. In the example below we are installing net-tools and vim to the environment.
0 commit comments