feat: Info channel #562

zhiyu-01 · 2024-05-19T03:32:45Z

Description

Creat a info channel class for communication between different tasks and agents.

Motivation and Context

close #521

I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds core functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation (update in the documentation)
Example (update in the folder of example)

Implemented Tasks

Subtask 1
Subtask 2
Subtask 3

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

I have read the CONTRIBUTION guide. (required)
My change requires a change to the documentation.
I have updated the tests accordingly. (required for a bug fix or a new feature)
I have updated the documentation accordingly.

coderabbitai · 2024-05-19T03:32:49Z

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.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
- Generate unit testing code for this file.
- 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 generate unit testing code for this file.
- @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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Wendong-Fan

Thanks for the contribution, left some comment. For this PR I think we need more systematic and integrated design to support our BaseMessage exchange

camel/utils/info_channel.py

Wendong-Fan · 2024-05-25T16:40:31Z

camel/utils/info_channel.py

+        self.input_queues[channel.name] = asyncio.Queue()
+        channel.input_queues[self.name] = asyncio.Queue()
+        self.output_queues[channel.name] = channel.input_queues[self.name]
+        channel.output_queues[self.name] = self.input_queues[channel.name]


ensure channels are not connected multiple times?

whether initialize a queue for both input and output will lead to inconsistencie?

It's handled in ChannelManagement.register_channel, each channel will be registered only one time.

camel/utils/info_channel.py

yiyiyi0817

Thanks @zhiyu-01! Leave some commets.

And for example part, I am considering that if the communication among a_channel, b_channel and c_channel and the task of saying hello are too general and abstract as example.

Can you show some examples of multi agents communicate with each other asynchronously by their own channel, or they communicate with a server, such as mini twitter?

Or maybe we should put in some examples of different ways channels can be organized, such as group chats or simultaneous communication with the server, in utils. And maybe the current generic channel is too abstract?

yiyiyi0817 · 2024-06-17T03:26:52Z

camel/utils/info_channel.py

+        r"""Connect to another channel.
+
+        Args:
+            channel(Channel): another channel to connect
+        """


Add more explaination to explain the meaning of connect is 'Connect the output queue of another channel to the input queue of the current cahnnel, and the input queue of another channel to the output queue of the current cahnnel' ?

yiyiyi0817 · 2024-06-17T03:37:52Z

camel/utils/info_channel.py

+
+        Args:
+            name (str): name of the channel to receive from
+        """


Add explnation for return? Such as return the message received from another channel.

yiyiyi0817 · 2024-06-17T03:54:50Z

test/utils/test_channel.py

+    assert manager.channels["A"] == channel_a
+    assert manager.channels["B"] == channel_b
+    assert check
+


Also assert the message received from another channel for this part?

zhiyu-01 added 4 commits May 16, 2024 19:29

Asynchronous mode

b2a23ad

update

5767c45

update

52005fd

info channel

5421f5c

update

1dd5b2c

Wendong-Fan assigned zhiyu-01 May 19, 2024

Wendong-Fan added the New Feature label May 19, 2024

Wendong-Fan added this to the Sprint 3 milestone May 19, 2024

Wendong-Fan linked an issue May 19, 2024 that may be closed by this pull request

[Feature Request] information channel #521

Open

2 tasks

Wendong-Fan changed the title ~~Info channel~~ feat: Info channel May 19, 2024

Wendong-Fan requested a review from a team May 20, 2024 13:58

zhiyu-01 added 3 commits May 20, 2024 23:07

Update test_channel.py

b75ed57

update

40d050d

Update info_channel.py

cf692d2

Wendong-Fan requested changes May 25, 2024

View reviewed changes

Wendong-Fan requested a review from a team May 25, 2024 16:55

zhiyu-01 added 9 commits May 27, 2024 21:36

Update info_channel.py

f862b64

update

a839e4d

Update info_channel.py

a657717

update

19781ac

Update info_channel.py

35d8d28

Update channel.py

9d92383

Update info_channel.py

5975ebc

Update test_channel.py

aa747b5

Update test_channel.py

657b436

yiyiyi0817 reviewed Jun 17, 2024

View reviewed changes

Wendong-Fan requested review from lightaime June 28, 2024 15:02

WHALEEYE closed this Jul 24, 2024

WHALEEYE deleted the info_channel branch July 24, 2024 23:55

WHALEEYE restored the info_channel branch July 24, 2024 23:59

WHALEEYE reopened this Jul 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Info channel #562

feat: Info channel #562

zhiyu-01 commented May 19, 2024

coderabbitai bot commented May 19, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Wendong-Fan left a comment

Wendong-Fan May 25, 2024

zhiyu-01 Jun 3, 2024

yiyiyi0817 left a comment

yiyiyi0817 Jun 17, 2024

yiyiyi0817 Jun 17, 2024

yiyiyi0817 Jun 17, 2024

feat: Info channel #562

Are you sure you want to change the base?

feat: Info channel #562

Conversation

zhiyu-01 commented May 19, 2024

Description

Motivation and Context

Types of changes

Implemented Tasks

Checklist

coderabbitai bot commented May 19, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Wendong-Fan left a comment

Choose a reason for hiding this comment

Wendong-Fan May 25, 2024

Choose a reason for hiding this comment

zhiyu-01 Jun 3, 2024

Choose a reason for hiding this comment

yiyiyi0817 left a comment

Choose a reason for hiding this comment

yiyiyi0817 Jun 17, 2024

Choose a reason for hiding this comment

yiyiyi0817 Jun 17, 2024

Choose a reason for hiding this comment

yiyiyi0817 Jun 17, 2024

Choose a reason for hiding this comment

coderabbitai bot commented May 19, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)