stable_learning_control.algos.tf2.policies.lyapunov_actor_critic
Lyapunov (soft) actor critic policy.
This module contains a TensorFlow 2.x implementation of the Lyapunov Actor Critic policy of Han et al. 2020.
Attributes
Classes
Lyapunov (soft) Actor-Critic network. |
Module Contents
- class stable_learning_control.algos.tf2.policies.lyapunov_actor_critic.LyapunovActorCritic(observation_space, action_space, hidden_sizes=HIDDEN_SIZES_DEFAULT, activation=ACTIVATION_DEFAULT, output_activation=OUTPUT_ACTIVATION_DEFAULT, name='lyapunov_actor_critic')[source]
Bases:
tf.keras.Model
Lyapunov (soft) Actor-Critic network.
- self.pi
The squashed gaussian policy network (actor).
- Type:
Initialise the LyapunovActorCritic object.
- Parameters:
observation_space (
gym.space.box.Box
) – A gymnasium observation space.action_space (
gym.space.box.Box
) – A gymnasium action space.hidden_sizes (Union[dict, tuple, list], optional) – Sizes of the hidden layers for the actor. Defaults to
(256, 256)
.activation (Union[
dict
,tf.keras.activations
], optional) – The (actor and critic) hidden layers activation function. Defaults totf.nn.relu
.output_activation (Union[
dict
,tf.keras.activations
], optional) – The actor output activation function. Defaults totf.nn.relu
.name (str, optional) – The name given to the LyapunovActorCritic. Defaults to “lyapunov_actor_critic”.
Note
It is currently not possible to set the critic output activation function when using the LyapunovActorCritic. This is since it by design requires the critic output activation to by of type
tf.math.square()
.- call(inputs, deterministic=False, with_logprob=True)[source]
Performs a forward pass through all the networks (Actor and L critic).
- Parameters:
inputs (tuple) –
tuple containing:
obs (tf.Tensor): The tensor of observations.
act (tf.Tensor): The tensor of actions.
deterministic (bool, optional) – Whether we want to use a deterministic policy (used at test time). When true the mean action of the stochastic policy is returned. If false the action is sampled from the stochastic policy. Defaults to
False
.with_logprob (bool, optional) – Whether we want to return the log probability of an action. Defaults to
True
.
- Returns:
tuple containing:
- Return type:
(tuple)
Note
Useful for when you want to print out the full network graph using TensorBoard.
- act(obs, deterministic=False)[source]
Returns the action from the current state given the current policy.
- Parameters:
obs (numpy.ndarray) – The current observation (state).
deterministic (bool, optional) – Whether we want to use a deterministic policy (used at test time). When true the mean action of the stochastic policy is returned. If
False
the action is sampled from the stochastic policy. Defaults toFalse
.
- Returns:
The action from the current state given the current policy.
- Return type: