Skip to content

feat: Replace ChatAgent single_iteration with max_iteration #2483

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

Closed
wants to merge 2 commits into from

Conversation

Wendong-Fan
Copy link
Member

@Wendong-Fan Wendong-Fan commented May 25, 2025

This is a test using Jules, PR automaticlly generated by Jules Agent

Replaces the boolean single_iteration parameter in ChatAgent with an integer max_iteration to provide more flexible control over the number of model calling iterations within a single agent step.

Key changes:

  • ChatAgent.__init__ now accepts max_iteration: Optional[int] = None.
    • If max_iteration is None (default): No explicit limit on internal model/tool iterations (mimics old single_iteration=False).
    • If max_iteration=1: Agent performs one model call; if a tool is called, the step ends after tool execution (mimics old single_iteration=True).
    • If max_iteration=N > 1: Agent performs up to N model calls and tool executions within a step.
  • Logic in ChatAgent.step and ChatAgent.astep updated to respect max_iteration.
  • ChatAgent.clone method updated to carry over max_iteration.
  • Docstrings for ChatAgent updated to reflect the new parameter.
  • All codebase instantiations of ChatAgent using single_iteration have been updated:
    • single_iteration=True changed to max_iteration=1.
    • single_iteration=False (explicitly set) changed to max_iteration=None.
    • Implicit defaults now correctly use max_iteration=None.
  • Tests in test/agents/test_chat_agent.py have been updated and new tests added to cover various max_iteration scenarios (1, N, None) and ensure graceful termination.

Description

Describe your changes in detail (optional if the linked issue already contains a detailed description of the changes).

Checklist

Go over all the following points, and put an x in all the boxes that apply.

  • I have read the CONTRIBUTION guide (required)
  • I have linked this PR to an issue using the Development section on the right sidebar or by adding Fixes #issue-number in the PR description (required)
  • I have checked if any dependencies need to be added or updated in pyproject.toml and uv lock
  • I have updated the tests accordingly (required for a bug fix or a new feature)
  • I have updated the documentation if needed:
  • I have added examples if this is a new feature

If you are unsure about any of these, don't hesitate to ask. We are here to help!

Replaces the boolean `single_iteration` parameter in `ChatAgent` with an integer `max_iteration` to provide more flexible control over the number of model calling iterations within a single agent step.

Key changes:
- `ChatAgent.__init__` now accepts `max_iteration: Optional[int] = None`.
  - If `max_iteration` is `None` (default): No explicit limit on internal model/tool iterations (mimics old `single_iteration=False`).
  - If `max_iteration=1`: Agent performs one model call; if a tool is called, the step ends after tool execution (mimics old `single_iteration=True`).
  - If `max_iteration=N > 1`: Agent performs up to N model calls and tool executions within a step.
- Logic in `ChatAgent.step` and `ChatAgent.astep` updated to respect `max_iteration`.
- `ChatAgent.clone` method updated to carry over `max_iteration`.
- Docstrings for `ChatAgent` updated to reflect the new parameter.
- All codebase instantiations of `ChatAgent` using `single_iteration` have been updated:
  - `single_iteration=True` changed to `max_iteration=1`.
  - `single_iteration=False` (explicitly set) changed to `max_iteration=None`.
  - Implicit defaults now correctly use `max_iteration=None`.
- Tests in `test/agents/test_chat_agent.py` have been updated and new tests added to cover various `max_iteration` scenarios (1, N, None) and ensure graceful termination.
@Wendong-Fan Wendong-Fan marked this pull request as ready for review May 25, 2025 18:40
@Wendong-Fan Wendong-Fan marked this pull request as draft May 25, 2025 18:49
Copy link
Contributor

coderabbitai bot commented Jun 11, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant