Skip to content

Commit 726e0be

Browse files
Add/fix windows install instructions (#6579)
## Why are these changes needed? Install instructions for Windows are missing or incorrect ## Related issue number closes #6577 ## Checks - [ ] I've included any doc changes needed for <https://microsoft.github.io/autogen/>. See <https://github.com/microsoft/autogen/blob/main/CONTRIBUTING.md> to build and test documentation locally. - [ ] I've added tests (if relevant) corresponding to the changes introduced in this PR. - [ ] I've made sure all auto checks have passed. Co-authored-by: Victor Dibia <victordibia@microsoft.com>
1 parent 0a81100 commit 726e0be

File tree

4 files changed

+25
-4
lines changed

4 files changed

+25
-4
lines changed

python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/installation.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,19 @@ When installing AgentChat locally, we recommend using a virtual environment for
1717
1818
Create and activate:
1919
20+
Linux/Mac:
2021
```bash
21-
# On Windows, change `python3` to `python` (if `python` is Python 3).
2222
python3 -m venv .venv
23-
# On Windows, change `bin` to `scripts`.
2423
source .venv/bin/activate
2524
```
2625
26+
Windows command-line:
27+
```batch
28+
# The command may be `python3` instead of `python` depending on your setup
29+
python -m venv .venv
30+
.venv\Scripts\activate.bat
31+
```
32+
2733
To deactivate later, run:
2834
2935
```bash

python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/models.ipynb

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -452,10 +452,11 @@
452452
"metadata": {},
453453
"outputs": [],
454454
"source": [
455+
"from pathlib import Path\n",
456+
"\n",
457+
"from autogen_core import Image\n",
455458
"from autogen_core.models import UserMessage\n",
456459
"from autogen_ext.models.openai import OpenAIChatCompletionClient\n",
457-
"from autogen_core import Image\n",
458-
"from pathlib import Path\n",
459460
"\n",
460461
"# Text\n",
461462
"model_client = OpenAIChatCompletionClient(\n",

python/packages/autogen-core/docs/src/user-guide/autogenstudio-user-guide/installation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,18 @@ We recommend using a virtual environment as this will ensure that the dependenci
1919
2020
Create and activate:
2121
22+
Linux/Mac:
2223
```bash
2324
python3 -m venv .venv
2425
source .venv/bin/activate
2526
```
2627
28+
Windows command-line:
29+
```batch
30+
python3 -m venv .venv
31+
.venv\Scripts\activate.bat
32+
```
33+
2734
To deactivate later, run:
2835
2936
```bash

python/packages/autogen-core/docs/src/user-guide/core-user-guide/installation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,18 @@ When installing AgentChat locally, we recommend using a virtual environment for
1010
1111
Create and activate:
1212
13+
Linux/Mac:
1314
```bash
1415
python3 -m venv .venv
1516
source .venv/bin/activate
1617
```
1718
19+
Windows command-line:
20+
```batch
21+
python3 -m venv .venv
22+
.venv\Scripts\activate.bat
23+
```
24+
1825
To deactivate later, run:
1926
2027
```bash

0 commit comments

Comments
 (0)