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

pycityagent/cc/cc.py

@@ -5,7 +5,7 @@ from .trip import *
 from .conve import *
 from .user import *
 
-class Commond:
+class Command:
     """
     BrainCommond: 即脑部发出的指令; The commond from Agent's Brain
 
@@ -18,19 +18,19 @@ class Commond:
         self.target = target
         self.user_func = user_func
 
-class CommondController:
+class CommandController:
     """
     Commond控制器模组: 连接Brain以及StateTranformer
     Commond Controller module: Used to connect the Brain module and StateTransformer module
     """
-    def __init__(self, agent, config=None) -> None:
+    def __init__(self, agent) -> None:
         '''默认初始化'''
         # TODO: config配置
         self._agent = agent
         self._brain = agent._brain
-        self.commond_control = {}
+        self.command_line = {}
         """
-        控制序列: 与state关联的BrainCommond集合
+        默认控制序列: 与state关联的BrainCommond集合
         Control Hub: connect the state with a BrainCommond collection
         Type: dict[str, list[BrainCommond]]
         Default:
@@ -40,33 +40,37 @@ class CommondController:
             - conve: [whetherUserControl, whetherStopConverse]
             - controled: [whetherEndControl]
         """
-        if config != None:
-            pass
-        else:
-            self.commond_control['idle'] = [
-                Commond('gousercontrol', whetherUserControl),
-                Commond('gotrip', whetherGoTrip),
-                Commond('goshop', whetherGoShop),
-                Commond('goconverse', whetherGoConverse)
-            ]
-            self.commond_control['trip'] = [
-                Commond('gousercontrol', whetherUserControl),
-                Commond('routefailed', whetherRouteFailed),
-                Commond('arrived', whetherTripArrived)
-            ]
-            self.commond_control['shop'] = [
-                Commond('gousercontrol', whetherUserControl),
-                Commond('shopdone', whetherShopFinished)
-            ]
-            self.commond_control['conve'] = [
-                Commond('gousercontrol', whetherUserControl),
-                Commond('convedone', whetherStopConverse)
-            ]
-            self.commond_control['controled'] = [
-                Commond('controlback', whetherEndControl)
-            ]
 
-    def insertCommond(self, target_state:list[str], commond:Commond):
+        self.command_line['idle'] = [
+            Command('gousercontrol', whetherUserControl),
+            Command('gotrip', whetherGoTrip),
+            Command('goshop', whetherGoShop),
+            Command('goconverse', whetherGoConverse)
+        ]
+        self.command_line['trip'] = [
+            Command('gousercontrol', whetherUserControl),
+            Command('routefailed', whetherRouteFailed),
+            Command('arrived', whetherTripArrived)
+        ]
+        self.command_line['shop'] = [
+            Command('gousercontrol', whetherUserControl),
+            Command('shopdone', whetherShopFinished)
+        ]
+        self.command_line['conve'] = [
+            Command('gousercontrol', whetherUserControl),
+            Command('convedone', whetherStopConverse)
+        ]
+        self.command_line['controled'] = [
+            Command('controlback', whetherEndControl)
+        ]
+
+    def reset_cc(self):
+        """
+        重置命令控制器
+        """
+        self.command_line = {}
+
+    def insert_command(self, target_state:list[str], command:Command):
         """
         插入指令
         Insert Commond: This function will insert the commond to those control sequences show in target_state
@@ -76,10 +80,10 @@ class CommondController:
         - commond (Comond): the commond to be inserted
         """
         for target in target_state:
-            if target in self.commond_control.keys():
-                self.commond_control.append(commond)
+            if target in self.command_line.keys():
+                self.command_line[target].append(command)
             else:
-                self.commond_control[target] = [commond]
+                self.command_line[target] = [command]
 
     async def Run(self):
         """
@@ -92,9 +96,9 @@ class CommondController:
             - If there is a 'True' of function, returns the target commond
             - Else, return 'nothing' commond
         """
-        if self._agent.state not in self.commond_control.keys():
+        if self._agent.state not in self.command_line.keys():
             print(f"No commond control line match with current state: {self._agent.state}")
-        control_line = self.commond_control[self._agent.state]  # 获取agent状态对应的控制链
+        control_line = self.command_line[self._agent.state]  # 获取agent状态对应的控制链
         for control in control_line:
             result = await control.user_func(self._agent.Brain.Memory.Working)
             if result:

pycityagent/hubconnector/hubconnector.py

@@ -18,21 +18,9 @@ class HubConnector:
                             app_id=app_id,
                             app_secret=app_secret
                         )
-        if agent == None:
-            self._agent = None
-            self._agent_id = None
-        else:
-            self._agent = agent
-            try:
-                self._agent_id = self._client.bind_person(
-                    self._agent.base['id'], 
-                    self._agent.agent_name, 
-                    Image.open(profile_img)
-                )
-            except Exception as e:
-                traceback.print_exc()
-                print(e)
-                self._agent_id = 7
+        self._agent = agent
+        self._agent_id = None
+        self._profile_img = profile_img
         self.messageBuffer:list[AgentMessage] = []
         """
         用于存储历史前端交互信息
@@ -55,26 +43,29 @@ class HubConnector:
             app_secret=app_secret
         )
 
-    def BindAgent(self, agent, profile_img:str):
+    def BindCitizenAgent(self):
         """
-        绑定Agent
+        将CitizenAgent绑定到绑定Agent
         Bind an Agent through AppHub
-
-        Args:
-        - agent (Agent): the Agent needs to be bind with
-        - profile_img (str) : the path of profile_img, which will be shown in frontend and dashboard
         """
-        if self._client == None:
-            print("Not Connect To AppHub Yet")
-            return
-        self._agent = agent
         self._agent_id = self._client.bind_person(
-            self._agent.base['id'], 
-            self._agent.agent_name, 
-            Image.open(profile_img)
+            self._agent._id, 
+            self._agent._name, 
+            Image.open(self._profile_img)
+        )
+
+    def InsertFuncAgent(self):
+        """
+        将FuncAgent插入到AppHub中
+        Insert the Func Agent to AppHub
+        """
+        self._agent_id = self._client.bind_func(
+            self._agent._id,
+            self._agent._name,
+            Image.open(self._profile_img)
         )
 
-    def Update(self, messages:Optional[list[AgentMessage]]=None, streetview:Image=None, longlat:list[float]=None, pop:str=None):
+    def Update(self, messages:Optional[list[AgentMessage]]=None, streetview:Image.Image=None, longlat:list[float]=None, pop:str=None):
         """
         交互更新
         FrontEnd Related Update
@@ -100,12 +91,13 @@ class HubConnector:
             print("AppHub: Not Bind Agent Yet")
             return
         else:
-            pop_ = self._agent.agent_name
+            pop_ = self._agent._name
             if pop != None:
                 pop_ = self._agent.agent_name + ": " + pop
-            longlat_ = [self._agent.motion['position']['longlat_position']['longitude'], self._agent.motion['position']['longlat_position']['latitude']]
             if longlat != None:
                 longlat_ = longlat
+            else:
+                longlat_ = [self._agent.motion['position']['longlat_position']['longitude'], self._agent.motion['position']['longlat_position']['latitude']]
             
             self._client.update_agent_map(
                 agent_id = self._agent_id, 

pycityagent/image/__init__.py

@@ -1,3 +1,3 @@
 from .image import *
 
-__all__ = [AgentImage, AgentScratch]
+__all__ = [Image, CitizenImage, Scratch, CitizenScratch]

pycityagent/image/image.py

@@ -2,29 +2,44 @@ from typing import Optional
 import json
 from abc import ABC, abstractclassmethod
 
-class ProfileTemplate:
+
+class Image:
     """
-    profile模板类
-    The template class of Agent Profile
+    Image模块: 智能体画像
+    Agent's Image module: Defines the uniqueness of Agent
     """
-    def __init__(self) -> None:
-        pass
+    def __init__(self, agent) -> None:
+        self._agent = agent
+        self.scratch = Scratch()
+    
+    def get_profile(self):
+        """
+        获取Agent的Scratch Profile信息
+        Get the Scratch Profile message
 
-    @abstractclassmethod
-    def to_dialog(self) -> list[dict]:
+        Returns:
+        - (str)
         """
-        将Profile转化为LLM可用的dialog的抽象函数
-        The abstract method that turns Agent's profile to LLM standard dialog
+        return self.scratch.get_profile_content()
+    
+    def load_scratch(self, scratch_file:str):
         """
+        加载基于文件的Profile加载
+        Load Profile based on file
 
-class AgentImage:
+        Args:
+        - scratch_file (str): the path of scratch_file
+        """
+        self.scratch.load(scratch_file)
+
+class CitizenImage(Image):
     """
     Agent Image模块: 用户画像控制
     Agent's Image module: Defines the uniqueness of Agent
     """
     def __init__(self, agent, scratch_file:str=None, selfie:bool=False) -> None:
         self._agent = agent
-        self.scratch = AgentScratch()
+        self.scratch = CitizenScratch()
         """
         Agent的Scratch信息: 用于描述Agent的基本属性
         Scratch: Used to describe the basic info of Agent
@@ -48,7 +63,7 @@ class AgentImage:
         if scratch_file != None:
             self.scratch.load(scratch_file)
         else:
-            self.scratch.name = self._agent.agent_name
+            self.scratch.name = self._agent._name
             self.scratch.age = profile['age']
             education = profile['education']
             if education < 3:
@@ -72,26 +87,6 @@ class AgentImage:
             # TODO: 补充自拍
             pass
 
-    def get_profile(self):
-        """
-        获取Agent的Scratch Profile信息
-        Get the Scratch Profile message
-
-        Returns:
-        - (str)
-        """
-        return self.scratch.get_profile_content()
-    
-    def load_scratch(self, scratch_file:str):
-        """
-        加载基于文件的Profile加载
-        Load Profile based on file
-
-        Args:
-        - scratch_file (str): the path of scratch_file
-        """
-        self.scratch.load(scratch_file)
-
     def load_selfie(self, selfie_file:str):
         """
         基于图像的Selfie加载
@@ -103,17 +98,8 @@ class AgentImage:
         """
         print("Not Implemented")
 
-class AgentScratch():
-    def __init__(self, scratch:Optional[dict]=None) -> None:
-        self.name = None
-        self.age = None
-        self.education = None
-        self.gender = None
-        self.consumption = None
-        self.innate = ''
-        self.learned = ''
-        self.currently = ''
-        self.lifestyle = ''
+class Scratch:
+    def __init__(self, scratch: Optional[dict]=None) -> None:
         if scratch != None:
             self.forward(scratch)
 
@@ -133,6 +119,25 @@ class AgentScratch():
             json_str = f.read()
             scratch = json.loads(json_str)
             self.forward(scratch)
+
+    def get_profile_content(self):
+        text = ""
+        for attr_name, attr_value in self.__dict__.items():
+            text += f"{attr_name}: {attr_value}\n"
+        return text
+
+class CitizenScratch(Scratch):
+    def __init__(self, scratch:Optional[dict]=None) -> None:
+        super().__init__(scratch=scratch)
+        self.name = None
+        self.age = None
+        self.education = None
+        self.gender = None
+        self.consumption = None
+        self.innate = ''
+        self.learned = ''
+        self.currently = ''
+        self.lifestyle = ''
     
     def get_str_lifestyle(self):
         return self.lifestyle
@@ -153,6 +158,5 @@ class AgentScratch():
         text += f'生活习惯: {self.lifestyle}\n'
         return text
 
-
     def __str__(self):
         return str(self.__dict__)

pycityagent/simulator.py

@@ -1,10 +1,11 @@
 from pycitysim import *
-from pycitysim.sidecar import OnlyClientSidecar
+from pycitysim.routing import RoutingClient
 from pycitysim.sim import CityClient
 from typing import Optional, Union
 from datetime import datetime, timedelta
 import asyncio
-from .agent import Agent
+from .agent_citizen import CitizenAgent
+from .agent_func import FuncAgent
 
 class SimPerceive:
     """
@@ -44,6 +45,7 @@ class Simulator:
             mongo_coll = config['map_request']['mongo_coll'],
             cache_dir = config['map_request']['cache_dir'],
         )
+        self.routing = RoutingClient(self.config['route_request']['server'], True)
         self.time = 0
 
     # * Agent相关
@@ -72,7 +74,7 @@ class Simulator:
             resp.motions = motions
             return resp
 
-    async def GetAgent(self, name:str=None, id:int=None):
+    async def GetCitizenAgent(self, name:str, id:int):
         """
         获取agent
         Get Agent
@@ -82,46 +84,44 @@ class Simulator:
         - id int: 即绑定的person的id the id of person that you try to bind with
         
         Returns:
-        - Agent
+        - CitizenAgent
         """
         await self.GetTime()
-        name_ = "张三"
-        if name != None:
-            name_ = name
-        if id == None:
-            base = self._client.person_service.default_person()
-            agent = Agent(
-                name_, 
-                self.config['simulator']['server'], 
-                simulator=self, 
-                id=id, 
-                base=base,
-            )
-        else:
-            resp = await self._client.person_service.GetPerson({"person_id": id})
-            base = resp['base']
-            motion = resp['motion']
-            agent = Agent(
-                name_, 
-                self.config['simulator']['server'], 
-                simulator=self, 
-                id=id, 
-                base=base,
-                motion=motion,
-            )
-        if 'streetview_request' in self.config.keys():
-            agent.Brain.Sence._streetview_engine = self.config['streetview_request']['engine']
-            if agent.Brain.Sence._streetview_engine == 'baidumap':
-                agent.Brain.Sence._streetviewAK = self.config['streetview_request']['mapAK']
-            elif agent.Brain.Sence._streetview_engine == 'googlemap':
-                if 'proxy' in self.config['streetview_request'].keys():
-                    agent.Brain.Sence._streetviewProxy = self.config['streetview_request']['proxy']
-            else:
-                agent.Brain.Sence._streetview_engine = ""
-                print("Wrong Streetview Engine")
+        resp = await self._client.person_service.GetPerson({"person_id": id})
+        base = resp['base']
+        motion = resp['motion']
+        agent = CitizenAgent(
+            name, 
+            self.config['simulator']['server'], 
+            simulator=self, 
+            id=id, 
+            base=base,
+            motion=motion
+        )
+        agent.set_streetview_config(self.config['streetview_request'])
+        return agent
+
+    async def GetFuncAgent(self, id:int, name:str):
+        """
+        获取一个Func Agent模板
+
+        Args:
+        - name (str): the name of your agent
+        - id (int): the unique id of agent
+
+        Returns:
+        - FuncAgent
+        """
+        agent = FuncAgent(
+                    name,
+                    id+10000000,
+                    self.config['simulator']['server'],
+                    simulator=self
+                )
+        agent.set_streetview_config(self.config['streetview_request'])
         return agent
 
-    def InsertAgent(self, profile):
+    def InsertCitizenAgent(self, profile):
         """
         插入agent
         Insert Agent

pycityagent/st/st.py

@@ -3,8 +3,8 @@ from abc import ABC, abstractmethod
 
 class StateTransformer:
     """
-    State Transformer模块: 控制agent状态转移
-    The State Transformer module: used to control the transformation of agent's state
+    默认State Transformer模块: 控制agent状态转移
+    Default State Transformer module: used to control the transformation of agent's state
 
     Doc:
     - 基于transitions()构建 https://github.com/tyarkoni/transitions
@@ -42,14 +42,14 @@ class StateTransformer:
             - controlback: controled -> idle
     - Note: 目前不支持状态扩展
     """
-    states = ['idle', 'trip', 'shop', 'conve', 'paused', 'controled']
+    _states = ['idle', 'trip', 'shop', 'conve', 'paused', 'controled']
 
     def __init__(self, config=None):
         self.pre_state = None
-        # TODO: 后续添加扩展接口
         # Initialize the state machine
-        self.machine = Machine(model=self, states=StateTransformer.states, initial='idle')
-
+        self.machine = Machine(states=StateTransformer._states, initial='idle')
+        self.machine._transition_queue
+        
         # idle
         self.machine.add_transition(trigger='gotrip', source='idle', dest='trip')
         self.machine.add_transition(trigger='goshop', source='idle', dest='shop')
@@ -81,11 +81,45 @@ class StateTransformer:
         self.machine.add_transition(trigger='gousercontrol', source='*', dest='controled')
         self.machine.add_transition(trigger='controlback', source='controled', dest='idle')
 
+    def reset_state_transformer(self, states:list[str], initial:str):
+        """
+        重置状态控制器——重置后状态转化器没有任何可用transition
+
+        Args:
+        - states (list[str]): a list of states
+        - initial (str): initial state
+        """
+        self.machine = Machine(states=states, initial=initial)
+        self.machine.add_transition(trigger='nothing', source='*', dest='=')
+
+
+    def add_transition(self, trigger:str, source: str, dest:str, before=None, after=None):
+        """
+        添加状态转换
+        Add state transition
+
+        Args:
+        - trigger (str): 用于唤醒该状态转换器
+        - source (str): 源状态, 如为'*' 表示任意状态皆可作为源状态
+        - dest (str): 目标状态, 如为'=' 表示目标状态与原状态相同
+        - defore (func): 即状态转化后执行的操作
+        - after (func): 即状态转化前执行的操作
+        """
+        self.machine.add_transition(trigger=trigger, source=source, dest=dest, before=before, after=after)
+
     def state_remember(self):
+        """
+        记住当前状态并存储于pre_state属性中
+        Remember current state and store it to 'pre_state' attribute
+        """
         if self.state != 'paused':  # 避免重复Pause
             self.pre_state = self.state
 
     def pause_back(self):
+        """
+        从原状态恢复, 即恢复为pre_state记录的状态
+        Recover from pre_state
+        """
         if self.pre_state == 'trip':
             self.active_trip()
         elif self.pre_state == 'shop':
@@ -93,4 +127,7 @@ class StateTransformer:
         elif self.pre_state == 'conve':
             self.active_conve()
         elif self.pre_sate == 'idle':
-            self.active_idle()
+            self.active_idle()
+
+    def trigger(self, command:str):
+        self.machine.trigger(command)

pycityagent/urbanllm/urbanllm.py

@@ -82,7 +82,7 @@ class UrbanLLM:
         """
         ppt = "如何理解这幅图像？"
         if prompt != None:
-            ppt += prompt
+            ppt = prompt
         dialog = [{
             'role': 'user',
             'content': [
@@ -101,7 +101,7 @@ class UrbanLLM:
             print(response.code)  # The error code.
             return "Error"
 
-    def img_generate(self, prompt, size:str='512*512', quantity:int = 1):
+    def img_generate(self, prompt:str, size:str='512*512', quantity:int = 1):
         """
         图像生成
         Image generation