pycityagent 1.0.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

pycityagent/agent.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import Optional, Union
+from typing import Optional, Union, Callable
 import PIL.Image as Image
 from PIL.Image import Image
 import asyncio
@@ -10,22 +10,30 @@ from pycityagent.urbanllm import UrbanLLM
 from .urbanllm import UrbanLLM
 from .brain.brain import Brain
 from .hubconnector.hubconnector import HubConnector
-from .image.image import AgentImage
-from .ac.ac import ActionController
-from .cc.cc import CommondController
-from .st.st import StateTransformer
+from .ac import ActionController
+from .cc import CommandController
+from .st import StateTransformer
 
+class AgentType:
+    """
+    Agent类型
+
+    - Citizen = 1, 指城市居民类型agent——行动受城市规则限制
+    - Func = 2, 功能型agent——行动规则宽松——本质上模拟器无法感知到Func类型的agent
+    """
+    Citizen = 1
+    Func = 2
 
 class Template:
     """
     The basic template of Agent
     """
-    def __init__(self, name, server, soul:UrbanLLM=None, simulator=None, id:int=None) -> None:
-        self.agent_name = name
+    def __init__(self, name, server, type:AgentType, soul:UrbanLLM=None, simulator=None) -> None:
+        self._name = name
         self._client = CityClient(server)
+        self._type = type
         self._soul = soul
         self._simulator = simulator
-        self._id = id
 
     def add_soul(self, llm_engine:UrbanLLM):
         """
@@ -59,69 +67,46 @@ class Agent(Template):
             self, 
             name:str, 
             server:str, 
+            type:AgentType,
             soul:UrbanLLM=None, 
-            simulator=None, 
-            id:int=None, 
-            base=None,
-            motion=None,
-            scratch_file:str=None,
-            selfie:bool = False,
-            connect_to_hub:bool=False,
-            hub_url:str=None,
-            app_id:int=None,
-            app_secret:str=None,
-            profile_img:str=None
+            simulator=None
         ) -> None:
-        super().__init__(name, server, soul, simulator, id)
-        self.base = base
-        """
-        Agent/Person的基本属性, Agent指被代理的Person, Person指模拟器中的背景人
-        The base attributes of Agent/Person. Agent is the Person being represented. Persons are background persons in simulator
-        - https://cityproto.sim.fiblab.net/#city.agent.v2.Agent
-        """
-        self.motion = motion
-        """
-        Agent/Person的运动信息
-        The motion information of Agent/Person
-        - https://cityproto.sim.fiblab.net/#city.agent.v2.AgentMotion
-        """
-        if connect_to_hub:
-            self._hub_connector = HubConnector(
-                hub_url=hub_url,
-                app_id=app_id,
-                app_secret=app_secret,
-                agent=self,
-                profile_img=profile_img
-            )
-        else:
-            self._hub_connector = None
-        self._image = AgentImage(self, scratch_file, selfie)
+        super().__init__(name, server, type, soul, simulator)
+
+        self._hub_connector = None
         """
-        Agent画像
-        The Agent's Image
+        HubConnector: 用于和AppHub对接——可以通过Agent.connectToHub进行绑定
+        HubConnector: the connection between agent and AppHub, you can use 'Agent.connectToHub' to create the connection
         """
+
         self._brain = Brain(self)
         """
         Agent的大脑
         The Agent's Brain
         """
-        self._ac = ActionController(self)
-        """
-        Agent的行为控制器
-        The Agent's ActionController
-        """
-        self._cc = CommondController(self)
+
+        self._cc = CommandController(self)
         """
         Agent的命令控制器
         The Agent's CommondController
         """
+
         self._st = StateTransformer()
         """
         与Agent关联的状态转移器
         The related StateTransformer
         """
-        # * 默认trip构建
-        self.Scheduler.schedule_init()
+
+        self._ac = ActionController(self)
+        """
+        Agent的行为控制器
+        The Agent's ActionController
+        """
+
+        self._step_with_action = True
+        """
+        Step函数是否包含action执行 —— 当有自定义action需求(特指包含没有指定source的Action)时可置该选项为False并通过自定义方法执行action操作
+        """
     
     def ConnectToHub(self, config:dict):
         """
@@ -141,6 +126,31 @@ class Agent(Template):
             agent=self,
             profile_img=profile_img
         )
+
+    def set_streetview_config(self, config:dict):
+        """
+        街景感知配置
+        - engine: baidumap / googlemap
+        - mapAK: your baidumap AK (if baidumap)
+        - proxy: your googlemap proxy (if googlemap, optional)
+        """
+        if 'engine' in config:
+            if config['engine'] == 'baidumap':
+                self.Brain.Sence._engine = config['engine']
+                if 'mapAK' in config:
+                    self.Brain.Sence._baiduAK = config['mapAK']
+                else:
+                    print("ERROR: Please Provide a baidumap AK")
+            elif config['engine'] == 'googlemap':
+                self.Brain.Sence._engine = config['engine']
+                if 'proxy' in config:
+                    self.Brain.Sence._googleProxy = config['proxy']
+                else:
+                    print("ERROR: Please provide a googlemap proxy")
+            else:
+                print("ERROR: Wrong engine, only baidumap / googlemap are available")
+        else:
+            print("ERROR: Please provide a streetview engine, baidumap / googlemap")
     
     def enable_streetview(self):
         """
@@ -170,51 +180,36 @@ class Agent(Template):
         """
         self._brain.Memory.Working.enable_user_interaction = False
 
-    def enable_economy_behavior(self):
-        """
-        开启经济模拟相关功能(例如购物)
-        Enable Economy function. Shopping for instance.
+    def set_step_with_action(self, flag:bool = None):
         """
-        self.Brain.Memory.Working.enable_economy = True
-
-    def disable_economy_behavior(self):
+        默认情况置反step_with_action属性: 即True->False, False->True
+        否则根据传入的flag进行设置
         """
-        关闭经济模拟相关功能
-        Disable Economy function
-        """
-        self.Brain.Memory.Working.enable_economy = False
-
-    def enable_social_behavior(self):
-        """
-        开启社交相关功能
-        Enable Social function
-        """
-        self.Brain.Memory.Working.enable_social = True
-
-    def diable_social_behavior(self):
-        """
-        关闭社交相关功能
-        Disable Social function
-        """
-        self.Brain.Memory.Working.enable_social = False
-
-    async def Pause(self):
-        """
-        暂停Agent行为使Agent进入'pause'状态
-        Pause the Agent, making the agent 'pause'
+        if flag != None:
+            self._step_with_action = flag
+        else:
+            self._step_with_action = not self._step_with_action
+        
 
-        """
-        req = {'person_id': self.base['id'], 'schedules': []}
-        await self._client.person_service.SetSchedule(req)
-        self.Scheduler.unset_schedule()
-        self._st.trigger('pause')
+    def sence_config(self, sence_content:Optional[list]=None, sence_radius:int=None):
+        '''
+        感知配置
 
-    async def Active(self):
-        """
-        恢复Agent行为
-        Recover from 'pause'
-        """
-        self._st.pause_back()
+        Args:
+        - config: 配置选项——包含需要感知的数据类型
+            - time: 时间
+            - poi: 感兴趣地点
+            - position: 可达地点
+            - lane: 周围道路
+            - person: 周围活动person
+            - streetview: 街景
+            - user_message: 用户交互信息
+            - agent_message: 智能体交互信息
+        '''
+        if sence_content != None:
+            self._brain._sence.set_sence(sence_content)
+        if sence_radius != None:
+            self._brain._sence.set_sence_radius(sence_radius)
 
     async def Run(self, round:int=1, interval:int=1, log:bool=True):
         """
@@ -238,49 +233,8 @@ class Agent(Template):
         单步Agent执行流
         Single step entrance
         (Not recommended, use Run() method)
-
-        Args:
-        - log (bool): 是否输出log信息. Whether console log message
-        """
-        if self.state != 'paused':
-            # * 1. 模拟器时间更新
-            await self._simulator.GetTime()
-            # * 2. 拉取Agent最新状态
-            resp = await self._client.person_service.GetPerson({'person_id':self._id})
-            self.base = resp['base']
-            self.motion = resp['motion']
-            # * 3. Brain工作流
-            await self._brain.Run()
-            # * 4. Commond Controller工作流
-            commond = await self._cc.Run()
-            # * 5. State Transformer工作流
-            self._st.trigger(commond)
-            # * 6. Action Controller工作流
-            await self._ac.Run()
-        if log:
-            print(f"---------------------- SIM TIME: {self._simulator.time} ----------------------")
-            self.show_yourself()
-    
-    def show_yourself(self):
-        """
-        Log信息输出
-        Pring log message
         """
-        print(f"【State Message】: {self.state}")
-        motion_message = ''''''
-        motion_message += f'''行为状态: {self.motion['status']}, '''
-        if 'lane_position' in self.motion['position'].keys():
-            motion_message += f'''位置信息: lane-{self.motion['position']['lane_position']['lane_id']}'''
-        else:
-            motion_message += f'''位置信息: aoi-{self.motion['position']['aoi_position']['aoi_id']}'''
-        motion_message += f'''-[x: {self.motion['position']['xy_position']['x']}, y: {self.motion['position']['xy_position']['y']}]'''
-        print(f'【Simulator Motion Message】: \n{motion_message}')
-        print(self.Scheduler)
-    
-    @property
-    def Image(self):
-        """The Agent's Image"""
-        return self._image
+        pass
     
     @property
     def Soul(self):
@@ -296,16 +250,11 @@ class Agent(Template):
     def ActionController(self):
         """The Agents's ActionController"""
         return self._ac
-
-    @property
-    def Scheduler(self):
-        """The Agent's Scheduler"""
-        return self._brain.Memory.Working.scheduler
     
     @property
     def state(self):
         """The state of the Agent"""
-        return self._st.state
+        return self._st.machine.state
     
     @property
     def StateTransformer(self):
@@ -315,4 +264,9 @@ class Agent(Template):
     @property
     def Hub(self):
         """The connected AppHub"""
-        return self._hub_connector
+        return self._hub_connector
+    
+    @property
+    def CommandController(self):
+        """The command controller"""
+        return self._cc

pycityagent/agent_citizen.py

@@ -0,0 +1,158 @@
+from pycityagent.urbanllm import UrbanLLM
+from .urbanllm import UrbanLLM
+from .agent import Agent, AgentType
+from .image.image import CitizenImage
+
+class CitizenAgent(Agent):
+    """
+    Citizen Agent
+    城市居民智能体
+    """
+
+    def __init__(
+            self, 
+            name:str, 
+            server:str, 
+            id:int, 
+            soul:UrbanLLM=None, 
+            simulator=None, 
+            base=None,
+            motion=None
+        ) -> None:
+        super().__init__(name, server, AgentType.Citizen, soul, simulator)
+        self._id = id
+        self.base = base
+        """
+        Agent/Person的基本属性, Agent指被代理的Person, Person指模拟器中的背景人
+        The base attributes of Agent/Person. Agent is the Person being represented. Persons are background persons in simulator
+        - https://cityproto.sim.fiblab.net/#city.agent.v2.Agent
+        """
+        self.motion = motion
+        """
+        Agent/Person的运动信息
+        The motion information of Agent/Person
+        - https://cityproto.sim.fiblab.net/#city.agent.v2.AgentMotion
+        """
+
+        self._image = CitizenImage(self)
+        """
+        Agent画像
+        The Agent's Image
+        """
+
+        self.Scheduler.schedule_init()
+        """
+        行程初始化
+        """
+
+    def Bind(self):
+        """
+        将智能体绑定到AppHub
+        Bind Agent with AppHub
+        """
+        if self._hub_connector == None:
+            print("ERROR: connect with apphub first")
+        else:
+            self._hub_connector.BindCitizenAgent()
+
+
+    def enable_economy_behavior(self):
+        """
+        开启经济模拟相关功能(例如购物)
+        Enable Economy function. Shopping for instance.
+        """
+        self.Brain.Memory.Working.enable_economy = True
+
+    def disable_economy_behavior(self):
+        """
+        关闭经济模拟相关功能
+        Disable Economy function
+        """
+        self.Brain.Memory.Working.enable_economy = False
+
+    def enable_social_behavior(self):
+        """
+        开启社交相关功能
+        Enable Social function
+        """
+        self.Brain.Memory.Working.enable_social = True
+
+    def diable_social_behavior(self):
+        """
+        关闭社交相关功能
+        Disable Social function
+        """
+        self.Brain.Memory.Working.enable_social = False
+
+    async def Pause(self):
+        """
+        暂停Agent行为使Agent进入'pause'状态
+        Pause the Agent, making the agent 'pause'
+
+        """
+        req = {'person_id': self.base['id'], 'schedules': []}
+        await self._client.person_service.SetSchedule(req)
+        self.Scheduler.unset_schedule()
+        self._st.trigger('pause')
+
+    async def Active(self):
+        """
+        恢复Agent行为
+        Recover from 'pause'
+        """
+        self._st.pause_back()
+
+    async def Step(self, log:bool):
+        """
+        单步Agent执行流
+        Single step entrance
+        (Not recommended, use Run() method)
+
+        Args:
+        - log (bool): 是否输出log信息. Whether console log message
+        """
+        if self.state != 'paused':
+            # * 1. 模拟器时间更新
+            await self._simulator.GetTime()
+            # * 2. 拉取Agent最新状态
+            resp = await self._client.person_service.GetPerson({'person_id':self._id})
+            self.base = resp['base']
+            self.motion = resp['motion']
+            # * 3. Brain工作流
+            await self._brain.Run()
+            # * 4. Commond Controller工作流
+            commond = await self._cc.Run()
+            # * 5. State Transformer工作流
+            self._st.trigger(commond)
+            # * 6. Action Controller工作流
+            if self._step_with_action:
+                await self._ac.Run()
+        if log:
+            print(f"---------------------- SIM TIME: {self._simulator.time} ----------------------")
+            self.show_yourself()
+    
+    def show_yourself(self):
+        """
+        Log信息输出
+        Pring log message
+        """
+        print(f"【State Message】: {self.state}")
+        motion_message = ''''''
+        motion_message += f'''行为状态: {self.motion['status']}, '''
+        if 'lane_position' in self.motion['position'].keys():
+            motion_message += f'''位置信息: lane-{self.motion['position']['lane_position']['lane_id']}'''
+        else:
+            motion_message += f'''位置信息: aoi-{self.motion['position']['aoi_position']['aoi_id']}'''
+        motion_message += f'''-[x: {self.motion['position']['xy_position']['x']}, y: {self.motion['position']['xy_position']['y']}]'''
+        print(f'【Simulator Motion Message】: \n{motion_message}')
+        print(self.Scheduler)
+
+    @property
+    def Image(self):
+        """The Agent's Image"""
+        return self._image
+
+    @property
+    def Scheduler(self):
+        """The Agent's Scheduler"""
+        return self._brain.Memory.Working.scheduler

pycityagent/agent_func.py

@@ -0,0 +1,115 @@
+from pycityagent.urbanllm import UrbanLLM
+from .urbanllm import UrbanLLM
+from .agent import Agent, AgentType
+from .image.image import Image
+from .ac.hub_actions import PositionUpdate
+
+class FuncAgent(Agent):
+    """
+    Fuctional Agent
+    功能型Agent
+    """
+
+    def __init__(
+            self, 
+            name:str, 
+            id: int,
+            server:str, 
+            soul:UrbanLLM=None, 
+            simulator=None, 
+        ) -> None:
+        super().__init__(name, server, AgentType.Func, soul, simulator)
+        self._id = id
+        self._image = Image(self)
+        """
+        Func Agent画像——支持自定义内容
+        """
+
+        self.motion = {'id': id, 'position': {}, 'direction': 0}
+        """
+        Func Agent状态信息——与agent的sence高度相关
+        - id (int): 即agent id
+        - position (https://cityproto.sim.fiblab.net/#city.geo.v2.Position): 即agent当前的位置描述信息
+            - lane_position (dict): 当position中包含该key时表示agent当前位于lane上——与aoi_position不可同时存在
+                - lane_id (int)
+                - s (double)
+            - aoi_position (dict): 当position中包含该key时表示agent当前位于aoi中——与lane_position不可同时存在
+                - aoi_id (int)
+                - poi_id (optional[int])
+            - longlat_position (dict): WGS84经纬度坐标位置
+                - longitude (double): 经度
+                - latitude (double): 纬度
+                - z (optional[double]): 高程信息
+            - xy_position (dict): 坐标系表示的位置
+                - x (double)
+                - y (double)
+                - z (double)
+        - direction (double): 方向角
+        """
+
+    async def init_position_aoi(self, aoi_id:int):
+        """
+        将agent的位置初始化到指定aoi
+        根据指定aoi设置aoi_position, longlat_position以及xy_position
+        """
+        if aoi_id in self._simulator.map.aois:
+            aoi = self._simulator.map.aois[aoi_id]
+            self.motion['position']['aoi_position'] = {'aoi_id': aoi_id}
+            self.motion['position']['longlat_position'] = {'longitude': aoi['shapely_lnglat'].centroid.coords[0][0], 'latitude': aoi['shapely_lnglat'].centroid.coords[0][1]}
+            x, y = self._simulator.map.lnglat2xy(lng=self.motion['position']['longlat_position']['longitude'], 
+                                                 lat=self.motion['position']['longlat_position']['latitude'])
+            self.motion['position']['xy_position'] = {'x': x, 'y': y}
+        pos = PositionUpdate(self)
+        await pos.Forward(longlat=[self.motion['position']['longlat_position']['longitude'], self.motion['position']['longlat_position']['latitude']])
+
+    def Bind(self):
+        """
+        将智能体绑定到AppHub
+        Bind the Agent with AppHub
+        """
+        if self._hub_connector == None:
+            print("ERROR: connect with apphub first")
+        else:
+            self._hub_connector.InsertFuncAgent()
+
+    def set_image(self, image: Image):
+        """
+        设置image——支持自由扩展Image
+        """
+        self._image = image
+
+    async def Step(self, log:bool):
+        """
+        单步Agent执行流
+        Single step entrance
+        (Not recommended, use Run() method)
+
+        Args:
+        - log (bool): 是否输出log信息. Whether console log message
+        """
+        # * 1. 模拟器时间更新
+        await self._simulator.GetTime()
+        # * 2. Brain工作流
+        await self._brain.Run()
+        # * 3. Commond Controller工作流
+        command = await self._cc.Run()
+        # * 4. State Transformer工作流
+        self._st.trigger(command)
+        # * 5. Action Controller工作流
+        if self._step_with_action:
+            await self._ac.Run()
+        if log:
+            print(f"---------------------- SIM TIME: {self._simulator.time} ----------------------")
+            self.show_yourself()
+    
+    def show_yourself(self):
+        """
+        Log信息输出
+        Pring log message
+        """
+        pass
+
+    @property
+    def Image(self):
+        """The Agent's Image"""
+        return self._image

pycityagent/brain/__init__.py

@@ -7,4 +7,4 @@ from .scheduler import *
 from .sence import *
 from .static import *
 
-__all__ = [Brain, BrainFunction, MemoryController, Memory, MemoryPersistence, MemoryRetrive, MemoryReason, MemoryType, ScheduleType, Scheduler, Sence, SencePlug, POI_TYPE_DICT]
+__all__ = [Brain, BrainFunction, MemoryController, Memory, WorkingMemory, LTMemory, MemoryPersistence, MemoryRetrive, MemoryReason, MemoryType, ScheduleType, Scheduler, Sence, SencePlug, POI_TYPE_DICT]