|
1 | | -# Table of Contents |
2 | | - |
3 | | -* [mlagents\_envs.base\_env](#mlagents_envs.base_env) |
4 | | - * [DecisionStep](#mlagents_envs.base_env.DecisionStep) |
5 | | - * [DecisionSteps](#mlagents_envs.base_env.DecisionSteps) |
6 | | - * [agent\_id\_to\_index](#mlagents_envs.base_env.DecisionSteps.agent_id_to_index) |
7 | | - * [\_\_getitem\_\_](#mlagents_envs.base_env.DecisionSteps.__getitem__) |
8 | | - * [empty](#mlagents_envs.base_env.DecisionSteps.empty) |
9 | | - * [TerminalStep](#mlagents_envs.base_env.TerminalStep) |
10 | | - * [TerminalSteps](#mlagents_envs.base_env.TerminalSteps) |
11 | | - * [agent\_id\_to\_index](#mlagents_envs.base_env.TerminalSteps.agent_id_to_index) |
12 | | - * [\_\_getitem\_\_](#mlagents_envs.base_env.TerminalSteps.__getitem__) |
13 | | - * [empty](#mlagents_envs.base_env.TerminalSteps.empty) |
14 | | - * [ActionTuple](#mlagents_envs.base_env.ActionTuple) |
15 | | - * [discrete\_dtype](#mlagents_envs.base_env.ActionTuple.discrete_dtype) |
16 | | - * [ActionSpec](#mlagents_envs.base_env.ActionSpec) |
17 | | - * [is\_discrete](#mlagents_envs.base_env.ActionSpec.is_discrete) |
18 | | - * [is\_continuous](#mlagents_envs.base_env.ActionSpec.is_continuous) |
19 | | - * [discrete\_size](#mlagents_envs.base_env.ActionSpec.discrete_size) |
20 | | - * [empty\_action](#mlagents_envs.base_env.ActionSpec.empty_action) |
21 | | - * [random\_action](#mlagents_envs.base_env.ActionSpec.random_action) |
22 | | - * [create\_continuous](#mlagents_envs.base_env.ActionSpec.create_continuous) |
23 | | - * [create\_discrete](#mlagents_envs.base_env.ActionSpec.create_discrete) |
24 | | - * [create\_hybrid](#mlagents_envs.base_env.ActionSpec.create_hybrid) |
25 | | - * [DimensionProperty](#mlagents_envs.base_env.DimensionProperty) |
26 | | - * [UNSPECIFIED](#mlagents_envs.base_env.DimensionProperty.UNSPECIFIED) |
27 | | - * [NONE](#mlagents_envs.base_env.DimensionProperty.NONE) |
28 | | - * [TRANSLATIONAL\_EQUIVARIANCE](#mlagents_envs.base_env.DimensionProperty.TRANSLATIONAL_EQUIVARIANCE) |
29 | | - * [VARIABLE\_SIZE](#mlagents_envs.base_env.DimensionProperty.VARIABLE_SIZE) |
30 | | - * [ObservationType](#mlagents_envs.base_env.ObservationType) |
31 | | - * [DEFAULT](#mlagents_envs.base_env.ObservationType.DEFAULT) |
32 | | - * [GOAL\_SIGNAL](#mlagents_envs.base_env.ObservationType.GOAL_SIGNAL) |
33 | | - * [ObservationSpec](#mlagents_envs.base_env.ObservationSpec) |
34 | | - * [BehaviorSpec](#mlagents_envs.base_env.BehaviorSpec) |
35 | | - * [BaseEnv](#mlagents_envs.base_env.BaseEnv) |
36 | | - * [step](#mlagents_envs.base_env.BaseEnv.step) |
37 | | - * [reset](#mlagents_envs.base_env.BaseEnv.reset) |
38 | | - * [close](#mlagents_envs.base_env.BaseEnv.close) |
39 | | - * [behavior\_specs](#mlagents_envs.base_env.BaseEnv.behavior_specs) |
40 | | - * [set\_actions](#mlagents_envs.base_env.BaseEnv.set_actions) |
41 | | - * [set\_action\_for\_agent](#mlagents_envs.base_env.BaseEnv.set_action_for_agent) |
42 | | - * [get\_steps](#mlagents_envs.base_env.BaseEnv.get_steps) |
43 | | -* [mlagents\_envs.environment](#mlagents_envs.environment) |
44 | | - * [UnityEnvironment](#mlagents_envs.environment.UnityEnvironment) |
45 | | - * [\_\_init\_\_](#mlagents_envs.environment.UnityEnvironment.__init__) |
46 | | - * [close](#mlagents_envs.environment.UnityEnvironment.close) |
47 | | -* [mlagents\_envs.registry](#mlagents_envs.registry) |
48 | | -* [mlagents\_envs.registry.unity\_env\_registry](#mlagents_envs.registry.unity_env_registry) |
49 | | - * [UnityEnvRegistry](#mlagents_envs.registry.unity_env_registry.UnityEnvRegistry) |
50 | | - * [register](#mlagents_envs.registry.unity_env_registry.UnityEnvRegistry.register) |
51 | | - * [register\_from\_yaml](#mlagents_envs.registry.unity_env_registry.UnityEnvRegistry.register_from_yaml) |
52 | | - * [clear](#mlagents_envs.registry.unity_env_registry.UnityEnvRegistry.clear) |
53 | | - * [\_\_getitem\_\_](#mlagents_envs.registry.unity_env_registry.UnityEnvRegistry.__getitem__) |
54 | | -* [mlagents\_envs.side\_channel](#mlagents_envs.side_channel) |
55 | | -* [mlagents\_envs.side\_channel.raw\_bytes\_channel](#mlagents_envs.side_channel.raw_bytes_channel) |
56 | | - * [RawBytesChannel](#mlagents_envs.side_channel.raw_bytes_channel.RawBytesChannel) |
57 | | - * [on\_message\_received](#mlagents_envs.side_channel.raw_bytes_channel.RawBytesChannel.on_message_received) |
58 | | - * [get\_and\_clear\_received\_messages](#mlagents_envs.side_channel.raw_bytes_channel.RawBytesChannel.get_and_clear_received_messages) |
59 | | - * [send\_raw\_data](#mlagents_envs.side_channel.raw_bytes_channel.RawBytesChannel.send_raw_data) |
60 | | -* [mlagents\_envs.side\_channel.outgoing\_message](#mlagents_envs.side_channel.outgoing_message) |
61 | | - * [OutgoingMessage](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage) |
62 | | - * [\_\_init\_\_](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage.__init__) |
63 | | - * [write\_bool](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage.write_bool) |
64 | | - * [write\_int32](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage.write_int32) |
65 | | - * [write\_float32](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage.write_float32) |
66 | | - * [write\_float32\_list](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage.write_float32_list) |
67 | | - * [write\_string](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage.write_string) |
68 | | - * [set\_raw\_bytes](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage.set_raw_bytes) |
69 | | -* [mlagents\_envs.side\_channel.engine\_configuration\_channel](#mlagents_envs.side_channel.engine_configuration_channel) |
70 | | - * [EngineConfigurationChannel](#mlagents_envs.side_channel.engine_configuration_channel.EngineConfigurationChannel) |
71 | | - * [on\_message\_received](#mlagents_envs.side_channel.engine_configuration_channel.EngineConfigurationChannel.on_message_received) |
72 | | - * [set\_configuration\_parameters](#mlagents_envs.side_channel.engine_configuration_channel.EngineConfigurationChannel.set_configuration_parameters) |
73 | | - * [set\_configuration](#mlagents_envs.side_channel.engine_configuration_channel.EngineConfigurationChannel.set_configuration) |
74 | | -* [mlagents\_envs.side\_channel.side\_channel\_manager](#mlagents_envs.side_channel.side_channel_manager) |
75 | | - * [SideChannelManager](#mlagents_envs.side_channel.side_channel_manager.SideChannelManager) |
76 | | - * [process\_side\_channel\_message](#mlagents_envs.side_channel.side_channel_manager.SideChannelManager.process_side_channel_message) |
77 | | - * [generate\_side\_channel\_messages](#mlagents_envs.side_channel.side_channel_manager.SideChannelManager.generate_side_channel_messages) |
78 | | -* [mlagents\_envs.side\_channel.stats\_side\_channel](#mlagents_envs.side_channel.stats_side_channel) |
79 | | - * [StatsSideChannel](#mlagents_envs.side_channel.stats_side_channel.StatsSideChannel) |
80 | | - * [on\_message\_received](#mlagents_envs.side_channel.stats_side_channel.StatsSideChannel.on_message_received) |
81 | | - * [get\_and\_reset\_stats](#mlagents_envs.side_channel.stats_side_channel.StatsSideChannel.get_and_reset_stats) |
82 | | -* [mlagents\_envs.side\_channel.incoming\_message](#mlagents_envs.side_channel.incoming_message) |
83 | | - * [IncomingMessage](#mlagents_envs.side_channel.incoming_message.IncomingMessage) |
84 | | - * [\_\_init\_\_](#mlagents_envs.side_channel.incoming_message.IncomingMessage.__init__) |
85 | | - * [read\_bool](#mlagents_envs.side_channel.incoming_message.IncomingMessage.read_bool) |
86 | | - * [read\_int32](#mlagents_envs.side_channel.incoming_message.IncomingMessage.read_int32) |
87 | | - * [read\_float32](#mlagents_envs.side_channel.incoming_message.IncomingMessage.read_float32) |
88 | | - * [read\_float32\_list](#mlagents_envs.side_channel.incoming_message.IncomingMessage.read_float32_list) |
89 | | - * [read\_string](#mlagents_envs.side_channel.incoming_message.IncomingMessage.read_string) |
90 | | - * [get\_raw\_bytes](#mlagents_envs.side_channel.incoming_message.IncomingMessage.get_raw_bytes) |
91 | | -* [mlagents\_envs.side\_channel.float\_properties\_channel](#mlagents_envs.side_channel.float_properties_channel) |
92 | | - * [FloatPropertiesChannel](#mlagents_envs.side_channel.float_properties_channel.FloatPropertiesChannel) |
93 | | - * [on\_message\_received](#mlagents_envs.side_channel.float_properties_channel.FloatPropertiesChannel.on_message_received) |
94 | | - * [set\_property](#mlagents_envs.side_channel.float_properties_channel.FloatPropertiesChannel.set_property) |
95 | | - * [get\_property](#mlagents_envs.side_channel.float_properties_channel.FloatPropertiesChannel.get_property) |
96 | | - * [list\_properties](#mlagents_envs.side_channel.float_properties_channel.FloatPropertiesChannel.list_properties) |
97 | | - * [get\_property\_dict\_copy](#mlagents_envs.side_channel.float_properties_channel.FloatPropertiesChannel.get_property_dict_copy) |
98 | | -* [mlagents\_envs.side\_channel.environment\_parameters\_channel](#mlagents_envs.side_channel.environment_parameters_channel) |
99 | | - * [EnvironmentParametersChannel](#mlagents_envs.side_channel.environment_parameters_channel.EnvironmentParametersChannel) |
100 | | - * [set\_float\_parameter](#mlagents_envs.side_channel.environment_parameters_channel.EnvironmentParametersChannel.set_float_parameter) |
101 | | - * [set\_uniform\_sampler\_parameters](#mlagents_envs.side_channel.environment_parameters_channel.EnvironmentParametersChannel.set_uniform_sampler_parameters) |
102 | | - * [set\_gaussian\_sampler\_parameters](#mlagents_envs.side_channel.environment_parameters_channel.EnvironmentParametersChannel.set_gaussian_sampler_parameters) |
103 | | - * [set\_multirangeuniform\_sampler\_parameters](#mlagents_envs.side_channel.environment_parameters_channel.EnvironmentParametersChannel.set_multirangeuniform_sampler_parameters) |
104 | | -* [mlagents\_envs.side\_channel.side\_channel](#mlagents_envs.side_channel.side_channel) |
105 | | - * [SideChannel](#mlagents_envs.side_channel.side_channel.SideChannel) |
106 | | - * [queue\_message\_to\_send](#mlagents_envs.side_channel.side_channel.SideChannel.queue_message_to_send) |
107 | | - * [on\_message\_received](#mlagents_envs.side_channel.side_channel.SideChannel.on_message_received) |
108 | | - * [channel\_id](#mlagents_envs.side_channel.side_channel.SideChannel.channel_id) |
| 1 | +# Python Low-Level API Documentation |
109 | 2 |
|
110 | 3 | <a name="mlagents_envs.base_env"></a> |
111 | 4 | # mlagents\_envs.base\_env |
|
0 commit comments