Skip to content

Commit

Permalink
update initialize docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AlirezaMorsali committed Dec 7, 2022
1 parent 3ce8338 commit 3a8046f
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions invertedai/api/initialize.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ class InitializeResponse(BaseModel):
@validate_arguments
def initialize(
location: str,
conditional_agent_states: Optional[List[AgentState]] = None,
conditional_agent_states: Optional[List[AgentState]] = None,
conditional_agent_attributes: Optional[List[AgentAttributes]] = None,
agent_attributes: Optional[List[AgentAttributes]] = None,
states_history: Optional[List[List[AgentState]]] = None,
Expand All @@ -64,8 +64,9 @@ def initialize(
and if traffic lights are present then `traffic_light_state_history` should also be provided.
If only `agent_count` is specified, a new initial state is generated with the requested
total number of agents, which can be optionally conditioned on `conditional_agent_states` and
`conditional_agent_attributes`. Every simulation needs to start with a call to this function
in order to obtain correct recurrent states for :func:`drive`.
`conditional_agent_attributes`. If `agent_count` is higher than the number of agents in `conditional_agent_states`
and `conditional_agent_attributes`, the remaining agents will be generated conditionally on the agents provided.
Every simulation needs to start with a call to this function in order to obtain correct recurrent states for :func:`drive`.
Parameters
----------
Expand Down

0 comments on commit 3a8046f

Please sign in to comment.