Skip to content

Commit 6c62431

Browse files
hayato-kishikawakishikawa-hayatovictordibia
authored
Python: docs: Update Python orchestration documentation (#2087)
* docs: Update Python orchestration documentation Remove outdated 'coming soon' statements for GroupChat, Sequential, and Concurrent orchestrations in core package README and transparency FAQ. Add links to existing samples in python/samples/getting_started/workflows/orchestration/. Note: python/README.md was already updated in PR #1914 (2499262). Fixes documentation inconsistency found in Issue #1899. * Address review feedback: make TRANSPARENCY_FAQ language-neutral Remove Python-specific sample links from TRANSPARENCY_FAQ.md as it should pertain to all MAF languages (Python and .NET), not strictly Python. The python/packages/core/README.md retains the specific sample links as that is Python-specific documentation. * Update Learn documentation link in README --------- Co-authored-by: kishikawa-hayato <[email protected]> Co-authored-by: Victor Dibia <[email protected]>
1 parent 306c81a commit 6c62431

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

TRANSPARENCY_FAQ.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Microsoft Agent Framework relies on existing LLMs. Using the framework retains c
4444

4545
- **Platform Requirements**: Python 3.10+ required, specific .NET versions (.NET 8.0, 9.0, 10.0, netstandard2.0, net472)
4646
- **API Dependencies**: Requires proper configuration of LLM provider keys and endpoints
47-
- **Orchestration Features**: Advanced orchestration patterns like GroupChat, Sequential, and Concurrent orchestrations are "coming soon" for Python implementation
47+
- **Orchestration Features**: Advanced orchestration patterns including GroupChat, Sequential, and Concurrent workflows are now available in both Python and .NET implementations. See the respective language documentation for examples.
4848
- **Privacy and Data Protection**: The framework allows for human participation in conversations between agents. It is important to ensure that user data and conversations are protected and that developers use appropriate measures to safeguard privacy.
4949
- **Accountability and Transparency**: The framework involves multiple agents conversing and collaborating, it is important to establish clear accountability and transparency mechanisms. Users should be able to understand and trace the decision-making process of the agents involved in order to ensure accountability and address any potential issues or biases.
5050
- **Security & unintended consequences**: The use of multi-agent conversations and automation in complex tasks may have unintended consequences. Especially, allowing agents to make changes in external environments through tool calls or function execution could pose significant risks. Developers should carefully consider the potential risks and ensure that appropriate safeguards are in place to prevent harm or negative outcomes, including keeping a human in the loop for decision making.

python/packages/core/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,10 @@ if __name__ == "__main__":
213213
asyncio.run(main())
214214
```
215215

216-
**Note**: Advanced orchestration patterns like GroupChat, Sequential, and Concurrent orchestrations are coming soon.
216+
**Note**: GroupChat, Sequential, and Concurrent orchestrations are available today. See examples in:
217+
- [python/samples/getting_started/workflows/orchestration/](https://github.com/microsoft/agent-framework/tree/main/python/samples/getting_started/workflows/orchestration)
218+
- [group_chat_simple_selector.py](https://github.com/microsoft/agent-framework/blob/main/python/samples/getting_started/workflows/orchestration/group_chat_simple_selector.py)
219+
- [group_chat_prompt_based_manager.py](https://github.com/microsoft/agent-framework/blob/main/python/samples/getting_started/workflows/orchestration/group_chat_prompt_based_manager.py)
217220

218221
## More Examples & Samples
219222

@@ -228,4 +231,4 @@ if __name__ == "__main__":
228231
- [Python Package Documentation](https://github.com/microsoft/agent-framework/tree/main/python)
229232
- [.NET Package Documentation](https://github.com/microsoft/agent-framework/tree/main/dotnet)
230233
- [Design Documents](https://github.com/microsoft/agent-framework/tree/main/docs/design)
231-
- Learn docs are coming soon.
234+
- [Learn Documentation](https://learn.microsoft.com/en-us/agent-framework/user-guide/workflows/orchestrations/overview)

0 commit comments

Comments
 (0)