d2537abbab
* Add MagenticOne API * Add CodeExecutorAgent to MagenticOne for enhanced task execution * Refactor MagenticOne class to inherit from MagenticOneGroupChat and streamline initialization * Enhance MagenticOne class documentation with detailed usage examples and initialization instructions * Refactor MagenticOne module structure and update import paths * Remove unused imports * Add documentation for MagenticOne module and remove redundant initialization comments * Enhance MagenticOne class with human-in-the-loop mode and update examples * Update MagenticOne class documentation with safety precautions and architecture details * Run poe format * Add blog post reference to MagenticOne class documentation * change default of websurfer use_ocr to false because of refusals * Refactor MagenticOne class to use ChatCompletionClient instead of OpenAIChatCompletionClient * Add client capability validation to MagenticOne initialization * Poe format * Refactor imports in MagenticOne class for clarity and organization * Add stacklevel parameter to warning in client capability validation * Update README to recommend using Magentic-One API for improved integration * Add create_args property to OpenAIChatCompletionClient for better access to initialization arguments * Enhance client capability validation in MagenticOne to ensure compatibility with OpenAI GPT-4o model * Refactor client capability validation in MagenticOne for improved clarity * Update magentic_one.py Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com> * Remove create_args property from OpenAIChatCompletionClient and update validation logic in MagenticOne to directly access _create_args * Refactor documentation in MagenticOne for improved readability and consistency * Refactor client capability validation in MagenticOne to remove unnecessary model check for GPT-4o * Add MagenticOne CLI (#4788) * Add MagenticOne CLI script for task execution with OpenAI GPT-4o integration * Fix argument parsing in MagenticOne CLI to require a single task input * Add docstring to main function in MagenticOne CLI for improved usage clarity * Fix example usage in docstring of MagenticOne CLI for correct argument order * Refactor argument parsing in MagenticOne CLI for improved clarity and consistency * Add type hints to run_task function in MagenticOne CLI * Add type hint for main function in MagenticOne CLI * Remove type ignore from main function call in MagenticOne CLI --------- Co-authored-by: Hussein Mozannar <hmozannar@microsoft.com> Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com>
Building the AutoGen Documentation
AutoGen documentation is based on the sphinx documentation system and uses the myst-parser to render markdown files. It uses the pydata-sphinx-theme to style the documentation.
Prerequisites
Ensure you have all of the dev dependencies for the autogen-core package installed. You can install them by running the following command from the root of the python repository:
uv sync
source .venv/bin/activate
Building Docs
To build the documentation, run the following command from the root of the python repository:
poe --directory ./packages/autogen-core/ docs-build
To serve the documentation locally, run the following command from the root of the python repository:
poe --directory ./packages/autogen-core/ docs-serve
[!NOTE]
Sphinx will only rebuild files that have changed since the last build. If you want to force a full rebuild, you can delete the ./packages/autogen-core/docs/build directory before running the docs-build command.
Versioning the Documentation
The current theme - pydata-sphinx-theme - supports switching between versions of the documentation.
To version the documentation, you need to create a new version of the documentation by copying the existing documentation to a new directory with the version number. For example, to create a new version of the documentation for version 0.1.0, you would run the following command:
How are various versions built? - TBD.