agentscope.module

agentscope中的模块。

class StateModule[source]

基础:object

agentscope中的状态模块类,用于支持嵌套状态的序列化与反序列化。

__init__()[source]

初始化状态模块。

Return type:

state_dict()[source]

获取模块的状态字典,包括嵌套状态模块和已注册属性。

Returns:

一个字典,其键为属性名,值为该属性的状态。

Return type:

字典

load_state_dict(state_dict, strict=True)[source]

将状态字典加载到模块中。

Parameters:
  • state_dict (dict) – 要加载的状态字典。

  • strict (bool, 默认为 True) – 如果为 True,当模块中的任何键在state_dict中未找到时会抛出错误。如果为 False,则跳过缺失的键。

Return type:

register_state(attr_name, custom_to_json=None, custom_from_json=None)[source]

注册一个属性以作为状态变量追踪。

Parameters:
  • attr_name (str) – 要注册属性的名称。

  • custom_to_json (Callable[[Any], JSONSerializableObject] | None, 可选) – 一个自定义函数,用于将属性转换为 JSON可序列化格式。如果未提供,将使用json.dumps

  • custom_from_json (Callable[[JSONSerializableObject], Any] | None , 默认为 None) – 用于将JSON字典转换回原始属性格式的自定义函数。

Return type: