Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation]: Update Swarm documentation #971

Closed
sonichi opened this issue Feb 13, 2025 · 4 comments · Fixed by #977
Closed

[Documentation]: Update Swarm documentation #971

sonichi opened this issue Feb 13, 2025 · 4 comments · Fixed by #977
Assignees
Labels
documentation Improvements or additions to documentation swarm

Comments

@sonichi
Copy link
Collaborator

sonichi commented Feb 13, 2025

Describe the issue

For example, https://docs.ag2.ai/docs/user-guide/basic-concepts/swarm uses SwarmAgent. Shall we update to ConversableAgent ?
@marklysze

Steps to reproduce

No response

Screenshots and logs

No response

Additional Information

No response

@sonichi sonichi added documentation Improvements or additions to documentation swarm labels Feb 13, 2025
@davorrunje davorrunje added this to ag2 Feb 13, 2025
@davorrunje davorrunje moved this to Todo in ag2 Feb 13, 2025
@marklysze
Copy link
Collaborator

@yiranwu0, if you can assist here that would be great :)

@hughlv
Copy link

hughlv commented Feb 14, 2025

The document is quite confusing as i don't know whether we should use SwarmAgent or not. If it's in ConversableAgent, but it does not contain the register_hand_off as Swarm doc mentioned, how should we apply the Swarm pattern.

This doc swarm-deep-dive also mentioned another method handoff, but I don't see it anywhere either. I guess it's better to release docs with the code together.

@marklysze
Copy link
Collaborator

marklysze commented Feb 15, 2025

@hughlv, thanks for noting, yep we are updating now that SwarmAgent has been merged into ConversableAgent.

You can still use the previous code but with the new code:

  • Use ConversableAgent (or based on) instead of SwarmAgent
  • Use register_hand_off from autogen: from autogen import register_hand_off

@yiranwu0 created and is working on PR #977 to rectify.

@hughlv
Copy link

hughlv commented Feb 15, 2025

@hughlv, thanks for noting, yep we are updating now that SwarmAgent has been merged into ConversableAgent.

You can still use the previous code but with the new code:

  • Use ConversableAgent (or based on) instead of SwarmAgent
  • Use register_hand_off from autogen: from autogen import register_hand_off

@yiranwu0 created and is working on PR #977 to rectify.

got it @marklysze, thanks for the great work.

@github-project-automation github-project-automation bot moved this from Todo to Done in ag2 Feb 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation swarm
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants