Update AG2 reference #391
Update AG2 reference #391
Conversation
WalkthroughThis pull request updates the documentation and a single code comment to reflect a rebranding from "AutoGen" to "AG2 (Formerly AutoGen)". The changes include modifications to headers, descriptions, installation instructions, and references across multiple Markdown files, ensuring consistency in terminology. No functional changes or alterations to exported/public entities were made. Changes
Poem
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
docs/framework/autogen.mdx (1)
14-16: 🛠️ Refactor suggestionUpdate Installation Comment for Consistency
The bash code block still includes the comment# Install with AutoGen supporton line 14. Since the documentation is being rebranded, update this comment to reflect "AG2 support."
Consider applying the diff below:-# Install with AutoGen support +# Install with AG2 support
🧹 Nitpick comments (3)
docs/ui/overview.mdx (1)
14-14: Rebranding Update in Interface Description.
The description for the UI interface now correctly references “AG2” instead of “AutoGen” to reflect the rebranding. Please verify that all similar references within the documentation remain consistent.praisonai/inbuilt_tools/__init__.py (1)
1-1: Updated Comment Branding.
The module-level comment now correctly refers to “AG2” in place of “AutoGen,” ensuring that the messaging aligns with the new branding. Verify that any future references to the external module or variable names (e.g. AUTOGEN_AVAILABLE) are updated as needed.docs/framework/autogen.mdx (1)
10-11: Informative Note on Evolution
Line 10 now informs the reader that AutoGen is evolving into AG2 and provides a link for further details. This contextual note is useful for users to understand the transition; however, consider emphasizing that previous references should now use AG2 consistently.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (13)
README.md(1 hunks)docs/api-reference/index.mdx(1 hunks)docs/api.mdx(2 hunks)docs/framework/autogen.mdx(3 hunks)docs/home.mdx(5 hunks)docs/index.mdx(1 hunks)docs/nocode/auto.mdx(4 hunks)docs/nocode/installation.mdx(1 hunks)docs/nocode/introduction.mdx(1 hunks)docs/nocode/tldr.mdx(2 hunks)docs/ui/chat.mdx(1 hunks)docs/ui/overview.mdx(1 hunks)praisonai/inbuilt_tools/__init__.py(1 hunks)
🔇 Additional comments (18)
docs/index.mdx (1)
4-4: Front Matter Branding Enhancement.
The description has been updated to reference “AG2 (Formerly AutoGen)” which clearly communicates the rebranding. This front matter update is consistent with the overall rebranding effort.docs/api-reference/index.mdx (1)
33-33: API Integration Header Rebranding.
The header now reads “AG2 (Formerly AutoGen) Integration” to better align with the new naming convention. This change improves clarity in the API documentation.docs/nocode/introduction.mdx (1)
24-24: Integration Card Rebranding.
The “Framework Integration” card now states “Seamlessly integrates AG2 and CrewAI capabilities,” which correctly updates the reference from AutoGen to AG2. This change is clear and consistent.README.md (1)
23-24: Consistent Rebranding Applied in Description
The updated description now references AG2 (Formerly AutoGen), which aligns with the new branding initiative. Please verify that all internal links (e.g., logo paths, documentation links) remain consistent with the overall rebranding.docs/ui/chat.mdx (1)
21-21: Accurate Update of UI Reference to AG2
The table row now correctly displays "AG2" as part of the multi-agent support description. This change is consistent with the rebranding effort.docs/nocode/tldr.mdx (2)
3-4: Enhanced Description Reflecting Rebranding
The updated description now includes "AG2 (Formerly AutoGen)" alongside CrewAI and UI setup instructions. This improves clarity for users familiar with the legacy name while reinforcing the new branding.
35-35: Updated Quick Start Header for AG2
Changing the header to "Quick Start with AG2" accurately replaces the old AutoGen reference. This update helps users quickly identify the current framework branding.docs/nocode/installation.mdx (1)
31-38: Rebranded Installation Section for AG2 Support
The "AG2 Support" header and corresponding installation command (pip install "praisonai[autogen]") are correctly updated to reflect the new branding. Please ensure that any legacy documentation references to AutoGen are fully replaced to avoid user confusion.docs/nocode/auto.mdx (4)
7-8: Revised Introduction for Automatic Agent Generation
The introduction now clearly mentions that PraisonAI supports automatic agent generation with CrewAI and AG2 frameworks. This ensures that the transition away from the legacy AutoGen name is evident from the outset.
20-22: Correct Installation Command for AG2
The comment and command now correctly indicate installation for AG2 (pip install "praisonai[autogen]"). This precise update minimizes any potential confusion among users regarding which framework they are installing.
39-43: Consistent CLI Usage Update for AG2 Workflow
The CLI command in the "With AG2" section is updated topraisonai --framework autogen --auto "create a movie script about Dog in Moon", which maintains consistency with the rebranding changes.
52-57: Informative Header for AG2-Specific Features
The header "AG2 (Formerly AutoGen)" in the framework-specific features section is clear and informative. This effectively communicates the rebranding while preserving historical context for existing users.docs/home.mdx (2)
4-4: Consistent Rebranding in Metadata Description
The description line now correctly includes "AG2 (Formerly AutoGen)" to reflect the current branding.
48-49: Rebranding Update in Informational Tip
The content within the<Tip>now clearly indicates that the framework formerly known as AutoGen is rebranded to AG2. This update is consistent with the intended messaging.docs/api.mdx (2)
25-27: Rebranding Update in Agent Generation Details
The bullet item on line 26 has been updated from referencing AutoGen to "AG2 (Formerly AutoGen) support." This clearly communicates the new framework name and is aligned with the rebranding objectives.
74-77: Rebranding Update in Framework-specific Features Section
The header and subsequent bullet now reference "AG2 (Formerly AutoGen)" and "AG2 framework support" respectively. This clarifies the framework's new identity. Ensure that all related sections (e.g., installation instructions) remain consistent with this update.docs/framework/autogen.mdx (2)
2-3: Header Metadata Rebranding
The title and description have been updated to reflect "AG2 with PraisonAI" and appropriately describe its features. These changes effectively communicate the rebranding.
27-32:❓ Verification inconclusive
Clarify Initialization Command Flag
The heading indicates "Initialize with AG2," but the command still uses--framework autogen. For consistency and to avoid confusion, update the command to use the new branding flag (e.g.,--framework ag2) if supported by the system.
Apply the following diff if applicable:-# Initialize with AG2 -praisonai --framework autogen --init "Create a Movie Script About Cat in Mars" +# Initialize with AG2 +praisonai --framework ag2 --init "Create a Movie Script About Cat in Mars"If the CLI flag must remain as
autogenfor backward compatibility, consider adding an inline comment to clarify this decision.
Clarify the CLI Branding for Initialization Command
The documentation heading indicates initialization with AG2, but the sample command still uses--framework autogen. To avoid confusion, please update the command to reflect the new branding if the system supports it. For example:-# Initialize with AG2 -praisonai --framework autogen --init "Create a Movie Script About Cat in Mars" +# Initialize with AG2 +praisonai --framework ag2 --init "Create a Movie Script About Cat in Mars"If the CLI flag must remain as
autogenfor backward compatibility, add an inline comment explaining why the legacy flag is still in use.
- File:
docs/framework/autogen.mdx- Lines: 27–32
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/tools/custom.mdx (1)
74-77: Polish Instruction WordingConsider refining the wording for a more direct and friendly instruction. For example, you could change:
-If you want to run the AG2 framework (Formerly AutoGen), use: +To run the AG2 framework (Formerly AutoGen), execute:This rephrasing makes the instruction clearer.
🧰 Tools
🪛 LanguageTool
[style] ~74-~74: Consider using a more polite wording.
Context: ...erminal:bash praisonaiIf you want to run the AG2 framework (Formerly Auto...(IF_YOU_WANT)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
README.md(2 hunks)docs/api.mdx(3 hunks)docs/developers/wrapper.mdx(1 hunks)docs/index.mdx(4 hunks)docs/nocode/auto.mdx(4 hunks)docs/tools/custom.mdx(1 hunks)docs/ui/code.mdx(1 hunks)setup.sh(2 hunks)
✅ Files skipped from review due to trivial changes (2)
- docs/ui/code.mdx
- docs/developers/wrapper.mdx
🚧 Files skipped from review as they are similar to previous changes (4)
- docs/index.mdx
- docs/nocode/auto.mdx
- README.md
- docs/api.mdx
🧰 Additional context used
🪛 LanguageTool
docs/tools/custom.mdx
[style] ~74-~74: Consider using a more polite wording.
Context: ...erminal: bash praisonai If you want to run the AG2 framework (Formerly Auto...
(IF_YOU_WANT)
🔇 Additional comments (3)
docs/tools/custom.mdx (1)
74-77: Update Branding ReferenceThe documentation now references the framework as "AG2 framework (Formerly AutoGen)" which clearly communicates the rebranding. However, note that the subsequent command still uses
--framework autogen. Please verify whether this is an intentional backward compatibility measure or if further updates are needed for complete consistency.🧰 Tools
🪛 LanguageTool
[style] ~74-~74: Consider using a more polite wording.
Context: ...erminal:bash praisonaiIf you want to run the AG2 framework (Formerly Auto...(IF_YOU_WANT)
setup.sh (2)
15-15: Updated UI Dependency DescriptionThe usage message for the UI option now includes "(CrewAI/AG2)", which correctly reflects the updated branding.
100-102: Updated Framework PromptThe prompt now asks, "Use AG2 (Formerly AutoGen) framework? (y/N):", which aligns with the rebranding efforts. However, since the subsequent command still uses
--framework autogen, please confirm whether this is by design for backward compatibility or if the command-line flag should be updated accordingly.
AutoGen is being evolved into AG2, which is where the package
pyautogenassociated with. AG2 is actively maintained by the founders of AutoGen. This PR aims to updated the names references to document.-> Checkout more details here: https://docs.ag2.ai/docs/Home
Summary by CodeRabbit