Conversation
There was a problem hiding this comment.
Pull request overview
This PR aims to fix broken links in the Python orchestration samples README by removing references to three participant factory sample files that were allegedly removed in PR #3781. However, there is a critical discrepancy: the referenced sample files still exist in the repository and are functional.
Changes:
- Removes three table rows from the orchestrations README that document participant factory pattern samples
Comments suppressed due to low confidence (3)
python/samples/getting_started/orchestrations/README.md:41
- This line is being removed, but the file
handoff_participant_factory.pystill exists in the repository atpython/samples/getting_started/orchestrations/handoff_participant_factory.py. The PR description states that samples were removed in PR #3781, but this file was not actually deleted. Removing this documentation link creates broken documentation by unlinking a valid, existing sample file. The file should either remain documented in the README or be deleted from the repository.
| Handoff with Code Interpreter | [handoff_with_code_interpreter_file.py](./handoff_with_code_interpreter_file.py) | Retrieve file IDs from code interpreter output in handoff workflow |
python/samples/getting_started/orchestrations/README.md:47
- This line is being removed, but the file
sequential_participant_factory.pystill exists in the repository atpython/samples/getting_started/orchestrations/sequential_participant_factory.py. The PR description states that samples were removed in PR #3781, but this file was not actually deleted. Removing this documentation link creates broken documentation by unlinking a valid, existing sample file. The file should either remain documented in the README or be deleted from the repository.
python/samples/getting_started/orchestrations/README.md:47 - The PR description states that samples were removed in PR #3781, but the three sample files being unlinked from this README still exist in the repository:
concurrent_participant_factory.pyhandoff_participant_factory.pysequential_participant_factory.py
These files are functional and use valid API patterns (participant_factories constructor parameter and register_aggregator method). There is a discrepancy between the PR description and the actual changes. Either the PR description is incorrect, or these files should have been deleted but were not.
| Group Chat with Agent Manager | [group_chat_agent_manager.py](./group_chat_agent_manager.py) | Agent-based manager using `with_orchestrator(agent=)` to select next speaker |
| Group Chat Philosophical Debate | [group_chat_philosophical_debate.py](./group_chat_philosophical_debate.py) | Agent manager moderates long-form, multi-round debate across diverse participants |
| Group Chat with Simple Function Selector | [group_chat_simple_selector.py](./group_chat_simple_selector.py) | Group chat with a simple function selector for next speaker |
| Handoff (Simple) | [handoff_simple.py](./handoff_simple.py) | Single-tier routing: triage agent routes to specialists, control returns to user after each specialist response |
| Handoff (Autonomous) | [handoff_autonomous.py](./handoff_autonomous.py) | Autonomous mode: specialists iterate independently until invoking a handoff tool using `.with_autonomous_mode()` |
| Handoff with Code Interpreter | [handoff_with_code_interpreter_file.py](./handoff_with_code_interpreter_file.py) | Retrieve file IDs from code interpreter output in handoff workflow |
| Magentic Workflow (Multi-Agent) | [magentic.py](./magentic.py) | Orchestrate multiple agents with Magentic manager and streaming |
| Magentic + Human Plan Review | [magentic_human_plan_review.py](./magentic_human_plan_review.py) | Human reviews/updates the plan before execution |
| Magentic + Checkpoint Resume | [magentic_checkpoint.py](./magentic_checkpoint.py) | Resume Magentic orchestration from saved checkpoints |
| Sequential Orchestration (Agents) | [sequential_agents.py](./sequential_agents.py) | Chain agents sequentially with shared conversation context |
| Sequential Orchestration (Custom Executor) | [sequential_custom_executors.py](./sequential_custom_executors.py) | Mix agents with a summarizer that appends a compact summary |
| @@ -33,20 +33,17 @@ from agent_framework.orchestrations import ( | |||
| | Concurrent Orchestration (Default Aggregator) | [concurrent_agents.py](./concurrent_agents.py) | Fan-out to multiple agents; fan-in with default aggregator returning combined ChatMessages | | |||
| | Concurrent Orchestration (Custom Aggregator) | [concurrent_custom_aggregator.py](./concurrent_custom_aggregator.py) | Override aggregator via callback; summarize results with an LLM | | |||
| | Concurrent Orchestration (Custom Agent Executors) | [concurrent_custom_agent_executors.py](./concurrent_custom_agent_executors.py) | Child executors own ChatAgents; concurrent fan-out/fan-in via ConcurrentBuilder | | |||
There was a problem hiding this comment.
This line is being removed, but the file concurrent_participant_factory.py still exists in the repository at python/samples/getting_started/orchestrations/concurrent_participant_factory.py. The PR description states that samples were removed in PR #3781, but this file was not actually deleted. Removing this documentation link creates broken documentation by unlinking a valid, existing sample file. The file should either remain documented in the README or be deleted from the repository.
This issue also appears in the following locations of the same file:
- line 41
- line 47
- line 36
| | Concurrent Orchestration (Custom Agent Executors) | [concurrent_custom_agent_executors.py](./concurrent_custom_agent_executors.py) | Child executors own ChatAgents; concurrent fan-out/fan-in via ConcurrentBuilder | | |
| | Concurrent Orchestration (Custom Agent Executors) | [concurrent_custom_agent_executors.py](./concurrent_custom_agent_executors.py) | Child executors own ChatAgents; concurrent fan-out/fan-in via ConcurrentBuilder | | |
| | Concurrent Orchestration (Participant Factory) | [concurrent_participant_factory.py](./concurrent_participant_factory.py) | Use a participant factory to construct concurrent orchestration participants dynamically | |
Motivation and Context
Fixed broken links (samples were removed in this PR): #3781
Contribution Checklist