docs: add missing pre flag (#1130)

Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com>
This commit is contained in:
Vincent Koc
2025-10-02 11:50:47 -07:00
committed by GitHub
Unverified
parent d5fe617285
commit 2696de7428
14 changed files with 22 additions and 24 deletions
+1 -1
View File
@@ -22,7 +22,7 @@
"agent-framework-google == 1.0.0"
]
```
* this means developers can use `pip install agent-framework[google]` to get AF with all Google connectors and dependencies, as well as manually installing the subpackage with `pip install agent-framework-google`.
* this means developers can use `pip install agent-framework[google] --pre` to get AF with all Google connectors and dependencies, as well as manually installing the subpackage with `pip install agent-framework-google --pre`.
### Sample getting started code
```python
+6 -6
View File
@@ -9,10 +9,10 @@ We recommend two common installation paths depending on your use case.
If you are exploring or developing locally, install the entire framework with all sub-packages:
```bash
pip install agent-framework
pip install agent-framework --pre
```
This installs the core and every integration package, making sure that all features are available without additional steps. This is the simplest way to get started.
This installs the core and every integration package, making sure that all features are available without additional steps. The `--pre` flag is required while Agent Framework is in preview. This is the simplest way to get started.
### 2. Selective install
@@ -22,16 +22,16 @@ If you only need specific integrations, you can install at a more granular level
# Core only
# includes Azure OpenAI and OpenAI support by default
# also includes workflows and orchestrations
pip install agent-framework-core
pip install agent-framework-core --pre
# Core + Azure AI integration
pip install agent-framework-azure-ai
pip install agent-framework-azure-ai --pre
# Core + Microsoft Copilot Studio integration
pip install agent-framework-copilotstudio
pip install agent-framework-copilotstudio --pre
# Core + both Microsoft Copilot Studio and Azure AI integration
pip install agent-framework-microsoft agent-framework-azure-ai
pip install agent-framework-microsoft agent-framework-azure-ai --pre
```
This selective approach is useful when you know which integrations you need, and it is the recommended way to set up lightweight environments.
+1 -2
View File
@@ -3,7 +3,7 @@
Please install this package via pip:
```bash
pip install agent-framework-a2a
pip install agent-framework-a2a --pre
```
## A2A Agent Integration
@@ -18,4 +18,3 @@ See the [A2A agent examples](https://github.com/microsoft/agent-framework/tree/m
- Sending messages and receiving responses
- Handling different content types (text, files, data)
- Streaming responses and real-time interaction
+1 -1
View File
@@ -3,7 +3,7 @@
Please install this package via pip:
```bash
pip install agent-framework-azure-ai
pip install agent-framework-azure-ai --pre
```
and see the [README](https://github.com/microsoft/agent-framework/tree/main/python/README.md) for more information.
+1 -1
View File
@@ -3,7 +3,7 @@
Please install this package via pip:
```bash
pip install agent-framework-copilotstudio
pip install agent-framework-copilotstudio --pre
```
## Copilot Studio Agent
+2 -2
View File
@@ -13,9 +13,9 @@ Highlights
## Quick Install
```bash
pip install agent-framework-core
pip install agent-framework-core --pre
# Optional: Add Azure AI integration
pip install agent-framework-azure-ai
pip install agent-framework-azure-ai --pre
```
Supported Platforms:
@@ -3,13 +3,13 @@
Workflow capabilities ship with the core `agent-framework` package.
```bash
pip install agent-framework
pip install agent-framework --pre
```
Optional visualization support is still available via the `viz` extra:
```bash
pip install agent-framework[viz]
pip install agent-framework[viz] --pre
```
See the [project README](https://github.com/microsoft/agent-framework/tree/main/python/README.md) for more information.
@@ -80,7 +80,7 @@ class WorkflowViz:
import graphviz # type: ignore
except ImportError as e:
raise ImportError(
"viz extra is required for export. Install it with: pip install agent-framework[viz]. "
"viz extra is required for export. Install it with: pip install agent-framework[viz] --pre. "
"You also need to install graphviz separately. E.g., sudo apt-get install graphviz on Debian/Ubuntu "
"or brew install graphviz on macOS. See https://graphviz.org/download/ for details."
) from e
+1 -1
View File
@@ -11,7 +11,7 @@ A lightweight, standalone sample app interface for running entities (agents/work
```bash
# Install
pip install agent-framework-devui
pip install agent-framework-devui --pre
```
You can also launch it programmatically
+1 -2
View File
@@ -3,7 +3,7 @@
Please install this package via pip:
```bash
pip install agent-framework-mem0
pip install agent-framework-mem0 --pre
```
## Memory Context Provider
@@ -18,4 +18,3 @@ See the [Mem0 basic example](https://github.com/microsoft/agent-framework/tree/m
- Teaching the agent user preferences
- Retrieving information using remembered context across new threads
- Persistent memory
+1 -1
View File
@@ -3,7 +3,7 @@
Please install this package via pip:
```bash
pip install agent-framework-redis
pip install agent-framework-redis --pre
```
## Components
@@ -7,7 +7,7 @@ Microsoft Agent Framework Workflows support ships with the core `agent-framework
To install with visualization support:
```bash
pip install agent-framework[viz]
pip install agent-framework[viz] --pre
```
To export visualization images you also need to [install GraphViz](https://graphviz.org/download/).
@@ -296,7 +296,7 @@ async def main():
svg_file = viz.export(format="svg")
print(f"SVG file saved to: {svg_file}")
except ImportError:
print("Tip: Install 'viz' extra to export workflow visualization: pip install agent-framework[viz]")
print("Tip: Install 'viz' extra to export workflow visualization: pip install agent-framework[viz] --pre")
# Step 3: Open the text file and read its content.
async with aiofiles.open(os.path.join(DIR, "../resources", "long_text.txt"), "r") as f:
@@ -32,7 +32,7 @@ What it does:
Prerequisites:
- Azure AI/ Azure OpenAI for `AzureOpenAIChatClient` agents.
- Authentication via `azure-identity` — uses `AzureCliCredential()` (run `az login`).
- For visualization export: `pip install agent-framework[viz]` and install GraphViz binaries.
- For visualization export: `pip install agent-framework[viz] --pre` and install GraphViz binaries.
"""
@@ -162,7 +162,7 @@ async def main() -> None:
svg_file = viz.export(format="svg")
print(f"SVG file saved to: {svg_file}")
except ImportError:
print("Tip: Install 'viz' extra to export workflow visualization: pip install agent-framework[viz]")
print("Tip: Install 'viz' extra to export workflow visualization: pip install agent-framework[viz] --pre")
# 3) Run with a single prompt
async for event in workflow.run_stream("We are launching a new budget-friendly electric bike for urban commuters."):