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
The AutoGen ecosystem provides everything you need to create AI agents, especially multi-agent workflows -- framework, developer tools, and applications.
76
77
77
-
The *framework* uses a layered and extensible design. Layers have clearly divided responsibilities and build on top of layers below. This design enables you to use the framework at different levels of abstraction, from high-level APIs to low-level components.
78
+
The _framework_ uses a layered and extensible design. Layers have clearly divided responsibilities and build on top of layers below. This design enables you to use the framework at different levels of abstraction, from high-level APIs to low-level components.
78
79
79
80
-[Core API](./python/packages/autogen-core/) implements message passing, event-driven agents, and local and distributed runtime for flexibility and power. It also support cross-language support for .NET and Python.
80
81
-[AgentChat API](./python/packages/autogen-agentchat/) implements a simpler but opinionated API rapid for prototyping. This API is built on top of the Core API and is closest to what users of v0.2 are familiar with and supports familiar multi-agent patterns such as two-agent chat or group chats.
81
82
-[Extensions API](./python/packages/autogen-ext/) enables first- and third-party extensions continuously expanding framework capabilities. It support specific implementation of LLM clients (e.g., OpenAI, AzureOpenAI), and capabilities such as code execution.
82
83
83
-
The ecosystem also supports two essential *developer tools*:
84
+
The ecosystem also supports two essential _developer tools_:
84
85
85
86
<divalign="center">
86
87
<imgsrc="https://media.githubusercontent.com/media/microsoft/autogen/refs/heads/main/python/packages/autogen-studio/docs/ags_screen.png"alt="AutoGen Studio Screenshot"width="500">
@@ -97,17 +98,17 @@ With AutoGen you get to join and contribute to a thriving ecosystem. We host wee
| API Reference |[](https://microsoft.github.io/autogen/dev/reference/index.html#)|* |[](https://microsoft.github.io/autogen/dev/user-guide/autogenstudio-user-guide/usage.html)|
| API Reference |[](https://microsoft.github.io/autogen/dev/reference/index.html#)|\*|[](https://microsoft.github.io/autogen/dev/user-guide/autogenstudio-user-guide/usage.html)|
Interested in contributing? See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to get started. We welcome contributions of all kinds, including bug fixes, new features, and documentation improvements. Join our community and help us make AutoGen better!
Copy file name to clipboardExpand all lines: python/packages/autogen-core/docs/src/user-guide/autogenstudio-user-guide/installation.md
+71-23
Original file line number
Diff line number
Diff line change
@@ -9,35 +9,83 @@ myst:
9
9
10
10
There are two ways to install AutoGen Studio - from PyPi or from source. We **recommend installing from PyPi** unless you plan to modify the source code.
11
11
12
-
1.**Install from PyPi**
12
+
## Create a Virtual Environment (Recommended)
13
13
14
-
We recommend using a virtual environment (e.g., conda) to avoid conflicts with existing Python packages. With Python 3.10 or newer active in your virtual environment, use pip to install AutoGen Studio:
14
+
We recommend using a virtual environment as this will ensure that the dependencies for AutoGen Studio are isolated from the rest of your system.
15
15
16
-
```bash
17
-
pip install -U autogenstudio
18
-
```
16
+
``````{tab-set}
19
17
20
-
2. **Install from Source**
18
+
`````{tab-item} venv
21
19
22
-
> Note: This approach requires some familiarity with building interfaces in React.
20
+
Create and activate:
23
21
24
-
If you prefer to install from source, ensure you have Python 3.10+ and Node.js (version above 14.15.0) installed. Here's how you get started:
22
+
```bash
23
+
python3 -m venv .venv
24
+
source .venv/bin/activate
25
+
```
26
+
27
+
To deactivate later, run:
28
+
29
+
```bash
30
+
deactivate
31
+
```
32
+
33
+
`````
34
+
35
+
`````{tab-item} conda
36
+
37
+
[Install Conda](https://docs.conda.io/projects/conda/en/stable/user-guide/install/index.html) if you have not already.
38
+
39
+
40
+
Create and activate:
41
+
42
+
```bash
43
+
conda create -n autogen python=3.10
44
+
conda activate autogen
45
+
```
46
+
47
+
To deactivate later, run:
48
+
49
+
```bash
50
+
conda deactivate
51
+
```
52
+
53
+
54
+
`````
55
+
56
+
57
+
58
+
``````
59
+
60
+
## Install Using pip (Recommended)
61
+
62
+
You can install AutoGen Studio using pip, the Python package manager.
63
+
64
+
```bash
65
+
pip install -U autogenstudio
66
+
```
67
+
68
+
### Install from Source\*\*
69
+
70
+
> Note: This approach requires some familiarity with building interfaces in React.
71
+
72
+
If you prefer to install from source, ensure you have Python 3.10+ and Node.js (version above 14.15.0) installed. Here's how you get started:
25
73
26
-
- Clone the AutoGen Studio repository and install its Python dependencies:
74
+
- Clone the AutoGen Studio repository and install its Python dependencies:
27
75
28
-
```bash
29
-
pip install -e .
30
-
```
76
+
```bash
77
+
pip install -e .
78
+
```
31
79
32
-
- Navigate to the `samples/apps/autogen-studio/frontend` directory, install dependencies, and build the UI:
80
+
- Navigate to the `samples/apps/autogen-studio/frontend` directory, install dependencies, and build the UI:
33
81
34
-
```bash
35
-
npm install -g gatsby-cli
36
-
npm install --global yarn
37
-
cd frontend
38
-
yarn install
39
-
yarn build
40
-
```
82
+
```bash
83
+
npm install -g gatsby-cli
84
+
npm install --global yarn
85
+
cd frontend
86
+
yarn install
87
+
yarn build
88
+
```
41
89
42
90
For Windows users, to build the frontend, you may need alternative commands to build the frontend.
43
91
@@ -47,7 +95,7 @@ For Windows users, to build the frontend, you may need alternative commands to b
47
95
48
96
```
49
97
50
-
### Running the Application
98
+
## Running the Application
51
99
52
100
Once installed, run the web UI by entering the following in a terminal:
53
101
@@ -62,8 +110,8 @@ AutoGen Studio also takes several parameters to customize the application:
62
110
-`--host <host>` argument to specify the host address. By default, it is set to `localhost`.
63
111
-`--appdir <appdir>` argument to specify the directory where the app files (e.g., database and generated user files) are stored. By default, it is set to the a `.autogenstudio` directory in the user's home directory.
64
112
-`--port <port>` argument to specify the port number. By default, it is set to `8080`.
65
-
- `--upgrade-database` argument to upgrade the database schema (assuming there are changes in the version you are installing). By default, it is set to `False`.
113
+
-`--upgrade-database` argument to force-upgrade it's internal database schema (assuming there are changes in the version you are installing). By default, it is set to `False`.
66
114
-`--reload` argument to enable auto-reloading of the server when changes are made to the code. By default, it is set to `False`.
67
-
- `--database-uri` argument to specify the database URI. Example values include `sqlite:///database.sqlite`forSQLite and `postgresql+psycopg://user:password@localhost/dbname` for PostgreSQL. If this is not specified, the database URI defaults to a `database.sqlite` filein the `--appdir` directory.
115
+
-`--database-uri` argument to specify the database URI. Example values include `sqlite:///database.sqlite` for SQLite and `postgresql+psycopg://user:password@localhost/dbname` for PostgreSQL. If this is not specified, the database URI defaults to a `autogen.db` file in the `--appdir` directory.
68
116
69
117
Now that you have AutoGen Studio installed and running, you are ready to explore its capabilities, including defining and modifying agent workflows, interacting with agents and sessions, and expanding agent skills.
0 commit comments