Skip to content

feat: Implement memory sharing for EvaluatorOptimizerLLM #227

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

jingx8885
Copy link
Contributor

@jingx8885 jingx8885 commented May 20, 2025

feat: Implement memory sharing for EvaluatorOptimizerLLM

  • Add a shared memory parameter to the EvaluatorOptimizerLLM class.
  • Implement the share_memory_from method to enable memory sharing functionality.

This change aims to optimize memory management between the evaluator and optimizer.

For example, the optimizer_llm is often bound to an MCP server. After invoking the MCP and receiving content, the LLM might sometimes "hallucinate" or produce responses inconsistent with the MCP's returned content. The evaluator_llm, when performing its assessment, needs access to the optimizer_llm's memory to better determine if it is hallucinating or generating unexpected output. MeanWhile, optimizer_llm can do better work when having evaluator_llm's memory.

Summary by CodeRabbit

  • New Features
    • Added an option to enable memory sharing between the optimizer and evaluator components in the workflow, allowing them to access a shared conversation history for improved coordination.

jingx8885 added 5 commits May 13, 2025 11:32
- Fix message parameter name typo
- Ensure proper request_params handling in next step generation
- Maintain consistency with other method signatures
- Add init_queue method to prevent redundant queue initialization.
- Ensure proper queue initialization before starting the event bus to enhance asynchronous task execution efficiency.

Previously, AsyncEventBus was instantiated during logger initialization, which occurs upon import. This led to uncontrollable queue binding. By initializing the queue during the `start` method, reliable queue binding is ensured in a multi-threaded environment.
- Add a shared memory parameter to the EvaluatorOptimizerLLM class.
- Implement the `share_memory_from` method to enable memory sharing functionality.

This change aims to optimize memory management between the evaluator and optimizer.

For example, the `optimizer_llm` is often bound to an MCP server. After invoking the MCP and receiving content, the LLM might sometimes "hallucinate" or produce responses inconsistent with the MCP's returned content. The `evaluator_llm`, when performing its assessment, needs access to the `optimizer_llm`'s memory to better determine if it is hallucinating or generating unexpected output. MeanWhile, optimizer_llm can do better work when having evaluator_llm's memory.
@jingx8885
Copy link
Contributor Author

@saqadri

Copy link

coderabbitai bot commented Jun 5, 2025

Walkthrough

A new share_memory parameter was added to the EvaluatorOptimizerLLM class, enabling optional memory sharing between evaluator and optimizer LLMs. The AugmentedLLM class now includes a share_memory_from method to facilitate this, allowing one instance to share its memory state with another.

Changes

File(s) Change Summary
src/mcp_agent/workflows/evaluator_optimizer/evaluator_optimizer.py Added share_memory parameter to EvaluatorOptimizerLLM constructor; invokes memory sharing logic if enabled.
src/mcp_agent/workflows/llm/augmented_llm.py Added share_memory_from method to AugmentedLLM to allow sharing of the history attribute.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EvaluatorOptimizerLLM
    participant OptimizerLLM
    participant EvaluatorLLM

    User->>EvaluatorOptimizerLLM: Instantiate (share_memory=True)
    EvaluatorOptimizerLLM->>OptimizerLLM: Initialize
    EvaluatorOptimizerLLM->>EvaluatorLLM: Initialize
    EvaluatorOptimizerLLM->>EvaluatorLLM: share_memory_from(OptimizerLLM)
    EvaluatorLLM->>OptimizerLLM: Access history
Loading

Poem

In the warren of memory, two LLMs meet,
Now sharing their thoughts, their histories complete.
With a toggle so simple, their minds intertwine,
Optimizer and evaluator, in sync by design.
Hopping ahead, they remember as one—
Collaboration enhanced, the work just begun! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c729535 and e741171.

📒 Files selected for processing (1)
  • src/mcp_agent/workflows/llm/augmented_llm.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/mcp_agent/workflows/llm/augmented_llm.py
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
src/mcp_agent/workflows/evaluator_optimizer/evaluator_optimizer.py (1)

152-153: Memory sharing implementation is correct for the stated use case.

The implementation correctly shares memory from the optimizer to the evaluator after both LLMs are initialized, which aligns with the PR objective of allowing the evaluator to assess optimizer hallucinations.

However, consider whether bidirectional memory sharing would be beneficial, as mentioned in the PR objectives that "the optimizer LLM can also benefit from having access to the evaluator LLM's memory."

If bidirectional sharing is desired, consider adding:

 if share_memory:
     self.evaluator_llm.share_memory_from(self.optimizer_llm)
+    # Optionally enable bidirectional sharing
+    # self.optimizer_llm.share_memory_from(self.evaluator_llm)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3a8fad0 and c729535.

📒 Files selected for processing (2)
  • src/mcp_agent/workflows/evaluator_optimizer/evaluator_optimizer.py (3 hunks)
  • src/mcp_agent/workflows/llm/augmented_llm.py (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/mcp_agent/workflows/evaluator_optimizer/evaluator_optimizer.py (1)
src/mcp_agent/workflows/llm/augmented_llm.py (1)
  • share_memory_from (277-278)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: checks / test
🔇 Additional comments (1)
src/mcp_agent/workflows/evaluator_optimizer/evaluator_optimizer.py (1)

78-78: Parameter addition looks good.

The share_memory parameter is appropriately added with a sensible default value of False.

Copy link
Collaborator

@saqadri saqadri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delay @jingx8885, and thanks for the contribution. In general supportive of this change, but I have questions of whether this works well in practice. Also would appreciate adding a test for this scenario as part of your change.

@@ -274,6 +274,26 @@ def __init__(
self.model_selector = self.context.model_selector
self.type_converter = type_converter

def share_memory_from(self, other: "AugmentedLLM"):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer not to add this to the main API, since someone can just do

llm.history = other_llm.history

themselves

Comment on lines +152 to +153
if share_memory:
self.evaluator_llm.share_memory_from(self.optimizer_llm)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very interesting @jingx8885, but I'm curious if this works well in practice.

I understand your point that the evaluator should consider the full interaction to be able to determine the quality. But does it catch the issues you mentioned in the PR description when it has access to the full history? Also, does the generator get confused in follow-up interactions, or does it work well?

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.

2 participants