Add environment modules #378
Conversation
There was a problem hiding this comment.
- Move the environment modules into examples like what rag and react did before, and we should consider to merge it into the library when it's ready.
- Will it enter an infinite loop? For example, agentA and agentB subscribe to the locations of each other and trigger each other, leading to an endless actions cycle.
agentA move ==> agentB listen ==> agent B move ==> agentA listen ==> agentB move ....
src/agentscope/environment/event.py
Outdated
There was a problem hiding this comment.
The abstraction of events looks great to me. Good job!
| @@ -73,16 +73,14 @@ def add( | |||
| else: | |||
| record_memories = memories | |||
|
|
|||
| # FIXME: a single message may be inserted multiple times | |||
There was a problem hiding this comment.
shall we fix it in this pr?
There was a problem hiding this comment.
Fix it in another PR may be better
| @@ -228,6 +228,18 @@ def formatted_str(self, colored: bool = False) -> str: | |||
| colored_strs.append(f"{name}: {self.url}") | |||
| return "\n".join(colored_strs) | |||
|
|
|||
| def __eq__(self, value: object) -> bool: | |||
There was a problem hiding this comment.
What if additional attributes are added to the message in the future?
There was a problem hiding this comment.
If there are new attributes, this method must be modified at the same time
| # TODO: add stream function decorator `stream_func` | ||
|
|
||
|
|
||
| def generate_oid() -> str: |
There was a problem hiding this comment.
A minor question: why is it named oid?
There was a problem hiding this comment.
short term of object_id
|
To be discussed
|
There was a problem hiding this comment.
Some of my concerns in this PR:
- The planned deprecation of placeholder may be too extensive. Consider this alternative: create a Mixin class that blocks certain remote function calls (e.g., a configurable reply). This way, the message class (and the env modules) can inherit from it, maintaining the functionality of placeholders without causing confusion in return types from an agent (
AsyncResultorMsg).
class RemoteMixin:
_enable: bool = False
__remote_attrs__ = []
def __getattr__(self, name):
if _enable and name in self.__remote_attrs__:
# ...
else:
super().__getattr__(name)
class Msg(RemoteMixin):
__remote_attrs__ = ['reply', 'observe', 'xxx']
"""Functions/attrs need to be executed/obtained from remote."""
# ...-
If feasible, try not to use metaclasses for functionality implementation. They can be challenging for developers to understand.
-
I believe the agent should be the framework's core. Thus, the design of the environment module should align with the agent's settings, not vice versa. For instance, the agent's identity should be independent of the environment and distribution modules.
Quick fix on chatroom
| ``` | ||
| @article{agentscope_simulation, | ||
| title={Very Large-Scale Multi-Agent Simulation in AgentScope}, | ||
| author={Xuchen Pan and |
There was a problem hiding this comment.
Please update the author list
Description
Add Environment Modules (
Envand its sub-classes)Envis a key concept of AgentScope, representing global data shared among agents.Each env has name and value, and multiple envs can be organized into a tree structure, where each env can have multiple children envs and one parent env.
Different implementations of envs may have different event functions, which are marked by
@event_func.Users can bind
EventListenerto specific event functions, and the listener will be activated when the event function is called.Similar to
AgentBasesub-classes,Envsub-classes also support theto_distcall, and the parameter is the same asAgentBase.Decouple distribution-related functions from other AgentScope modules
Move
to_distintoRpcMetaRpcMetais a meta-class that integrates allto_distrelated methods/parameters.Now,
to_distfunction/parameter can be used directly if the class is a subclass ofRpcMeta.The original
to_distand_AgentMetais removed.Extend
RpcAgentintoRpcObjectRpcObjectis an enhanced version ofRpcAgent, and can be used to represent any object (unlikeRpcAgentwhich can only representAgent)Users can call any public methods or get any attributes on the
RpcObject, and theRpcObjectwill forward the request to the real object running in the RPC server.The original
RpcAgentis removed.Add
@async_funcandAsyncResultto replace thereplyandPlaceholderBecause the
RpcObjectsupports calling any public methods and returns any results, the oldPlaceholdercannot cover this complex scenario. Therefore,@async_funcandAsyncResultare added.Functions decorated with
@async_funcwill automatically returnAsyncResultobjects in distributed mode.The usage of
AsyncResultis the same asPlaceholder, which is instantiated only when its internal objects are accessed.AsyncResultcan be used to represent any type of data, not justMsg.The original
PlaceholderMessageis removed.Through the above modification, the
agentandmessagemodules are decoupled from the distributed mode.Note that the user interface of the distributed mode is unchanged, all modifications above are completely hidden from the user, and all previous distributed examples can be run without any modification.
Add Guess Two Third of the Average Game example
The code of "Very Large-Scale Multi-Agent Simulation in AgentScope" is released under
examples/paper_large_scale_simulationChecklist
Please check the following items before code is ready to be reviewed.