docs: Clarify missing dependencies in documentation (fix #6076) (#6406)

It clarifies the missing dependencies of all README.md in
python/samples/

- Added explicit mention of required dependencies
- Improved instructions for initial setup

<!-- Thank you for your contribution! Please review
https://microsoft.github.io/autogen/docs/Contribute before opening a
pull request. -->

<!-- Please add a reviewer to the assignee section when you create a PR.
If you don't have the access to it, we will shortly find a reviewer and
assign them to your PR. -->

## Why are these changes needed?
According to issue #6076, several dependencies were missing from the
requirements.txt and not mentioned in the README.md instructions.
This change adds the missing installation instructions to ensure that
users can run the demo smoothly.


## Related issue number
Closes #6076 
<!-- For example: "Closes #1234" -->

## Checks

- [x] 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.
- [x] I've added tests (if relevant) corresponding to the changes
introduced in this PR.
- [x] I've made sure all auto checks have passed.

Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com>
This commit is contained in:
Mars Wang 2025-04-28 15:47:14 -04:00 committed by GitHub
parent 18d24005e1
commit 998840f7e0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 14 additions and 6 deletions

View File

@ -2,3 +2,4 @@
provider: autogen_ext.models.openai.OpenAIChatCompletionClient
config:
model: gpt-4o
api_key: REPLACE_WITH_YOUR_API_KEY

View File

@ -18,6 +18,12 @@ pip install "autogen-ext[openai]"
# pip install "autogen-ext[openai,azure]" for Azure OpenAI models
```
To run this sample, you will need to install the following packages:
```shell
pip install -U autogen-agentchat pyyaml
```
Create a new file named `model_config.yaml` in the the same directory as the script
to configure the model you want to use.

View File

@ -17,7 +17,7 @@ You will be using the following features of AgentChat:
Install the required packages with OpenAI support:
```bash
pip install -U "autogen-ext[openai]" "fastapi" "uvicorn" "PyYAML"
pip install -U "autogen-agentchat" "autogen-ext[openai]" "fastapi" "uvicorn[standard]" "PyYAML"
```
To use models other than OpenAI, see the [Models](https://microsoft.github.io/autogen/stable/user-guide/agentchat-user-guide/tutorial/models.html) documentation.

View File

@ -1,2 +1,3 @@
autogen-agentchat>=0.4.0,<0.5
autogen-ext[graphrag,openai,azure]>=0.4.0,<0.5
autogen-agentchat
autogen-ext
pyyaml

View File

@ -7,7 +7,7 @@ An example showing human-in-the-loop which waits for human input before making t
First, you need a shell with AutoGen core and required dependencies installed.
```bash
pip install "autogen-ext[openai,azure]"
pip install "autogen-ext[openai,azure]" "pyyaml"
```
## Model Configuration

View File

@ -7,7 +7,7 @@ An example with two chess player agents that executes its own tools to demonstra
First, you need a shell with AutoGen core and required dependencies installed.
```bash
pip install "autogen-ext[openai,azure]" "chess"
pip install "autogen-ext[openai,azure]" "chess" "pyyaml"
```
## Model Configuration

View File

@ -10,7 +10,7 @@ This example runs a gRPC server using [GrpcWorkerAgentRuntimeHost](../../src/aut
2. Install dependencies.
```bash
pip install "autogen-ext[openai,azure,chainlit,rich,pyyaml]"
pip install "autogen-ext[openai,azure,chainlit,rich]" "pyyaml"
```
### General Configuration