tf_agents.bandits.agents.neural_epsilon_greedy_agent.NeuralEpsilonGreedyAgent

View source on GitHub

A neural network based epsilon greedy agent.

Inherits From: GreedyRewardPredictionAgent

This agent receives a neural network that it trains to predict rewards. The action is chosen greedily with respect to the prediction with probability 1 - epsilon, and uniformly randomly with probability epsilon.

time_step_spec A TimeStep spec of the expected time_steps.
action_spec A nest of BoundedTensorSpec representing the actions.
reward_network A tf_agents.network.Network to be used by the agent. The network will be called with call(observation, step_type) and it is expected to provide a reward prediction for all actions. Note: when using observation_and_action_constraint_splitter, make sure the reward_network is compatible with the network-specific half of the output of the observation_and_action_constraint_splitter. In particular, observation_and_action_constraint_splitter will be called on the observation before passing to the network.
optimizer The optimizer to use for training.
epsilon A float representing the probability of choosing a random action instead of the greedy action.
observation_and_action_constraint_splitter A function used for masking valid/invalid actions with each state of the environment. The function takes in a full observation and returns a tuple consisting of 1) the part of the observation intended as input to the bandit agent and policy, and 2) the boolean mask. This function should also work with a TensorSpec as input, and should output TensorSpec objects for the observation and mask.
error_loss_fn A function for computing the error loss, taking parameters labels, predictions, and weights (any function from tf.losses would work). The default is tf.losses.mean_squared_error.
gradient_clipping A float representing the norm length to clip gradients (or None for no clipping.)
debug_summaries A Python bool, default False. When True, debug summaries are gathered.
summarize_grads_and_vars A Python bool, default False. When True, gradients and network variable summaries are written during training.
enable_summaries A Python bool, default True. When False, all summaries (debug or otherwise) should not be written.
emit_policy_info (tuple of strings) what side information we want to get as part of the policy info. Allowed values can be found in policy_utilities.PolicyInfo.
train_step_counter An optional tf.Variable to increment every time the train op is run. Defaults to the global_step.
laplacian_matrix A float Tensor shaped [num_actions, num_actions]. This holds the Laplacian matrix used to regularize the smoothness of the estimated expected reward function. This only applies to problems where the actions have a graph structure. If None, the regularization is not applied.
laplacian_smoothing_weight A float that determines the weight of the regularization term. Note that this has no effect if laplacian_matrix above is None.
name Python str name of this agent. All variables in this module will fall under that name. Defaults to the class name.

ValueError If the action spec contains more than one action or or it is not a bounded scalar int32 spec with minimum 0.

action_spec TensorSpec describing the action produced by the agent.
collect_data_spec Returns a Trajectory spec, as expected by the collect_policy.
collect_policy Return a policy that can be used to collect data from the environment.
debug_summaries

name Returns the name of this module as passed or determined in the ctor.

name_scope Returns a tf.name_scope instance for this class.
policy Return the current policy held by the agent.
submodules Sequence of all sub-modules.

Submodules are modules which are properties of this module, or found as properties of modules which are properties of this module (and so on).

a = tf.Module()
b = tf.Module()
c = tf.Module()
a.b = b
b.c = c
list(a.submodules) == [b, c]
True
list(b.submodules) == [c]
True
list(c.submodules) == []
True

summaries_enabled

summarize_grads_and_vars

time_step_spec Describes the TimeStep tensors expected by the agent.
train_argspec TensorSpec describing extra supported kwargs to train().
train_sequence_length The number of time steps needed in experience tensors passed to train.

Train requires experience to be a Trajectory containing tensors shaped [B, T, ...]. This argument describes the value of T required.

For example, for non-RNN DQN training, T=2 because DQN requires single transitions.

If this value is None, then train can handle an unknown T (it can be determined at runtime from the data). Most RNN-based agents fall into this category.

train_step_counter

trainable_variables Sequence of trainable variables owned by this module and its submodules.

variables Sequence of variables owned by this module and its submodules.

Methods

compute_summaries

View source

initialize

View source

Initializes the agent.

Returns
An operation that can be used to initialize the agent.

Raises
RuntimeError If the class was not initialized properly (super.__init__ was not called).

loss

View source

Computes loss for reward prediction training.

Args
observations A batch of observations.
actions A batch of actions.
rewards A batch of rewards.
weights Optional scalar or elementwise (per-batch-entry) importance weights. The output batch loss will be scaled by these weights, and the final scalar loss is the mean of these values.
training Whether the loss is being used for training.

Returns
loss A LossInfo containing the loss for the training step.

Raises
ValueError if the number of actions is greater than 1.

train

View source

Trains the agent.

Args
experience A batch of experience data in the form of a Trajectory. The structure of experience must match that of self.collect_data_spec. All tensors in experience must be shaped [batch, time, ...] where time must be equal to self.train_step_length if that property is not None.
weights (optional). A Tensor, either 0-D or shaped [batch], containing weights to be used when calculating the total train loss. Weights are typically multiplied elementwise against the per-batch loss, but the implementation is up to the Agent.
**kwargs Any additional data as declared by self.train_argspec.

Returns
A LossInfo loss tuple containing loss and info tensors.

  • In eager mode, the loss values are first calculated, then a train step is performed before they are returned.
  • In graph mode, executing any or all of the loss tensors will first calculate the loss value(s), then perform a train step, and return the pre-train-step LossInfo.

Raises
TypeError If experience is not type Trajectory. Or if experience does not match self.collect_data_spec structure types.
ValueError If experience tensors' time axes are not compatible with self.train_sequence_length. Or if experience does not match self.collect_data_spec structure.
ValueError If the user does not pass **kwargs matching self.train_argspec.
RuntimeError If the class was not initialized properly (super.__init__ was not called).

with_name_scope

Decorator to automatically enter the module name scope.

class MyModule(tf.Module):
  @tf.Module.with_name_scope
  def __call__(self, x):
    if not hasattr(self, 'w'):
      self.w = tf.Variable(tf.random.normal([x.shape[1], 3]))
    return tf.matmul(x, self.w)

Using the above module would produce tf.Variables and tf.Tensors whose names included the module name:

mod = MyModule()
mod(tf.ones([1, 2]))
<tf.Tensor: shape=(1, 3), dtype=float32, numpy=..., dtype=float32)>
mod.w
<tf.Variable 'my_module/Variable:0' shape=(2, 3) dtype=float32,
numpy=..., dtype=float32)>

Args
method The method to wrap.

Returns
The original method wrapped such that it enters the module's name scope.