Phantom
latest
User Guide
Installing Phantom
Quickstart
Tutorial - Part 1
Tutorial - Part 2
Phantom Design
Design Patterns
Finite State Machine Environment Design Patterns
Environment Execution
Network
Supertypes
API Reference
Agents
Context
Decoders
Encoders
Environment
Env Wrappers
Finite State Machine Environment
Metrics
Message
Network
Policy
Resolvers
Rewards
RLlib Utilities
Stackelberg Environment
Types & Supertypes
Telemetry Logger
Trainers
Utilities
Views
Phantom
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
acting_agents (phantom.fsm.FSMStage attribute)
action_space (phantom.decoders.ChainedDecoder property)
(phantom.decoders.Decoder property)
(phantom.decoders.EmptyDecoder property)
(phantom.env_wrappers.SingleAgentEnvAdapter property)
actions_for_agent() (phantom.utils.rollout.Rollout method)
add_agent() (phantom.network.Network method)
(phantom.network.StochasticNetwork method)
add_agents() (phantom.network.Network method)
(phantom.network.StochasticNetwork method)
add_connection() (phantom.network.Network method)
(phantom.network.StochasticNetwork method)
add_connections_between() (phantom.network.Network method)
(phantom.network.StochasticNetwork method)
add_connections_from() (phantom.network.Network method)
(phantom.network.StochasticNetwork method)
add_connections_with_adjmat() (phantom.network.Network method)
(phantom.network.StochasticNetwork method)
Agent (class in phantom.agents)
agent (phantom.Context attribute)
agent_ids (phantom.env_wrappers.SingleAgentEnvAdapter property)
(phantom.fsm.FiniteStateMachineEnv property)
(phantom.network.Network property)
(phantom.network.StochasticNetwork property)
(phantom.PhantomEnv property)
(phantom.stackelberg.StackelbergEnv property)
agent_supertypes (phantom.PhantomEnv attribute)
agent_views (phantom.Context attribute)
agents (phantom.env_wrappers.SingleAgentEnvAdapter property)
(phantom.fsm.FiniteStateMachineEnv property)
(phantom.network.Network attribute)
(phantom.network.StochasticNetwork attribute)
(phantom.PhantomEnv property)
(phantom.stackelberg.StackelbergEnv property)
AgentStep (class in phantom.utils.rollout)
AgentView (class in phantom.views)
AggregatedAgentMetric (class in phantom.metrics)
B
BatchResolver (class in phantom.resolvers)
C
chain() (phantom.decoders.ChainedDecoder method)
(phantom.decoders.Decoder method)
(phantom.decoders.EmptyDecoder method)
(phantom.encoders.ChainedEncoder method)
(phantom.encoders.Constant method)
(phantom.encoders.EmptyEncoder method)
(phantom.encoders.Encoder method)
ChainedDecoder (class in phantom.decoders)
ChainedEncoder (class in phantom.encoders)
clear_tracked_messages() (phantom.resolvers.BatchResolver method)
(phantom.resolvers.Resolver method)
close() (phantom.env_wrappers.SingleAgentEnvAdapter method)
(phantom.fsm.FiniteStateMachineEnv method)
(phantom.PhantomEnv method)
(phantom.stackelberg.StackelbergEnv method)
collect_infos() (phantom.agents.StrategicAgent method)
ComparableSampler (class in phantom.utils.samplers)
compute_action() (phantom.policy.Policy method)
compute_reward() (phantom.agents.StrategicAgent method)
configure_file_logging() (phantom.telemetry.TelemetryLogger method)
configure_print_logging() (phantom.telemetry.TelemetryLogger method)
Constant (class in phantom.encoders)
(class in phantom.reward_functions)
Context (class in phantom)
context_for() (phantom.network.Network method)
(phantom.network.StochasticNetwork method)
count() (phantom.fsm.FiniteStateMachineEnv.Step method)
(phantom.PhantomEnv.Step method)
(phantom.stackelberg.StackelbergEnv.Step method)
count_actions() (phantom.utils.rollout.Rollout method)
count_agent_actions() (phantom.utils.rollout.Rollout method)
current_stage (phantom.fsm.FiniteStateMachineEnv property)
current_step (phantom.env_wrappers.SingleAgentEnvAdapter property)
(phantom.fsm.FiniteStateMachineEnv property)
(phantom.PhantomEnv property)
(phantom.stackelberg.StackelbergEnv property)
D
decode() (phantom.decoders.ChainedDecoder method)
(phantom.decoders.Decoder method)
(phantom.decoders.EmptyDecoder method)
decode_action() (phantom.agents.StrategicAgent method)
Decoder (class in phantom.decoders)
decoders (phantom.decoders.ChainedDecoder attribute)
E
EmptyDecoder (class in phantom.decoders)
EmptyEncoder (class in phantom.encoders)
encode() (phantom.encoders.ChainedEncoder method)
(phantom.encoders.Constant method)
(phantom.encoders.EmptyEncoder method)
(phantom.encoders.Encoder method)
encode_observation() (phantom.agents.StrategicAgent method)
Encoder (class in phantom.encoders)
encoders (phantom.encoders.ChainedEncoder attribute)
env_supertype (phantom.PhantomEnv attribute)
env_view (phantom.Context attribute)
EnvView (class in phantom.views)
evaluate_policy() (in module phantom.utils.rllib)
extract() (phantom.metrics.AggregatedAgentMetric method)
(phantom.metrics.Metric method)
(phantom.metrics.SimpleAgentMetric method)
(phantom.metrics.SimpleEnvMetric method)
F
FiniteStateMachineEnv (class in phantom.fsm)
FiniteStateMachineEnv.Step (class in phantom.fsm)
FSMEnvView (class in phantom.fsm)
FSMRuntimeError (class in phantom.fsm)
FSMStage (class in phantom.fsm)
FSMValidationError (class in phantom.fsm)
G
get_agents_where() (phantom.network.Network method)
(phantom.network.StochasticNetwork method)
get_agents_with_type() (phantom.network.Network method)
(phantom.network.StochasticNetwork method)
get_agents_without_type() (phantom.network.Network method)
(phantom.network.StochasticNetwork method)
graph (phantom.network.Network attribute)
(phantom.network.StochasticNetwork attribute)
H
handle_batch() (phantom.agents.Agent method)
(phantom.agents.StrategicAgent method)
handle_message() (phantom.agents.Agent method)
(phantom.agents.StrategicAgent method)
handle_push() (phantom.resolvers.BatchResolver method)
(phantom.resolvers.Resolver method)
handler (phantom.fsm.FSMStage attribute)
has_edge() (phantom.network.Network method)
(phantom.network.StochasticNetwork method)
I
id (phantom.agents.Agent property)
(phantom.agents.StrategicAgent property)
(phantom.fsm.FSMStage attribute)
index() (phantom.fsm.FiniteStateMachineEnv.Step method)
(phantom.PhantomEnv.Step method)
(phantom.stackelberg.StackelbergEnv.Step method)
infos (phantom.fsm.FiniteStateMachineEnv.Step attribute)
(phantom.PhantomEnv.Step attribute)
,
[1]
(phantom.stackelberg.StackelbergEnv.Step attribute)
infos_for_agent() (phantom.utils.rollout.Rollout method)
initial_stage (phantom.fsm.FiniteStateMachineEnv property)
is_terminated() (phantom.agents.StrategicAgent method)
(phantom.fsm.FiniteStateMachineEnv method)
(phantom.PhantomEnv method)
(phantom.stackelberg.StackelbergEnv method)
is_truncated() (phantom.agents.StrategicAgent method)
(phantom.fsm.FiniteStateMachineEnv method)
(phantom.PhantomEnv method)
(phantom.stackelberg.StackelbergEnv method)
L
LambdaSampler (class in phantom.utils.samplers)
LinspaceRange (class in phantom.utils.ranges)
log_metrics() (phantom.trainer.Trainer method)
log_rewards() (phantom.trainer.Trainer method)
log_vec_metrics() (phantom.trainer.Trainer method)
log_vec_rewards() (phantom.trainer.Trainer method)
M
Message (class in phantom.message)
Metric (class in phantom.metrics)
N
n_agents (phantom.env_wrappers.SingleAgentEnvAdapter property)
(phantom.fsm.FiniteStateMachineEnv property)
(phantom.PhantomEnv property)
(phantom.stackelberg.StackelbergEnv property)
neighbour_ids (phantom.Context property)
Network (class in phantom.network)
network (phantom.PhantomEnv attribute)
NetworkError (class in phantom.network)
next_stages (phantom.fsm.FSMStage attribute)
non_strategic_agent_ids (phantom.fsm.FiniteStateMachineEnv property)
(phantom.PhantomEnv property)
(phantom.stackelberg.StackelbergEnv property)
non_strategic_agents (phantom.fsm.FiniteStateMachineEnv property)
(phantom.PhantomEnv property)
(phantom.stackelberg.StackelbergEnv property)
NormalArraySampler (class in phantom.utils.samplers)
NormalSampler (class in phantom.utils.samplers)
np_random (phantom.env_wrappers.SingleAgentEnvAdapter property)
(phantom.fsm.FiniteStateMachineEnv property)
(phantom.PhantomEnv property)
(phantom.stackelberg.StackelbergEnv property)
num_steps (phantom.PhantomEnv attribute)
O
observation_space (phantom.encoders.ChainedEncoder property)
(phantom.encoders.Constant property)
(phantom.encoders.EmptyEncoder property)
(phantom.encoders.Encoder property)
(phantom.env_wrappers.SingleAgentEnvAdapter property)
observations (phantom.fsm.FiniteStateMachineEnv.Step attribute)
(phantom.PhantomEnv.Step attribute)
,
[1]
(phantom.stackelberg.StackelbergEnv.Step attribute)
observations_for_agent() (phantom.utils.rollout.Rollout method)
P
PhantomEnv (class in phantom)
PhantomEnv.Step (class in phantom)
policies (phantom.trainer.TrainingResults attribute)
Policy (class in phantom.policy)
post_message_resolution() (phantom.agents.Agent method)
(phantom.agents.StrategicAgent method)
(phantom.fsm.FiniteStateMachineEnv method)
(phantom.PhantomEnv method)
(phantom.stackelberg.StackelbergEnv method)
pre_message_resolution() (phantom.agents.Agent method)
(phantom.agents.StrategicAgent method)
(phantom.fsm.FiniteStateMachineEnv method)
(phantom.PhantomEnv method)
(phantom.stackelberg.StackelbergEnv method)
push() (phantom.resolvers.BatchResolver method)
(phantom.resolvers.Resolver method)
R
Range (class in phantom.utils.ranges)
reduce() (phantom.metrics.AggregatedAgentMetric method)
(phantom.metrics.Metric method)
(phantom.metrics.SimpleAgentMetric method)
(phantom.metrics.SimpleEnvMetric method)
render() (phantom.env_wrappers.SingleAgentEnvAdapter method)
(phantom.fsm.FiniteStateMachineEnv method)
(phantom.PhantomEnv method)
(phantom.stackelberg.StackelbergEnv method)
reset() (phantom.agents.Agent method)
(phantom.agents.StrategicAgent method)
(phantom.decoders.ChainedDecoder method)
(phantom.decoders.Decoder method)
(phantom.decoders.EmptyDecoder method)
(phantom.encoders.ChainedEncoder method)
(phantom.encoders.Constant method)
(phantom.encoders.EmptyEncoder method)
(phantom.encoders.Encoder method)
(phantom.env_wrappers.SingleAgentEnvAdapter method)
(phantom.fsm.FiniteStateMachineEnv method)
(phantom.network.Network method)
(phantom.network.StochasticNetwork method)
(phantom.PhantomEnv method)
(phantom.resolvers.BatchResolver method)
(phantom.resolvers.Resolver method)
(phantom.reward_functions.Constant method)
(phantom.reward_functions.RewardFunction method)
(phantom.stackelberg.StackelbergEnv method)
resolve() (phantom.network.Network method)
(phantom.network.StochasticNetwork method)
(phantom.resolvers.BatchResolver method)
(phantom.resolvers.Resolver method)
Resolver (class in phantom.resolvers)
reward() (phantom.reward_functions.Constant method)
(phantom.reward_functions.RewardFunction method)
rewarded_agents (phantom.fsm.FSMStage attribute)
RewardFunction (class in phantom.reward_functions)
rewards (phantom.fsm.FiniteStateMachineEnv.Step attribute)
(phantom.PhantomEnv.Step attribute)
,
[1]
(phantom.stackelberg.StackelbergEnv.Step attribute)
rewards_for_agent() (phantom.utils.rollout.Rollout method)
Rollout (class in phantom.utils.rollout)
rollout() (in module phantom.utils.rllib)
S
sample() (phantom.utils.samplers.ComparableSampler method)
(phantom.utils.samplers.LambdaSampler method)
(phantom.utils.samplers.NormalArraySampler method)
(phantom.utils.samplers.NormalSampler method)
(phantom.utils.samplers.Sampler method)
(phantom.utils.samplers.UniformArraySampler method)
(phantom.utils.samplers.UniformFloatSampler method)
(phantom.utils.samplers.UniformIntSampler method)
Sampler (class in phantom.utils.samplers)
send() (phantom.network.Network method)
(phantom.network.StochasticNetwork method)
setup_policy_specs_and_mapping() (phantom.trainer.Trainer method)
SimpleAgentMetric (class in phantom.metrics)
SimpleEnvMetric (class in phantom.metrics)
SingleAgentEnvAdapter (class in phantom.env_wrappers)
StackelbergEnv (class in phantom.stackelberg)
StackelbergEnv.Step (class in phantom.stackelberg)
Step (class in phantom.PhantomEnv)
(class in phantom.utils.rollout)
step() (phantom.env_wrappers.SingleAgentEnvAdapter method)
(phantom.fsm.FiniteStateMachineEnv method)
(phantom.PhantomEnv method)
(phantom.stackelberg.StackelbergEnv method)
steps_for_agent() (phantom.utils.rollout.Rollout method)
StochasticNetwork (class in phantom.network)
strategic_agent_ids (phantom.fsm.FiniteStateMachineEnv property)
(phantom.PhantomEnv property)
(phantom.stackelberg.StackelbergEnv property)
strategic_agents (phantom.fsm.FiniteStateMachineEnv property)
(phantom.PhantomEnv property)
(phantom.stackelberg.StackelbergEnv property)
StrategicAgent (class in phantom.agents)
subnet_for() (phantom.network.Network method)
(phantom.network.StochasticNetwork method)
Supertype (class in phantom.supertype)
T
tbx_write_scalar() (phantom.trainer.Trainer method)
tbx_write_values() (phantom.trainer.Trainer method)
TelemetryLogger (class in phantom.telemetry)
terminations (phantom.fsm.FiniteStateMachineEnv.Step attribute)
(phantom.PhantomEnv.Step attribute)
,
[1]
(phantom.stackelberg.StackelbergEnv.Step attribute)
terminations_for_agent() (phantom.utils.rollout.Rollout method)
to_obs_space() (phantom.supertype.Supertype method)
to_obs_space_compatible_type() (phantom.supertype.Supertype method)
tracked_messages (phantom.resolvers.BatchResolver property)
(phantom.resolvers.Resolver property)
train() (in module phantom.utils.rllib)
(phantom.trainer.Trainer method)
Trainer (class in phantom.trainer)
training_step() (phantom.trainer.Trainer method)
TrainingResults (class in phantom.trainer)
truncations (phantom.fsm.FiniteStateMachineEnv.Step attribute)
(phantom.PhantomEnv.Step attribute)
,
[1]
(phantom.stackelberg.StackelbergEnv.Step attribute)
truncations_for_agent() (phantom.utils.rollout.Rollout method)
U
UniformArraySampler (class in phantom.utils.samplers)
UniformFloatSampler (class in phantom.utils.samplers)
UniformIntSampler (class in phantom.utils.samplers)
UniformRange (class in phantom.utils.ranges)
UnitArrayLinspaceRange (class in phantom.utils.ranges)
UnitArrayUniformRange (class in phantom.utils.ranges)
unwrapped (phantom.env_wrappers.SingleAgentEnvAdapter property)
(phantom.fsm.FiniteStateMachineEnv property)
(phantom.PhantomEnv property)
(phantom.stackelberg.StackelbergEnv property)
V
value (phantom.reward_functions.Constant attribute)
values() (phantom.utils.ranges.LinspaceRange method)
(phantom.utils.ranges.Range method)
(phantom.utils.ranges.UniformRange method)
(phantom.utils.ranges.UnitArrayLinspaceRange method)
(phantom.utils.ranges.UnitArrayUniformRange method)
View (class in phantom.views)
view() (phantom.agents.Agent method)
(phantom.agents.StrategicAgent method)
(phantom.fsm.FiniteStateMachineEnv method)
(phantom.PhantomEnv method)
(phantom.stackelberg.StackelbergEnv method)
W
with_traceback() (phantom.fsm.FSMRuntimeError method)
(phantom.fsm.FSMValidationError method)
(phantom.network.NetworkError method)
Read the Docs
v: latest
Versions
latest
develop
Downloads
On Read the Docs
Project Home
Builds