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: README.md
+6-12
Original file line number
Diff line number
Diff line change
@@ -62,18 +62,12 @@ The easiest way to start playing is
62
62
3. Start playing with the notebooks!
63
63
64
64
*NOTE*: OAI_CONFIG_LIST_sample lists GPT-4 as the default model, as this represents our current recommendation, and is known to work well with AutoGen. If you use a model other than GPT-4, you may need to revise various system prompts (especially if using weaker models like GPT-3.5-turbo). Moreover, if you use models other than those hosted by OpenAI or Azure, you may incur additional risks related to alignment and safety. Proceed with caution if updating this default.
Install docker, save your oai key into an environment variable name OPENAI_API_KEY, and then run the following.
68
+
Find detailed instructions for users [here](https://microsoft.github.io/autogen/docs/Installation#option-1-install-and-run-autogen-in-docker), and for developers [here](https://microsoft.github.io/autogen/docs/Contribute#docker).
68
69
69
-
```
70
-
docker pull yuandongtian/autogen:latest
71
-
docker run -it -e OPENAI_API_KEY=$OPENAI_API_KEY -p 8081:8081 docker.io/yuandongtian/autogen:latest
72
-
```
73
-
74
-
Then open `http://localhost:8081/` in your browser to use AutoGen. The UI is from `./samples/apps/autogen-assistant`. See docker hub [link](https://hub.docker.com/r/yuandongtian/autogen) for more details.
75
-
76
-
## Installation
70
+
### Option 2. Install AutoGen Locally
77
71
78
72
AutoGen requires **Python version >= 3.8, < 3.12**. It can be installed from pip:
79
73
@@ -88,11 +82,11 @@ Minimal dependencies are installed without extra options. You can install extra
88
82
pip install "pyautogen[blendsearch]"
89
83
``` -->
90
84
91
-
Find more options in [Installation](https://microsoft.github.io/autogen/docs/Installation).
85
+
Find more options in [Installation](https://microsoft.github.io/autogen/docs/Installation#option-2-install-autogen-locally-using-virtual-environment).
92
86
93
87
<!-- Each of the [`notebook examples`](https://github.com/microsoft/autogen/tree/main/notebook) may require a specific option to be installed. -->
94
88
95
-
For [code execution](https://microsoft.github.io/autogen/docs/FAQ/#code-execution), we strongly recommend installing the Python docker package and using docker.
89
+
Even if you are installing AutoGen locally out of docker, we recommend performing [code execution](https://microsoft.github.io/autogen/docs/FAQ/#code-execution) in docker. Find more instructions [here](https://microsoft.github.io/autogen/docs/Installation#docker).
96
90
97
91
For LLM inference configurations, check the [FAQs](https://microsoft.github.io/autogen/docs/FAQ#set-your-api-endpoints).
Copy file name to clipboardExpand all lines: website/docs/FAQ.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -71,8 +71,8 @@ The `AssistantAgent` doesn't save all the code by default, because there are cas
71
71
72
72
We strongly recommend using docker to execute code. There are two ways to use docker:
73
73
74
-
1. Run autogen in a docker container. For example, when developing in GitHub codespace, the autogen runs in a docker container.
75
-
2. Run autogen outside of a docker, while perform code execution with a docker container. For this option, make sure the python package `docker` is installed. When it is not installed and `use_docker` is omitted in `code_execution_config`, the code will be executed locally (this behavior is subject to change in future).
74
+
1. Run AutoGen in a docker container. For example, when developing in [GitHub codespace](https://codespaces.new/microsoft/autogen?quickstart=1), AutoGen runs in a docker container. If you are not developing in Github codespace, follow instructions [here](Installation.md#option-1-install-and-run-autogen-in-docker) to install and run AutoGen in docker.
75
+
2. Run AutoGen outside of a docker, while performing code execution with a docker container. For this option, set up docker and make sure the python package `docker` is installed. When not installed and `use_docker` is omitted in `code_execution_config`, the code will be executed locally (this behavior is subject to change in future).
Copy file name to clipboardExpand all lines: website/docs/Installation.md
+61-8
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,50 @@
1
1
# Installation
2
2
3
-
## Setup Virtual Environment
3
+
## Option 1: Install and Run AutoGen in Docker
4
4
5
-
When not using a docker container, we recommend using a virtual environment to install AutoGen. This will ensure that the dependencies for AutoGen are isolated from the rest of your system.
5
+
[Docker](https://www.docker.com/) is a containerization platform that simplifies the setup and execution of your code. A properly built docker image could provide isolated and consistent environment to run your code securely across platforms. One option of using AutoGen is to install and run it in a docker container. You can do that in [Github codespace](https://codespaces.new/microsoft/autogen?quickstart=1) or follow the instructions below to do so.
6
6
7
-
### Option 1: venv
7
+
#### Step 1. Install Docker.
8
+
9
+
Install docker following [this instruction](https://docs.docker.com/get-docker/).
10
+
11
+
For Mac users, alternatively you may choose to install [colima](https://smallsharpsoftwaretools.com/tutorials/use-colima-to-run-docker-containers-on-macos/) to run docker containers, if there is any issues with starting the docker daemon.
12
+
13
+
#### Step 2. Build a docker image
14
+
15
+
AutoGen provides [dockerfiles](https://github.com/microsoft/autogen/tree/main/samples/dockers/) that could be used to build docker images. Use the following command line to build a docker image named `autogen_img` (or other names you prefer) from one of the provided dockerfiles named `Dockerfile.base`:
which includes some common python libraries and essential dependencies of AutoGen, or build from `Dockerfile.full` which include additional dependencies for more advanced features of AutoGen with the following command line:
Once you build the docker image, you can use `docker images` to check whether it has been created successfully.
26
+
27
+
#### Step 3. Run applications built with AutoGen from a docker image.
28
+
29
+
**Mount your code to the docker image and run your application from there:** Now suppose you have your application built with AutoGen in a main script named `twoagent.py` ([example](https://github.com/microsoft/autogen/blob/main/test/twoagent.py)) in a folder named `myapp`. With the command line below, you can mont your folder and run the application in docker.
30
+
31
+
```python
32
+
# Mount the local folder `myapp` into docker image and run the script named "twoagent.py" in the docker.
33
+
docker run -it -v `pwd`/myapp:/myapp autogen_img:latest python /myapp/main_twoagent.py
34
+
```
35
+
36
+
<!-- You may also run [AutoGen Studio](https://github.com/microsoft/autogen/tree/main/samples/apps/autogen-studio) (assuming that you have built a docker image named `autogen_full_img` with `Dockerfile.full` and you have set the environment variable `OPENAI_API_KEY` to your OpenAI API key) as below:
Then open `http://localhost:8081/` in your browser to use AutoGen Studio. -->
42
+
43
+
## Option 2: Install AutoGen Locally Using Virtual Environment
44
+
45
+
When installing AutoGen locally, we recommend using a virtual environment for the installation. This will ensure that the dependencies for AutoGen are isolated from the rest of your system.
46
+
47
+
### Option a: venv
8
48
9
49
You can create a virtual environment with `venv` as below:
10
50
```bash
@@ -17,9 +57,9 @@ The following command will deactivate the current `venv` environment:
17
57
deactivate
18
58
```
19
59
20
-
### Option 2: conda
60
+
### Option b: conda
21
61
22
-
Another option is with `Conda`, Conda works better at solving dependency conflicts than pip. You can install it by following [this doc](https://docs.conda.io/projects/conda/en/stable/user-guide/install/index.html),
62
+
Another option is with `Conda`. You can install it by following [this doc](https://docs.conda.io/projects/conda/en/stable/user-guide/install/index.html),
23
63
and then create a virtual environment as below:
24
64
```bash
25
65
conda create -n pyautogen python=3.10 # python 3.10 is recommended as it's stable and not too old
@@ -31,7 +71,7 @@ The following command will deactivate the current `conda` environment:
31
71
conda deactivate
32
72
```
33
73
34
-
### Option 3: poetry
74
+
### Option c: poetry
35
75
36
76
Another option is with `poetry`, which is a dependency manager for Python.
37
77
@@ -93,13 +133,26 @@ Inference parameter tuning can be done via [`flaml.tune`](https://microsoft.gith
93
133
### Optional Dependencies
94
134
-#### docker
95
135
96
-
For the best user experience and seamless code execution, we highly recommend using Docker with AutoGen. Docker is a containerization platform that simplifies the setup and execution of your code. Developing in a docker container, such as GitHub Codespace, also makes the development convenient.
136
+
Even if you install AutoGen locally, we highly recommend using Docker for [code execution](FAQ.md#enable-python-3-docker-image).
97
137
98
-
When running AutoGen out of a docker container, to use docker for code execution, you also need to install the python package `docker`:
138
+
To use docker for code execution, you also need to install the python package `docker`:
99
139
```bash
100
140
pip install docker
101
141
```
102
142
143
+
You might want to override the default docker image used for code execution. To do that set `use_docker` key of `code_execution_config` property to the name of the image. E.g.:
system_message=""""Reply TERMINATE if the task has been solved at full satisfaction.
152
+
Otherwise, reply CONTINUE, or the reason why the task is not solved yet."""
153
+
)
154
+
```
155
+
103
156
-#### blendsearch
104
157
105
158
`pyautogen<0.2` offers a cost-effective hyperparameter optimization technique [EcoOptiGen](https://arxiv.org/abs/2303.04673) for tuning Large Language Models. Please install with the [blendsearch] option to use it.
0 commit comments