automata v0.1.0 Automata
Link to this section Summary
Types
A map representing the results of running an agent
The error state returned by Automata.WorldInfo and Automata.AutomatonInfo
All automata start with a %State{}.
Functions
Begins update of Behavior Tree. More agent types to come. TODO: remove test env, get from config
Returns Automata configuration.
Configures Automata.
Link to this section Types
Link to this type
agent_result()
Specs
agent_result() :: %{failures: non_neg_integer(), total: non_neg_integer()}
A map representing the results of running an agent
Link to this type
failed()
Specs
failed() :: [{Exception.kind(), reason :: term(), Exception.stacktrace()}]
The error state returned by Automata.WorldInfo and Automata.AutomatonInfo
Link to this type
state()
Specs
state() :: module()
All automata start with a %State{}.
Link to this section Functions
Link to this function
begin()
Specs
begin() :: agent_result()
Begins update of Behavior Tree. More agent types to come. TODO: remove test env, get from config
Link to this function
configuration()
Specs
configuration() :: Keyword.t()
Returns Automata configuration.
Link to this function
configure(options)
Specs
configure(Keyword.t()) :: :ok
Configures Automata.
Options
Automata supports the following options:
:trace- sets Automata into trace mode, this allows agents to print info on an episode(s) while running. Any arbitrary configuration can also be passed toconfigure/1orstart/1, and these options can then be used in places such as the builtin automaton types configurations. These other options will be ignored by the Automata core itself.
Link to this function
run()
Specs
run() :: agent_result()
Runs the world. It is invoked automatically
if Automata is started via start/1.
Link to this function
start(options \\ [])
Specs
start(Keyword.t()) :: :ok
Link to this function