LARGE_DRIVE#
- invertedai.large.large_drive(location: str, agent_states: List[AgentState], agent_properties: List[Union[AgentAttributes, AgentProperties]], recurrent_states: Optional[List[RecurrentState]] = None, traffic_lights_states: Optional[Dict[int, TrafficLightState]] = None, light_recurrent_states: Optional[List[LightRecurrentState]] = None, get_infractions: bool = False, random_seed: Optional[int] = None, api_model_version: Optional[str] = None, single_call_agent_limit: Optional[int] = None, async_api_calls: bool = True) DriveResponse[source]#
A utility function to drive more than the normal capacity of agents in a call to
drive(). The agents are inserted into a quadtree structure anddrive()is then called on each region represented by a leaf node of the quadtree. Agents near this region are included in thedrive()calls to ensure the agents see all their neighbours. The quadtree is constructed during each call to this utility function to maintain statelessness.- Parameters:
location – Please refer to the documentation of
drive()for information on this parameter.agent_states – Please refer to the documentation of
drive()for information on this parameter.agent_properties – Please refer to the documentation of
drive()for information on this parameter.recurrent_states – Please refer to the documentation of
drive()for information on this parameter.traffic_lights_states – Please refer to the documentation of
drive()for information on this parameter.light_recurrent_states – Please refer to the documentation of
drive()for information on this parameter.get_infractions – Please refer to the documentation of
drive()for information on this parameter.random_seed – Please refer to the documentation of
drive()for information on this parameter.api_model_version – Please refer to the documentation of
drive()for information on this parameter.single_call_agent_limit – The number of agents allowed in a region before it must subdivide. Currently this value represents the capacity of a quadtree leaf node that will subdivide if the number of vehicles in the region, plus relevant neighbouring regions, passes this threshold. In any case, this will be limited to the maximum currently supported by
drive().async_api_calls – A flag to control whether to use asynchronous DRIVE calls.
See also
drive()