Code
stringlengths
103
85.9k
Summary
sequencelengths
0
94
Please provide a description of the function:def convert_predictions_to_image_summaries(hook_args): decode_hparams = hook_args.decode_hparams if not decode_hparams.display_decoded_images: return [] predictions = hook_args.predictions[0] # Display ten random inputs and outputs so that tensorboard does not hang. all_summaries = [] rand_predictions = np.random.choice(predictions, size=10) for ind, prediction in enumerate(rand_predictions): output_summary = image_to_tf_summary_value( prediction["outputs"], tag="%d_output" % ind) input_summary = image_to_tf_summary_value( prediction["inputs"], tag="%d_input" % ind) all_summaries.append(input_summary) all_summaries.append(output_summary) return all_summaries
[ "Optionally converts images from hooks_args to image summaries.\n\n Args:\n hook_args: DecodeHookArgs namedtuple\n Returns:\n summaries: list of tf.Summary values if hook_args.decode_hpara\n " ]
Please provide a description of the function:def resize_by_area(img, size): return tf.to_int64( tf.image.resize_images(img, [size, size], tf.image.ResizeMethod.AREA))
[ "image resize function used by quite a few image problems." ]
Please provide a description of the function:def make_multiscale(image, resolutions, resize_method=tf.image.ResizeMethod.BICUBIC, num_channels=3): scaled_images = [] for height in resolutions: scaled_image = tf.image.resize_images( image, size=[height, height], # assuming that height = width method=resize_method) scaled_image = tf.to_int64(scaled_image) scaled_image.set_shape([height, height, num_channels]) scaled_images.append(scaled_image) return scaled_images
[ "Returns list of scaled images, one for each resolution.\n\n Args:\n image: Tensor of shape [height, height, num_channels].\n resolutions: List of heights that image's height is resized to.\n resize_method: tf.image.ResizeMethod.\n num_channels: Number of channels in image.\n\n Returns:\n List of Tensors, one for each resolution with shape given by\n [resolutions[i], resolutions[i], num_channels].\n " ]
Please provide a description of the function:def make_multiscale_dilated(image, resolutions, num_channels=3): image_height = common_layers.shape_list(image)[0] scaled_images = [] for height in resolutions: dilation_rate = image_height // height # assuming height = width scaled_image = image[::dilation_rate, ::dilation_rate] scaled_image = tf.to_int64(scaled_image) scaled_image.set_shape([None, None, num_channels]) scaled_images.append(scaled_image) return scaled_images
[ "Returns list of scaled images, one for each resolution.\n\n Resizes by skipping every nth pixel.\n\n Args:\n image: Tensor of shape [height, height, num_channels].\n resolutions: List of heights that image's height is resized to. The function\n assumes VALID padding, so the original image's height must be divisible\n by each resolution's height to return the exact resolution size.\n num_channels: Number of channels in image.\n\n Returns:\n List of Tensors, one for each resolution with shape given by\n [resolutions[i], resolutions[i], num_channels] if resolutions properly\n divide the original image's height; otherwise shape height and width is up\n to valid skips.\n " ]
Please provide a description of the function:def encode_images_as_png(images): if tf.executing_eagerly(): for image in images: yield tf.image.encode_png(image).numpy() else: (height, width, channels) = images[0].shape with tf.Graph().as_default(): image_t = tf.placeholder(dtype=tf.uint8, shape=(height, width, channels)) encoded_image_t = tf.image.encode_png(image_t) with tf.Session() as sess: for image in images: enc_string = sess.run(encoded_image_t, feed_dict={image_t: image}) yield enc_string
[ "Yield images encoded as pngs." ]
Please provide a description of the function:def image_generator(images, labels): if not images: raise ValueError("Must provide some images for the generator.") width, height, _ = images[0].shape for (enc_image, label) in zip(encode_images_as_png(images), labels): yield { "image/encoded": [enc_image], "image/format": ["png"], "image/class/label": [int(label)], "image/height": [height], "image/width": [width] }
[ "Generator for images that takes image and labels lists and creates pngs.\n\n Args:\n images: list of images given as [width x height x channels] numpy arrays.\n labels: list of ints, same length as images.\n\n Yields:\n A dictionary representing the images with the following fields:\n * image/encoded: the string encoding the image as PNG,\n * image/format: the string \"png\" representing image format,\n * image/class/label: an integer representing the label,\n * image/height: an integer representing the height,\n * image/width: an integer representing the width.\n Every field is actually a singleton list of the corresponding type.\n\n Raises:\n ValueError: if images is an empty list.\n " ]
Please provide a description of the function:def image_augmentation(images, do_colors=False, crop_size=None): if crop_size is None: crop_size = [299, 299] images = tf.random_crop(images, crop_size + [3]) images = tf.image.random_flip_left_right(images) if do_colors: # More augmentation, but might be slow. images = tf.image.random_brightness(images, max_delta=32. / 255.) images = tf.image.random_saturation(images, lower=0.5, upper=1.5) images = tf.image.random_hue(images, max_delta=0.2) images = tf.image.random_contrast(images, lower=0.5, upper=1.5) return images
[ "Image augmentation: cropping, flipping, and color transforms." ]
Please provide a description of the function:def cifar_image_augmentation(images): images = tf.image.resize_image_with_crop_or_pad(images, 40, 40) images = tf.random_crop(images, [32, 32, 3]) images = tf.image.random_flip_left_right(images) return images
[ "Image augmentation suitable for CIFAR-10/100.\n\n As described in https://arxiv.org/pdf/1608.06993v3.pdf (page 5).\n\n Args:\n images: a Tensor.\n Returns:\n Tensor of the same shape as images.\n " ]
Please provide a description of the function:def random_shift(image, wsr=0.1, hsr=0.1): height, width, _ = common_layers.shape_list(image) width_range, height_range = wsr*width, hsr*height height_translations = tf.random_uniform((1,), -height_range, height_range) width_translations = tf.random_uniform((1,), -width_range, width_range) translations = tf.concat((height_translations, width_translations), axis=0) return tf.contrib.image.translate(image, translations=translations)
[ "Apply random horizontal and vertical shift to images.\n\n This is the default data-augmentation strategy used on CIFAR in Glow.\n\n Args:\n image: a 3-D Tensor\n wsr: Width shift range, as a float fraction of the width.\n hsr: Height shift range, as a float fraction of the width.\n Returns:\n images: images translated by the provided wsr and hsr.\n " ]
Please provide a description of the function:def get_standardized_layers(hparams, dp=None): def partial(fct, *args, **kwargs): return functools.wraps(fct)(functools.partial(fct, *args, **kwargs)) def register_layer( fct_in, default_args=None, default_kwargs=None, use_dp=True, recompute_grad=False, ): # The kwargs given when calling the function overwrite the default ones fct_in = partial(fct_in, *(default_args or []), **(default_kwargs or {})) @functools.wraps(fct_in) def decorator(x, *args, **kwargs): fct = fct_in # For closure. Could use nonlocal with Python 3 # Eventually create the memory optimized version of the function if recompute_grad: fct = partial(fct, **kwargs) # recompute_grad only accept args fct = common_layers.recompute_grad(fct) kwargs = {} # Eventually use dp (if given and not MoE) if use_dp and dp is not None: y = dp(fct, x, *args, **kwargs) else: y = fct(x, *args, **kwargs) # Eventually capture the extra loss extra_loss = 0.0 if isinstance(y, tuple): y, extra_loss = y return y, extra_loss return decorator total_key_depth = hparams.attention_key_channels or hparams.hidden_size total_value_depth = hparams.attention_value_channels or hparams.hidden_size # Attention layers: # === Multi-head full attention layer === multihead_attention_fn = register_layer( multihead_attention, default_kwargs=dict( memory_antecedent=None, # Self-attention by default bias=None, total_key_depth=total_key_depth, total_value_depth=total_value_depth, output_depth=hparams.hidden_size, num_heads=hparams.num_heads, dropout_rate=hparams.attention_dropout, )) # === Memory efficient full-attention layer === # Save memory by not storing the activations and # recomputing them during the backward pass memeff_attention_base_fn = register_layer( multihead_attention, default_kwargs=dict( total_key_depth=total_key_depth, total_value_depth=total_value_depth, output_depth=hparams.hidden_size, num_heads=hparams.num_heads, dropout_rate=hparams.attention_dropout, ), recompute_grad=True, ) def memeff_attention_fn(*args, **kwargs): kwargs = kwargs.copy() assert len(args) == 1 x = args[0] memory_antecedent = kwargs.pop("memory_antecedent", x) # Same as x if None if kwargs.get("bias", None) is not None: # Case where bias has been set args = (x, memory_antecedent, kwargs.pop("bias")) else: # Otherwise, only 2 args. This is necessary as recompute_grad does not # support None values. args = (x, memory_antecedent) return memeff_attention_base_fn(*args, **kwargs) # === Local attention (unmasked) layer === # Reuse same parameters as multihead_attention # Don't mask the future local_attention_fn = partial( multihead_attention_fn, block_length=hparams.attention_loc_block_length, block_width=hparams.attention_loc_block_width, attention_type="local_unmasked", ) # === Local attention (masked) layer === # Reuse same parameters as multihead_attention # Only works for self attention. Always mask the future. local_attention_masked_fn = partial( multihead_attention_fn, block_length=hparams.attention_loc_block_length, attention_type="local_mask_right", ) # === Masked memory-compressed multihead self attention layer === # Only works for self attention. Always mask the future. compressed_attention_masked_fn = register_layer( multihead_self_attention_reduced, default_kwargs=dict( factor=hparams.attention_red_factor, nonlinearity=hparams.attention_red_nonlinearity, reduction_type=hparams.attention_red_type, multihead_params=dict( total_key_depth=total_key_depth, total_value_depth=total_value_depth, num_heads=hparams.num_heads, dropout_rate=hparams.attention_dropout, ), ), ) # === Unmasked memory-compressed multihead self attention layer === # Only works for self attention. Never mask the future. Bias never added compressed_attention_fn = partial( compressed_attention_masked_fn, add_mask=False, ) # Feed-forwards layers: # === FC layer === conv_hidden_relu = register_layer( common_layers.conv_hidden_relu, default_kwargs=dict( hidden_size=hparams.filter_size, output_size=hparams.hidden_size, dropout=hparams.relu_dropout, ), ) # === Separable convolution layer === # No mask applied sep_conv_relu = partial( conv_hidden_relu, padding="SAME", # Parameters copied from the transformer model, could add hparams kernel_size=(3, 1), second_kernel_size=(31, 1), ) # === Separable convolution layer (masked version) === # Mask the future sep_conv_relu_masked = partial( sep_conv_relu, padding="LEFT", # Mask future for decoder ) # Define all available layers cur_layers = dict( # Attention layers: a=multihead_attention_fn, # Multihead full attention loc=local_attention_fn, # Local attention locm=local_attention_masked_fn, # Local attention (masked) red=compressed_attention_fn, # Memory-compressed attention redm=compressed_attention_masked_fn, # Memory-compressed att (masked) mem=memeff_attention_fn, # Memory efficient # Feed-forward layers: fc=conv_hidden_relu, # Fully connected sep=sep_conv_relu, # Separable convolution (unmasked) sepm=sep_conv_relu_masked, # Separable convolution (masked) ) return cur_layers
[ "Get the common attention and feed-forward layers.\n\n The returned layer functions will have the following signature:\n\n y, extra_loss = fct(x)\n\n extra_loss is set to 0.0 if the layer doesn't have extra loss.\n If dp is provided, the layers will be distributed within the devices.\n If moe wants to be used, both dp and model need to be set.\n\n Args:\n hparams (tf.HParams): the model hparameters\n dp (expert_utils.Parallelism): A data parallelism object. If not given,\n the dp calls are simply ignored.\n\n Returns:\n dict[str:fct]: A dictionary containing the standardized functions\n ", "Same as functools.partial but with functools.wraps.", "Turn a function into its standardized version.\n\n Args:\n fct_in (fct): The function to register\n default_args (list): The default parameters to add to the function.\n default_kwargs (dict): The default parameters to add to the function.\n Those arguments can be overwritten when calling the function.\n use_dp (bool): Wrap the function call within a dataparallelism object if\n dp is available. Some layers (like MOE) must be called without dp.\n recompute_grad (bool): If True, recompute the function during the\n backward pass to save memory\n\n Returns:\n fct: the standardized layer function.\n ", "Call the layer function.", "Modify args/kwargs for compatibility with recompute_grad." ]
Please provide a description of the function:def add_standard_attention_hparams(hparams): # All hyperparameters ending in "dropout" are automatically set to 0.0 # when not in training mode. # hparams used and which should have been defined outside (in # common_hparams): # Global flags # hparams.mode # hparams.hidden_size # Pre-post processing flags # hparams.layer_preprocess_sequence # hparams.layer_postprocess_sequence # hparams.layer_prepostprocess_dropout # hparams.norm_type # hparams.norm_epsilon # Mixture-of-Expert flags # hparams.moe_hidden_sizes # hparams.moe_num_experts # hparams.moe_k # hparams.moe_loss_coef # Attention layers flags hparams.add_hparam("num_heads", 8) hparams.add_hparam("attention_key_channels", 0) hparams.add_hparam("attention_value_channels", 0) hparams.add_hparam("attention_dropout", 0.0) # Attention: Local hparams.add_hparam("attention_loc_block_length", 256) # Attention: Local (unmasked only): How much to look left. hparams.add_hparam("attention_loc_block_width", 128) # Attention: Memory-compressed hparams.add_hparam("attention_red_factor", 3) hparams.add_hparam("attention_red_type", "conv") hparams.add_hparam("attention_red_nonlinearity", "none") # Fully connected layers flags # To be more consistent, should use filter_size to also control the MOE # size if moe_hidden_sizes not set. hparams.add_hparam("filter_size", 2048) hparams.add_hparam("relu_dropout", 0.0) return hparams
[ "Adds the hparams used by get_standardized_layers." ]
Please provide a description of the function:def encoder_decoder_attention_loss(expected_attention_logits, actual_attentions, loss_type="kl_divergence", loss_multiplier=1.0): def combine_attentions(attention_list): # Stack all hidden layer attention tensors to get a tensor with shape # [num_hidden_layers, batch_size, num_heads, target_length, input_length]. attentions = tf.stack(attention_list) # Reduce mean across all layers (axis=0) and all heads (axis=2) to get a # tensor with shape [batch_size, target_length, input_length]. return tf.reduce_mean(attentions, [0, 2]) def kl_divergence_loss(expected_logits, actual_logits): p = tfp.distributions.Categorical(logits=expected_logits) q = tfp.distributions.Categorical(logits=actual_logits) return tfp.distributions.kl_divergence(p, q) def mse_loss(expected_logits, actual_weights): expected_weights = tf.nn.softmax(expected_logits) return tf.losses.mean_squared_error(expected_weights, actual_weights) # For each hidden layer, we have attention-logit and attention-weight tensors # with shape [batch_size, num_heads, target_length, input_length]. loss = 0.0 if loss_type == "mse": actual_encdec_attention_weights = [ t for layer_key, t in actual_attentions.items() if "encdec_attention" in layer_key and not layer_key.endswith("/logits") ] actual_attention_weights = combine_attentions( actual_encdec_attention_weights) loss = mse_loss(expected_attention_logits, actual_attention_weights) else: actual_encdec_attention_logits = [ t for layer_key, t in actual_attentions.items() if "encdec_attention" in layer_key and layer_key.endswith("/logits") ] actual_attention_logits = combine_attentions(actual_encdec_attention_logits) loss = kl_divergence_loss(expected_attention_logits, actual_attention_logits) return loss * loss_multiplier
[ "Computes encdec attention loss between expected and actual attentions.\n\n Args:\n expected_attention_logits: Tensor storing the expected encoder-decoder\n attention logits with shape [batch_size, target_length, input_length].\n actual_attentions: Dictionary with actual attention logits for different\n attention types and hidden layers.\n loss_type: type of the loss function.\n loss_multiplier: multiplier for the attention loss.\n\n Returns:\n KL_divergence loss between the actual and expected attention logits.\n ", "Combine different layer attentions and then average over layers/heads." ]
Please provide a description of the function:def get_timing_signal_1d(length, channels, min_timescale=1.0, max_timescale=1.0e4, start_index=0): position = tf.to_float(tf.range(length) + start_index) num_timescales = channels // 2 log_timescale_increment = ( math.log(float(max_timescale) / float(min_timescale)) / tf.maximum(tf.to_float(num_timescales) - 1, 1)) inv_timescales = min_timescale * tf.exp( tf.to_float(tf.range(num_timescales)) * -log_timescale_increment) scaled_time = tf.expand_dims(position, 1) * tf.expand_dims(inv_timescales, 0) signal = tf.concat([tf.sin(scaled_time), tf.cos(scaled_time)], axis=1) signal = tf.pad(signal, [[0, 0], [0, tf.mod(channels, 2)]]) signal = tf.reshape(signal, [1, length, channels]) return signal
[ "Gets a bunch of sinusoids of different frequencies.\n\n Each channel of the input Tensor is incremented by a sinusoid of a different\n frequency and phase.\n\n This allows attention to learn to use absolute and relative positions.\n Timing signals should be added to some precursors of both the query and the\n memory inputs to attention.\n\n The use of relative position is possible because sin(x+y) and cos(x+y) can be\n expressed in terms of y, sin(x) and cos(x).\n\n In particular, we use a geometric sequence of timescales starting with\n min_timescale and ending with max_timescale. The number of different\n timescales is equal to channels / 2. For each timescale, we\n generate the two sinusoidal signals sin(timestep/timescale) and\n cos(timestep/timescale). All of these sinusoids are concatenated in\n the channels dimension.\n\n Args:\n length: scalar, length of timing signal sequence.\n channels: scalar, size of timing embeddings to create. The number of\n different timescales is equal to channels / 2.\n min_timescale: a float\n max_timescale: a float\n start_index: index of first position\n\n Returns:\n a Tensor of timing signals [1, length, channels]\n " ]
Please provide a description of the function:def add_timing_signal_1d(x, min_timescale=1.0, max_timescale=1.0e4, start_index=0): length = common_layers.shape_list(x)[1] channels = common_layers.shape_list(x)[2] signal = get_timing_signal_1d(length, channels, min_timescale, max_timescale, start_index) return x + common_layers.cast_like(signal, x)
[ "Adds a bunch of sinusoids of different frequencies to a Tensor.\n\n Each channel of the input Tensor is incremented by a sinusoid of a different\n frequency and phase.\n\n This allows attention to learn to use absolute and relative positions.\n Timing signals should be added to some precursors of both the query and the\n memory inputs to attention.\n\n The use of relative position is possible because sin(x+y) and cos(x+y) can be\n expressed in terms of y, sin(x) and cos(x).\n\n In particular, we use a geometric sequence of timescales starting with\n min_timescale and ending with max_timescale. The number of different\n timescales is equal to channels / 2. For each timescale, we\n generate the two sinusoidal signals sin(timestep/timescale) and\n cos(timestep/timescale). All of these sinusoids are concatenated in\n the channels dimension.\n\n Args:\n x: a Tensor with shape [batch, length, channels]\n min_timescale: a float\n max_timescale: a float\n start_index: index of first position\n\n Returns:\n a Tensor the same shape as x.\n " ]
Please provide a description of the function:def get_layer_timing_signal_learned_1d(channels, layer, num_layers): shape = [num_layers, 1, 1, channels] layer_embedding = ( tf.get_variable( "layer_embedding", shape, initializer=tf.random_normal_initializer(0, channels**-0.5)) * (channels**0.5)) return layer_embedding[layer, :, :, :]
[ "get n-dimensional embedding as the layer (vertical) timing signal.\n\n Adds embeddings to represent the position of the layer in the tower.\n\n Args:\n channels: dimension of the timing signal\n layer: layer num\n num_layers: total number of layers\n\n Returns:\n a Tensor of timing signals [1, 1, channels].\n " ]
Please provide a description of the function:def add_layer_timing_signal_learned_1d(x, layer, num_layers): channels = common_layers.shape_list(x)[-1] signal = get_layer_timing_signal_learned_1d(channels, layer, num_layers) x += signal return x
[ "Add n-dimensional embedding as the layer (vertical) timing signal.\n\n Adds embeddings to represent the position of the layer in the tower.\n\n Args:\n x: a tensor with shape [batch, length, depth]\n layer: layer num\n num_layers: total number of layers\n\n Returns:\n a Tensor the same shape as x.\n " ]
Please provide a description of the function:def get_layer_timing_signal_sinusoid_1d(channels, layer, num_layers): signal = get_timing_signal_1d(num_layers, channels) layer_signal = tf.expand_dims(signal[:, layer, :], axis=1) return layer_signal
[ "Add sinusoids of different frequencies as layer (vertical) timing signal.\n\n Args:\n channels: dimension of the timing signal\n layer: layer num\n num_layers: total number of layers\n\n Returns:\n a Tensor of timing signals [1, 1, channels].\n " ]
Please provide a description of the function:def add_layer_timing_signal_sinusoid_1d(x, layer, num_layers): channels = common_layers.shape_list(x)[-1] signal = get_layer_timing_signal_sinusoid_1d(channels, layer, num_layers) return x + signal
[ "Add sinusoids of different frequencies as layer (vertical) timing signal.\n\n Args:\n x: a Tensor with shape [batch, length, channels]\n layer: layer num\n num_layers: total number of layers\n\n Returns:\n a Tensor the same shape as x.\n " ]
Please provide a description of the function:def add_timing_signal_1d_given_position(x, position, min_timescale=1.0, max_timescale=1.0e4): channels = common_layers.shape_list(x)[2] num_timescales = channels // 2 log_timescale_increment = ( math.log(float(max_timescale) / float(min_timescale)) / (tf.to_float(num_timescales) - 1)) inv_timescales = min_timescale * tf.exp( tf.to_float(tf.range(num_timescales)) * -log_timescale_increment) scaled_time = ( tf.expand_dims(tf.to_float(position), 2) * tf.expand_dims( tf.expand_dims(inv_timescales, 0), 0)) signal = tf.concat([tf.sin(scaled_time), tf.cos(scaled_time)], axis=2) signal = tf.pad(signal, [[0, 0], [0, 0], [0, tf.mod(channels, 2)]]) signal = common_layers.cast_like(signal, x) return x + signal
[ "Adds sinusoids of diff frequencies to a Tensor, with timing position given.\n\n Args:\n x: a Tensor with shape [batch, length, channels]\n position: a Tensor with shape [batch, length]\n min_timescale: a float\n max_timescale: a float\n\n Returns:\n a Tensor the same shape as x.\n " ]
Please provide a description of the function:def add_timing_signal_nd(x, min_timescale=1.0, max_timescale=1.0e4): num_dims = len(x.get_shape().as_list()) - 2 channels = common_layers.shape_list(x)[-1] num_timescales = channels // (num_dims * 2) log_timescale_increment = ( math.log(float(max_timescale) / float(min_timescale)) / (tf.to_float(num_timescales) - 1)) inv_timescales = min_timescale * tf.exp( tf.to_float(tf.range(num_timescales)) * -log_timescale_increment) for dim in range(num_dims): length = common_layers.shape_list(x)[dim + 1] position = tf.to_float(tf.range(length)) scaled_time = tf.expand_dims(position, 1) * tf.expand_dims( inv_timescales, 0) signal = tf.concat([tf.sin(scaled_time), tf.cos(scaled_time)], axis=1) prepad = dim * 2 * num_timescales postpad = channels - (dim + 1) * 2 * num_timescales signal = tf.pad(signal, [[0, 0], [prepad, postpad]]) for _ in range(1 + dim): signal = tf.expand_dims(signal, 0) for _ in range(num_dims - 1 - dim): signal = tf.expand_dims(signal, -2) x += signal return x
[ "Adds a bunch of sinusoids of different frequencies to a Tensor.\n\n Each channel of the input Tensor is incremented by a sinusoid of a different\n frequency and phase in one of the positional dimensions.\n\n This allows attention to learn to use absolute and relative positions.\n Timing signals should be added to some precursors of both the query and the\n memory inputs to attention.\n\n The use of relative position is possible because sin(a+b) and cos(a+b) can be\n experessed in terms of b, sin(a) and cos(a).\n\n x is a Tensor with n \"positional\" dimensions, e.g. one dimension for a\n sequence or two dimensions for an image\n\n We use a geometric sequence of timescales starting with\n min_timescale and ending with max_timescale. The number of different\n timescales is equal to channels // (n * 2). For each timescale, we\n generate the two sinusoidal signals sin(timestep/timescale) and\n cos(timestep/timescale). All of these sinusoids are concatenated in\n the channels dimension.\n\n Args:\n x: a Tensor with shape [batch, d1 ... dn, channels]\n min_timescale: a float\n max_timescale: a float\n\n Returns:\n a Tensor the same shape as x.\n " ]
Please provide a description of the function:def add_positional_embedding(x, max_length, name=None, positions=None): with tf.name_scope("add_positional_embedding"): _, length, depth = common_layers.shape_list(x) var = tf.cast(tf.get_variable(name, [max_length, depth]), x.dtype) if positions is None: pad_length = tf.maximum(0, length - max_length) sliced = tf.cond( tf.less(length, max_length), lambda: tf.slice(var, [0, 0], [length, -1]), lambda: tf.pad(var, [[0, pad_length], [0, 0]])) return x + tf.expand_dims(sliced, 0) else: return x + tf.gather(var, tf.to_int32(positions))
[ "Adds positional embedding.\n\n Args:\n x: Tensor with shape [batch, length, depth].\n max_length: int representing static maximum size of any dimension.\n name: str representing name of the embedding tf.Variable.\n positions: Tensor with shape [batch, length].\n\n Returns:\n Tensor of same shape as x.\n " ]
Please provide a description of the function:def add_positional_embedding_nd(x, max_length, name=None): with tf.name_scope("add_positional_embedding_nd"): x_shape = common_layers.shape_list(x) num_dims = len(x_shape) - 2 depth = x_shape[-1] base_shape = [1] * (num_dims + 1) + [depth] base_start = [0] * (num_dims + 2) base_size = [-1] + [1] * num_dims + [depth] for i in range(num_dims): shape = base_shape[:] start = base_start[:] size = base_size[:] shape[i + 1] = max_length size[i + 1] = x_shape[i + 1] var = tf.get_variable( name + "_%d" % i, shape, initializer=tf.random_normal_initializer(0, depth**-0.5)) var = var * depth**0.5 x += tf.slice(var, start, size) return x
[ "Adds n-dimensional positional embedding.\n\n The embeddings add to all positional dimensions of the tensor.\n\n Args:\n x: Tensor with shape [batch, p1 ... pn, depth]. It has n positional\n dimensions, i.e., 1 for text, 2 for images, 3 for video, etc.\n max_length: int representing static maximum size of any dimension.\n name: str representing name of the embedding tf.Variable.\n\n Returns:\n Tensor of same shape as x.\n " ]
Please provide a description of the function:def make_edge_vectors(adjacency_matrix, num_edge_types, depth, name=None): with tf.variable_scope(name, default_name="edge_vectors"): att_adj_vectors_shape = [num_edge_types, depth] adjacency_matrix_shape = common_layers.shape_list(adjacency_matrix) adj_vectors = ( tf.get_variable( "adj_vectors", att_adj_vectors_shape, initializer=tf.random_normal_initializer(0, depth**-0.5)) * (depth**0.5)) # Avoiding gathers so that it works on TPUs # adjacency_matrix_one_hot has shape # [batch, num_nodes, num_nodes, num_edge_types] adjacency_matrix_one_hot = tf.one_hot(adjacency_matrix, num_edge_types) att_adj_vectors = tf.matmul( tf.reshape(tf.to_float(adjacency_matrix_one_hot), [-1, num_edge_types]), adj_vectors) return tf.reshape(att_adj_vectors, [adjacency_matrix_shape[0], adjacency_matrix_shape[1], adjacency_matrix_shape[2], depth])
[ "Gets edge vectors for the edge types in the adjacency matrix.\n\n Args:\n adjacency_matrix: A [batch, num_nodes, num_nodes] tensor of ints.\n num_edge_types: Number of different edge types\n depth: Number of channels\n name: a string\n Returns:\n A [batch, num_nodes, num_nodes, depth] vector of tensors\n " ]
Please provide a description of the function:def padding_to_length(padding): non_padding = 1.0 - padding return tf.to_int32(tf.reduce_sum(non_padding, axis=-1))
[ "Calculate the length of mask based on padding.\n\n Args:\n padding: a Tensor with shape [..., length].\n Returns:\n a Tensor with shape [...].\n " ]
Please provide a description of the function:def attention_bias_local(length, max_backward, max_forward): band = common_layers.ones_matrix_band_part( length, length, max_backward, max_forward, out_shape=[1, 1, length, length]) return -1e9 * (1.0 - band)
[ "Create an bias tensor to be added to attention logits.\n\n A position may attend to positions at most max_distance from it,\n forward and backwards.\n\n This does not actually save any computation.\n\n Args:\n length: int\n max_backward: int, maximum distance backward to attend. Negative values\n indicate unlimited.\n max_forward: int, maximum distance forward to attend. Negative values\n indicate unlimited.\n\n Returns:\n a `Tensor` with shape [1, 1, length, length].\n " ]
Please provide a description of the function:def attention_bias_same_segment(query_segment_id, memory_segment_id): ret = (tf.to_float( tf.not_equal( tf.expand_dims(query_segment_id, 2), tf.expand_dims(memory_segment_id, 1))) * large_compatible_negative(memory_segment_id.dtype)) return tf.expand_dims(ret, axis=1)
[ "Create an bias tensor to be added to attention logits.\n\n Positions with the same segment_ids can see each other.\n\n Args:\n query_segment_id: a float `Tensor` with shape [batch, query_length].\n memory_segment_id: a float `Tensor` with shape [batch, memory_length].\n\n Returns:\n a `Tensor` with shape [batch, 1, query_length, memory_length].\n " ]
Please provide a description of the function:def attention_bias_ignore_padding(memory_padding): ret = memory_padding * large_compatible_negative(memory_padding.dtype) return tf.expand_dims(tf.expand_dims(ret, axis=1), axis=1)
[ "Create an bias tensor to be added to attention logits.\n\n Args:\n memory_padding: a float `Tensor` with shape [batch, memory_length].\n\n Returns:\n a `Tensor` with shape [batch, 1, 1, memory_length].\n " ]
Please provide a description of the function:def attention_bias_to_padding(attention_bias, cast_fn=tf.to_float): # `attention_bias` is a large negative number in padding positions and 0.0 # elsewhere. return tf.squeeze(cast_fn(tf.less(attention_bias, -1)), axis=[1, 2])
[ "Inverse of attention_bias_ignore_padding().\n\n Args:\n attention_bias: a `Tensor` with shape [batch, 1, 1, memory_length], as\n returned by attention_bias_ignore_padding().\n cast_fn: function used to cast to output type.\n\n Returns:\n a Tensor with shape [batch, memory_length] with 1.0 in padding positions\n and 0.0 in non-padding positions. Type is determined by cast_fn.\n " ]
Please provide a description of the function:def attention_bias_prepend_inputs_full_attention(padding): # Everything past the first padding position is part of the target. # This Tensor has zeros for the source portion and separator, # and ones for the target portion. in_target = tf.cumsum(padding, axis=1, exclusive=True) # The position within the target, or 0 if part of the source. target_pos = tf.cumsum(in_target, axis=1) # A position with a lesser target_pos cannot see a position with greater # target_pos. illegal_connections = tf.greater( tf.expand_dims(target_pos, 1), tf.expand_dims(target_pos, 2)) bias = tf.to_float(illegal_connections) * -1e9 bias = tf.expand_dims(bias, 1) return bias
[ "Create a bias tensor for prepend_mode=\"prepend_inputs_full_attention\".\n\n See prepend_inputs in common_hparams.py.\n\n Produces a bias tensor to be used in self-attention.\n\n This bias tensor allows for full connectivity in the \"inputs\" part of\n the sequence and masked connectivity in the targets part.\n\n Args:\n padding: a float `Tensor` with shape [batch, length] with\n ones in positions corresponding to padding. In each row, a single\n padding position separates the input part from the target part.\n\n Returns:\n a `Tensor` with shape [batch, 1, length, length].\n " ]
Please provide a description of the function:def attention_bias_proximal(length): r = tf.to_float(tf.range(length)) diff = tf.expand_dims(r, 0) - tf.expand_dims(r, 1) return tf.expand_dims(tf.expand_dims(-tf.log1p(tf.abs(diff)), 0), 0)
[ "Bias for self-attention to encourage attention to close positions.\n\n Args:\n length: an integer scalar.\n\n Returns:\n a Tensor with shape [1, 1, length, length]\n " ]
Please provide a description of the function:def attention_bias_batch(batch_coordinates_q, batch_coordinates_k=None, condition_fn=None): if batch_coordinates_k is None: batch_coordinates_k = batch_coordinates_q # Convert to float first because of b/25387198. def to_float(bc): bc = tf.squeeze(bc, 1) bc = tf.to_float(bc) return bc # Broadcast to create [length_q, length_k] mask. bc_v = tf.expand_dims(to_float(batch_coordinates_q), 1) bc_h = tf.expand_dims(to_float(batch_coordinates_k), 0) bias_batch = bc_h - bc_v bias_batch = condition_fn(bias_batch) bias_batch *= -1e9 return bias_batch
[ "Generate a mask to prevent the batch to attend to each others.\n\n Args:\n batch_coordinates_q: Int-like Tensor of shape [length_q, 1] containing the\n coordinates of the batches\n batch_coordinates_k: Int-like Tensor of shape [length_k, 1] containing the\n coordinates of the batches. If None, do self-attention.\n condition_fn: Callable defining the attention mask.\n\n Returns:\n Float-like Tensor of shape [length_q, length_k] containing either 0 or\n -infinity (-1e9).\n " ]
Please provide a description of the function:def split_last_dimension(x, n): x_shape = common_layers.shape_list(x) m = x_shape[-1] if isinstance(m, int) and isinstance(n, int): assert m % n == 0 return tf.reshape(x, x_shape[:-1] + [n, m // n])
[ "Reshape x so that the last dimension becomes two dimensions.\n\n The first of these two dimensions is n.\n\n Args:\n x: a Tensor with shape [..., m]\n n: an integer.\n\n Returns:\n a Tensor with shape [..., n, m/n]\n " ]
Please provide a description of the function:def combine_last_two_dimensions(x): x_shape = common_layers.shape_list(x) a, b = x_shape[-2:] return tf.reshape(x, x_shape[:-2] + [a * b])
[ "Reshape x so that the last two dimension become one.\n\n Args:\n x: a Tensor with shape [..., a, b]\n\n Returns:\n a Tensor with shape [..., ab]\n " ]
Please provide a description of the function:def combine_first_two_dimensions(x): ret = tf.reshape(x, tf.concat([[-1], common_layers.shape_list(x)[2:]], 0)) old_shape = x.get_shape().dims a, b = old_shape[:2] new_shape = [a * b if a and b else None] + old_shape[2:] ret.set_shape(new_shape) return ret
[ "Reshape x so that the first two dimension become one.\n\n Args:\n x: a Tensor with shape [a, b, ...]\n\n Returns:\n a Tensor with shape [ab, ...]\n " ]
Please provide a description of the function:def attention_image_summary(attn, image_shapes=None): attn = tf.cast(attn, tf.float32) num_heads = common_layers.shape_list(attn)[1] # [batch, query_length, memory_length, num_heads] image = tf.transpose(attn, [0, 2, 3, 1]) image = tf.pow(image, 0.2) # for high-dynamic-range # Each head will correspond to one of RGB. # pad the heads to be a multiple of 3 image = tf.pad(image, [[0, 0], [0, 0], [0, 0], [0, tf.mod(-num_heads, 3)]]) image = split_last_dimension(image, 3) image = tf.reduce_max(image, 4) if image_shapes is not None: if len(image_shapes) == 4: q_rows, q_cols, m_rows, m_cols = list(image_shapes) image = tf.reshape(image, [-1, q_rows, q_cols, m_rows, m_cols, 3]) image = tf.transpose(image, [0, 1, 3, 2, 4, 5]) image = tf.reshape(image, [-1, q_rows * m_rows, q_cols * m_cols, 3]) else: assert len(image_shapes) == 6 q_rows, q_cols, q_channnels, m_rows, m_cols, m_channels = list( image_shapes) image = tf.reshape( image, [-1, q_rows, q_cols, q_channnels, m_rows, m_cols, m_channels, 3]) image = tf.transpose(image, [0, 1, 4, 3, 2, 5, 6, 7]) image = tf.reshape( image, [-1, q_rows * m_rows * q_channnels, q_cols * m_cols * m_channels, 3]) tf.summary.image("attention", image, max_outputs=1)
[ "Compute color image summary.\n\n Args:\n attn: a Tensor with shape [batch, num_heads, query_length, memory_length]\n image_shapes: optional tuple of integer scalars.\n If the query positions and memory positions represent the\n pixels of flattened images, then pass in their dimensions:\n (query_rows, query_cols, memory_rows, memory_cols).\n If the query positions and memory positions represent the\n pixels x channels of flattened images, then pass in their dimensions:\n (query_rows, query_cols, query_channels,\n memory_rows, memory_cols, memory_channels).\n " ]
Please provide a description of the function:def grouped_attention_multihead(query_antecedent, memory_antecedent, total_key_depth, total_value_depth, output_depth, num_heads, num_groups, memory_target_density=2.0, multiplicative_overhead=1.25, additive_overhead=8.0, mask_right=False, make_image_summary=True, name=None): batch = common_layers.shape_list(query_antecedent)[0] length_q = common_layers.shape_list(query_antecedent)[1] length_kv = common_layers.shape_list(memory_antecedent)[1] if total_key_depth % num_heads != 0: raise ValueError("Key depth (%d) must be divisible by the number of " "attention heads (%d)." % (total_key_depth, num_heads)) depth_qk = total_key_depth // num_heads if total_value_depth % num_heads != 0: raise ValueError("Value depth (%d) must be divisible by the number of " "attention heads (%d)." % (total_value_depth, num_heads)) depth_v = total_value_depth // num_heads with tf.variable_scope( name, default_name="multihead_attention_sparse", values=[query_antecedent, memory_antecedent]): q = common_layers.dense( query_antecedent, total_key_depth, use_bias=False, name="q_transform") kv = common_layers.dense( memory_antecedent, total_key_depth + total_value_depth, use_bias=False, name="kv_transform") q = split_heads(q, num_heads) kv = split_heads(kv, num_heads) # Make predictions about q_total and m_total. # These are used to determine group inclusion. # We will train these by auxiliary losses. We use stop_gradient here # to keep these losses from back-propagating to the rest of the model. # We add biases that help balance the usage of the experts. q_pred = common_layers.dense( tf.stop_gradient(query_antecedent), num_heads * num_groups, use_bias=False, name="q_pred") q_pred = split_heads(q_pred, num_heads) q_bias = tf.get_variable("q_bias", [1, num_heads, 1, num_groups]) q_pred_biased = q_pred + q_bias m_pred = common_layers.dense( tf.stop_gradient(memory_antecedent), num_heads * num_groups, use_bias=False, name="m_pred") m_pred = split_heads(m_pred, num_heads) m_bias = tf.get_variable("m_bias", [1, num_heads, 1, num_groups]) m_pred_biased = m_pred + m_bias q *= depth_qk**-0.5 # q, kv, q_pred, m_pred are all [batch, heads, length_[q/m], ?] # now reshape them all to [batch * heads, length, ?] q = combine_first_two_dimensions(q) kv = combine_first_two_dimensions(kv) q_pred = combine_first_two_dimensions(q_pred) m_pred = combine_first_two_dimensions(m_pred) q_pred_biased = combine_first_two_dimensions(q_pred_biased) m_pred_biased = combine_first_two_dimensions(m_pred_biased) q_group = tf.argmax(q_pred_biased, axis=2) q_requests = tf.one_hot(q_group, num_groups, axis=-1) m_requests = tf.to_float(tf.greater(m_pred_biased, 0.0)) # include first memory position in all groups, to avoid division by zero. m_requests = tf.maximum( m_requests, tf.reshape(tf.one_hot([0], length_kv), [1, length_kv, 1])) q_group_size = tf.reduce_sum(q_requests, 1) m_group_size = tf.reduce_sum(m_requests, 1) q_group_target_size = tf.to_float(length_q) / tf.to_float(num_groups) m_group_target_size = ( tf.to_float(length_kv) * memory_target_density / tf.to_float(num_groups)) capacity_q = tf.minimum( length_q, tf.to_int32(q_group_target_size * multiplicative_overhead + additive_overhead)) capacity_m = tf.minimum( length_kv, tf.to_int32(m_group_target_size * multiplicative_overhead + additive_overhead)) q_dispatcher = expert_utils.TruncatingDispatcher(q_requests, capacity_q) m_dispatcher = expert_utils.TruncatingDispatcher(m_requests, capacity_m) q_gates = q_dispatcher.gates() m_gates = m_dispatcher.gates() dispatched_q = q_dispatcher.dispatch(q) dispatched_kv = m_dispatcher.dispatch(kv) # dispatched_q: [batch * num_heads, num_groups, capacity_q, depth_qk] # dispatched_kv: # [batch * num_heads, num_groups, capacity_m, depth_qk + depth_v] k, v = tf.split(dispatched_kv, [depth_qk, depth_v], axis=3) logits = tf.matmul(dispatched_q, k, transpose_b=True) bias = tf.expand_dims((m_dispatcher.nonpadding() - 1.0) * 1e9, 2) if mask_right: q_coordinate = tf.to_float( tf.expand_dims(q_dispatcher.length_coordinate(), 3)) m_coordinate = tf.to_float( tf.expand_dims(m_dispatcher.length_coordinate(), 2)) bias += tf.to_float(tf.greater(m_coordinate, q_coordinate)) * -1e9 logits += bias log_weights = tf.nn.log_softmax(logits) weights = tf.exp(log_weights) # For each query, this is the log of the sum of the unnormalized weights. q_total = tf.stop_gradient(logits[:, :, :, :1] - log_weights[:, :, :, :1]) # For each key, this is the sum of the normalized weights. m_total = tf.expand_dims( tf.reduce_sum(tf.stop_gradient(weights), axis=2), -1) o = tf.matmul(weights, v) o = q_dispatcher.combine(o) o = tf.reshape(o, [batch, num_heads, length_q, depth_v]) o = combine_heads(o) o = common_layers.dense( o, output_depth, use_bias=False, name="output_transform") m_total = m_dispatcher.combine(m_total) q_total = q_dispatcher.combine(q_total) q_total = tf.squeeze(q_total, -1) m_total = tf.squeeze(m_total, -1) # Compute summed m predictions for all groups m_pred_used = tf.reduce_sum(tf.exp(m_pred) * m_dispatcher.gates(), axis=2) q_pred_used = tf.reduce_sum(q_pred * q_dispatcher.gates(), axis=2) epsilon = 1e-3 m_pred_used = tf.log(m_pred_used + epsilon) m_total = tf.log(m_total + epsilon) m_loss = tf.nn.l2_loss(m_total - m_pred_used) q_loss = tf.nn.l2_loss( (q_total - q_pred_used) * tf.reduce_sum(q_gates, axis=2)) q_loss /= tf.to_float(batch * length_q) m_loss /= tf.to_float(batch * length_kv) # We would like the query groups to be equal sized. The group # size is discrete, so we need some trick here. We add a loss # proportional to the product of the group size and the # predictions for that group. This encourages the predictions to # decrease for groups that are too big. q_group_deviation = (q_group_size / q_group_target_size) - 1.0 q_balance_loss = tf.reduce_sum( tf.reduce_mean(q_pred_biased, axis=1) * q_group_deviation) / tf.to_float(batch) m_group_deviation = (m_group_size / m_group_target_size) - 1.0 m_balance_loss = tf.reduce_sum( tf.reduce_mean(m_pred_biased, axis=1) * m_group_deviation) / tf.to_float(batch) # The losses in this function only propagate back to variables # defined in this function, and the losses outside of this # function only propagate back to variables outside of this # function. Assuming some kind of adaptive learning algorithm, # it should not matter how much we scale the losses in this function. # Still we scale them down a lot so that they should not show up # much in the overall loss for the model. extra_loss_multiplier = 1e-3 extra_loss = q_loss + m_loss + q_balance_loss + m_balance_loss extra_loss *= extra_loss_multiplier # Show a bunch of summaries. if common_layers.should_generate_summaries() and make_image_summary: tf.summary.histogram("q_group_size", q_group_size) tf.summary.histogram("m_group_size", m_group_size) tf.summary.scalar("q_loss", q_loss) tf.summary.scalar("m_loss", m_loss) tf.summary.scalar("q_balance_loss", q_balance_loss) tf.summary.scalar("m_balance_loss", m_balance_loss) tf.summary.histogram("m_pred_used", m_pred_used) tf.summary.histogram("m_total", m_total) tf.summary.histogram("q_pred_used", q_pred_used) tf.summary.histogram("q_total", q_total) if make_image_summary: # image summaries are expensive. # So we restrict them to head_num<4, query_position<512, batch_index=0. trunc_heads = min(4, num_heads) trunc_length_q = tf.minimum(length_q, 512) # We recompute the attention for the first example, in an inefficient # way - masking. This lets us show pretty pictures. # [trunc_heads, length_q, group] q_gates_trunc = q_gates[:trunc_heads, :trunc_length_q, :] # [trunc_heads, length_kv, group] m_gates_trunc = m_gates[:trunc_heads, :, :] grouping_mask = tf.matmul( q_gates_trunc, m_gates_trunc, transpose_b=True) q_trunc = q[:trunc_heads, :trunc_length_q, :] k_trunc = kv[:trunc_heads, :, :depth_qk] logits_trunc = tf.matmul(q_trunc, k_trunc, transpose_b=True) if mask_right: band = common_layers.ones_matrix_band_part(trunc_length_q, length_kv, -1, 0) trunc_bias = tf.expand_dims((1.0 - band) * -1e9, 0) logits_trunc += trunc_bias att_trunc = tf.nn.softmax(logits_trunc) mask_coverage = tf.reduce_sum(grouping_mask * att_trunc) / ( tf.to_float(trunc_length_q) * trunc_heads) tf.summary.scalar("coverage", mask_coverage) att_trunc_hdr = tf.pow(att_trunc, 0.2) # for high-dynamic-range mask_channel = grouping_mask * tf.maximum(att_trunc_hdr, 0.3) image = tf.stack([att_trunc_hdr, mask_channel, mask_channel], axis=3) tf.summary.image("att", image, max_outputs=trunc_heads) # show one group for each head. att_per_group = tf.expand_dims(weights[:trunc_heads, 0, :, :], -1) tf.summary.image( "att_per_group_%d", tf.pow(att_per_group, 0.2), max_outputs=trunc_heads) return o, extra_loss
[ "Multi-head dot-product attention with sparsity.\n\n For each attention head, the queries are partitioned into groups.\n For each group, only a subset of the key-value pairs are considered.\n\n The choices of groups are selected based on trained predictors of\n the total attention given the group inclusion.\n\n memory_target_density indicates the average how many groups in which\n a key-value pair should participate.\n\n We use auxiliary losses to ensure that each group contains roughly\n the same number of queries and the same number of key-value pairs.\n If for a given sequence, the actual number of queries/pairs sent to\n an expert exceeds this target by a factor of more than\n multiplicative_overhead, then the last ones are dropped. We use\n this drop-last policy to avoid bleeding information backwards, which\n is necessary when using this function with autoregressive\n prediction.\n\n Args:\n query_antecedent: a Tensor with shape [batch, length_q, channels]\n memory_antecedent: a Tensor with shape [batch, length_m, channels]\n total_key_depth: an integer\n total_value_depth: an integer\n output_depth: an integer\n num_heads: an integer dividing total_key_depth and total_value_depth\n num_groups: an integer\n memory_target_density: a floating point scalar\n multiplicative_overhead: a floating point scalar\n additive_overhead: a floating point scalar\n mask_right: a boolean\n make_image_summary: a boolean\n name: an optional string\n\n Returns:\n A Tensor with shape [batch, length_q, output_depth]\n\n Raises:\n ValueError: if the key depth or value depth are not divisible by the\n number of attention heads.\n " ]
Please provide a description of the function:def harden_attention_weights(weights, hard_attention_k): # Subtract the top-kth weight and zero-out all lower ones. # Note that currently in case of numerical ties it will retain more # than k elements. In the future, we may want to avoid this. weights -= common_layers.top_kth_iterative(weights, hard_attention_k) weights = tf.nn.relu(weights) # Re-normalize the weights. weights_sum = tf.reduce_sum(weights, axis=-1, keep_dims=True) weights_sum = tf.maximum(weights_sum, 1e-6) # Avoid division by 0. weights /= weights_sum return weights
[ "Make attention weights non-0 only on the top-hard_attention_k ones." ]
Please provide a description of the function:def dot_product_attention(q, k, v, bias, dropout_rate=0.0, image_shapes=None, name=None, make_image_summary=True, save_weights_to=None, dropout_broadcast_dims=None, activation_dtype=None, weight_dtype=None, hard_attention_k=0): with tf.variable_scope( name, default_name="dot_product_attention", values=[q, k, v]) as scope: logits = tf.matmul(q, k, transpose_b=True) # [..., length_q, length_kv] if bias is not None: bias = common_layers.cast_like(bias, logits) logits += bias # If logits are fp16, upcast before softmax logits = maybe_upcast(logits, activation_dtype, weight_dtype) weights = tf.nn.softmax(logits, name="attention_weights") if hard_attention_k > 0: weights = harden_attention_weights(weights, hard_attention_k) weights = common_layers.cast_like(weights, q) if save_weights_to is not None: save_weights_to[scope.name] = weights save_weights_to[scope.name + "/logits"] = logits # Drop out attention links for each head. weights = common_layers.dropout_with_broadcast_dims( weights, 1.0 - dropout_rate, broadcast_dims=dropout_broadcast_dims) if common_layers.should_generate_summaries() and make_image_summary: attention_image_summary(weights, image_shapes) return tf.matmul(weights, v)
[ "Dot-product attention.\n\n Args:\n q: Tensor with shape [..., length_q, depth_k].\n k: Tensor with shape [..., length_kv, depth_k]. Leading dimensions must\n match with q.\n v: Tensor with shape [..., length_kv, depth_v] Leading dimensions must\n match with q.\n bias: bias Tensor (see attention_bias())\n dropout_rate: a float.\n image_shapes: optional tuple of integer scalars.\n see comments for attention_image_summary()\n name: an optional string\n make_image_summary: True if you want an image summary.\n save_weights_to: an optional dictionary to capture attention weights\n for visualization; the weights tensor will be appended there under\n a string key created from the variable scope (including name).\n dropout_broadcast_dims: an optional list of integers less than rank of q.\n Specifies in which dimensions to broadcast the dropout decisions.\n activation_dtype: Used to define function activation dtype when using\n mixed precision.\n weight_dtype: The dtype weights are stored in when using mixed precision\n hard_attention_k: integer, if > 0 triggers hard attention (picking top-k)\n\n Returns:\n Tensor with shape [..., length_q, depth_v].\n " ]
Please provide a description of the function:def _generate_relative_positions_matrix(length_q, length_k, max_relative_position, cache=False): if not cache: if length_q == length_k: range_vec_q = range_vec_k = tf.range(length_q) else: range_vec_k = tf.range(length_k) range_vec_q = range_vec_k[-length_q:] distance_mat = range_vec_k[None, :] - range_vec_q[:, None] else: distance_mat = tf.expand_dims(tf.range(-length_k+1, 1, 1), 0) distance_mat_clipped = tf.clip_by_value(distance_mat, -max_relative_position, max_relative_position) # Shift values to be >= 0. Each integer still uniquely identifies a relative # position difference. final_mat = distance_mat_clipped + max_relative_position return final_mat
[ "Generates matrix of relative positions between inputs." ]
Please provide a description of the function:def _generate_relative_positions_embeddings(length_q, length_k, depth, max_relative_position, name, cache=False): with tf.variable_scope(name): relative_positions_matrix = _generate_relative_positions_matrix( length_q, length_k, max_relative_position, cache=cache) vocab_size = max_relative_position * 2 + 1 # Generates embedding for each relative position of dimension depth. embeddings_table = tf.get_variable("embeddings", [vocab_size, depth]) embeddings = tf.gather(embeddings_table, relative_positions_matrix) return embeddings
[ "Generates tensor of size [1 if cache else length_q, length_k, depth]." ]
Please provide a description of the function:def _relative_attention_inner(x, y, z, transpose): batch_size = tf.shape(x)[0] heads = x.get_shape().as_list()[1] length = tf.shape(x)[2] # xy_matmul is [batch_size, heads, length or 1, length or depth] xy_matmul = tf.matmul(x, y, transpose_b=transpose) # x_t is [length or 1, batch_size, heads, length or depth] x_t = tf.transpose(x, [2, 0, 1, 3]) # x_t_r is [length or 1, batch_size * heads, length or depth] x_t_r = tf.reshape(x_t, [length, heads * batch_size, -1]) # x_tz_matmul is [length or 1, batch_size * heads, length or depth] x_tz_matmul = tf.matmul(x_t_r, z, transpose_b=transpose) # x_tz_matmul_r is [length or 1, batch_size, heads, length or depth] x_tz_matmul_r = tf.reshape(x_tz_matmul, [length, batch_size, heads, -1]) # x_tz_matmul_r_t is [batch_size, heads, length or 1, length or depth] x_tz_matmul_r_t = tf.transpose(x_tz_matmul_r, [1, 2, 0, 3]) return xy_matmul + x_tz_matmul_r_t
[ "Relative position-aware dot-product attention inner calculation.\n\n This batches matrix multiply calculations to avoid unnecessary broadcasting.\n\n Args:\n x: Tensor with shape [batch_size, heads, length or 1, length or depth].\n y: Tensor with shape [batch_size, heads, length or 1, depth].\n z: Tensor with shape [length or 1, length, depth].\n transpose: Whether to transpose inner matrices of y and z. Should be true if\n last dimension of x is depth, not length.\n\n Returns:\n A Tensor with shape [batch_size, heads, length, length or depth].\n " ]
Please provide a description of the function:def dot_product_attention_relative(q, k, v, bias, max_relative_position, dropout_rate=0.0, image_shapes=None, save_weights_to=None, name=None, make_image_summary=True, cache=False, allow_memory=False, hard_attention_k=0): if not max_relative_position: raise ValueError("Max relative position (%s) should be > 0 when using " "relative self attention." % (max_relative_position)) with tf.variable_scope( name, default_name="dot_product_attention_relative", values=[q, k, v]) as scope: # This calculation only works for self attention. # q, k and v must therefore have the same shape, unless memory is enabled. if not cache and not allow_memory: q.get_shape().assert_is_compatible_with(k.get_shape()) q.get_shape().assert_is_compatible_with(v.get_shape()) # Use separate embeddings suitable for keys and values. depth = k.get_shape().as_list()[3] length_k = common_layers.shape_list(k)[2] length_q = common_layers.shape_list(q)[2] if allow_memory else length_k relations_keys = _generate_relative_positions_embeddings( length_q, length_k, depth, max_relative_position, "relative_positions_keys", cache=cache) relations_values = _generate_relative_positions_embeddings( length_q, length_k, depth, max_relative_position, "relative_positions_values", cache=cache) # Compute self attention considering the relative position embeddings. logits = _relative_attention_inner(q, k, relations_keys, True) if bias is not None: logits += bias weights = tf.nn.softmax(logits, name="attention_weights") if hard_attention_k > 0: weights = harden_attention_weights(weights, hard_attention_k) if save_weights_to is not None: save_weights_to[scope.name] = weights save_weights_to[scope.name + "/logits"] = logits weights = tf.nn.dropout(weights, 1.0 - dropout_rate) if not tf.get_variable_scope().reuse and make_image_summary: attention_image_summary(weights, image_shapes) return _relative_attention_inner(weights, v, relations_values, False)
[ "Calculate relative position-aware dot-product self-attention.\n\n The attention calculation is augmented with learned representations for the\n relative position between each element in q and each element in k and v.\n\n Args:\n q: a Tensor with shape [batch, heads, length, depth].\n k: a Tensor with shape [batch, heads, length, depth].\n v: a Tensor with shape [batch, heads, length, depth].\n bias: bias Tensor.\n max_relative_position: an integer specifying the maximum distance between\n inputs that unique position embeddings should be learned for.\n dropout_rate: a floating point number.\n image_shapes: optional tuple of integer scalars.\n save_weights_to: an optional dictionary to capture attention weights\n for visualization; the weights tensor will be appended there under\n a string key created from the variable scope (including name).\n name: an optional string.\n make_image_summary: Whether to make an attention image summary.\n cache: whether use cache mode\n allow_memory: whether to assume that recurrent memory is in use. If True,\n the length dimension of k/v/bias may be longer than the queries, and it is\n assumed that the extra memory entries precede the non-memory entries.\n hard_attention_k: integer, if > 0 triggers hard attention (picking top-k)\n\n Returns:\n A Tensor.\n\n Raises:\n ValueError: if max_relative_position is not > 0.\n " ]
Please provide a description of the function:def _relative_position_to_absolute_position_masked(x): batch, heads, length, _ = common_layers.shape_list(x) x = tf.pad(x, [[0, 0], [0, 0], [0, 0], [1, 0]]) x = tf.reshape(x, [batch, heads, 1 + length, length]) x = tf.slice(x, [0, 0, 1, 0], [-1, -1, -1, -1]) return x
[ "Helper to dot_product_self_attention_relative_v2.\n\n Rearrange an attention logits or weights Tensor.\n\n The dimensions of the input represent:\n [batch, heads, query_position, memory_position - query_position + length - 1]\n\n The dimensions of the output represent:\n [batch, heads, query_position, memory_position]\n\n Only works with masked_attention. Undefined behavior for regions of the\n input where memory_position > query_position.\n\n Args:\n x: a Tensor with shape [batch, heads, length, length]\n\n Returns:\n a Tensor with shape [batch, heads, length, length]\n " ]
Please provide a description of the function:def dot_product_self_attention_relative_v2(q, k, v, bias, max_relative_position=None, dropout_rate=0.0, image_shapes=None, name=None, make_image_summary=True, dropout_broadcast_dims=None, heads_share_relative_embedding=False, add_relative_to_values=False): if not max_relative_position: raise ValueError("Max relative position (%s) should be > 0 when using " "relative self attention." % (max_relative_position)) with tf.variable_scope( name, default_name="dot_product_self_attention_relative_v2", values=[q, k, v]): # This calculation only works for self attention. # q, k and v must therefore have the same shape. q.get_shape().assert_is_compatible_with(k.get_shape()) q.get_shape().assert_is_compatible_with(v.get_shape()) # Use separate embeddings suitable for keys and values. _, num_heads, length, depth_k = common_layers.shape_list(k) # [batch, num_heads, query_length, memory_length] logits = tf.matmul(q, k, transpose_b=True) key_relative_embeddings = get_relative_embeddings_left( max_relative_position, length, depth_k, num_heads, heads_share_relative_embedding, "key_relative_embeddings") rel_logits = matmul_with_relative_keys(q, key_relative_embeddings, heads_share_relative_embedding) rel_logits = _relative_position_to_absolute_position_masked(rel_logits) logits += rel_logits if bias is not None: logits += bias weights = tf.nn.softmax(logits, name="attention_weights") # Dropping out the attention links for each of the heads. weights = common_layers.dropout_with_broadcast_dims( weights, 1.0 - dropout_rate, broadcast_dims=dropout_broadcast_dims) if common_layers.should_generate_summaries() and make_image_summary: attention_image_summary(weights, image_shapes) output = tf.matmul(weights, v) if add_relative_to_values: # [batch, num_heads, query_length, memory_length] relative_weights = _absolute_position_to_relative_position_masked(weights) depth_v = common_layers.shape_list(v)[3] value_relative_embeddings = get_relative_embeddings_left( max_relative_position, length, depth_v, num_heads, heads_share_relative_embedding, "value_relative_embeddings") output += matmul_with_relative_values( relative_weights, value_relative_embeddings, heads_share_relative_embedding) return output
[ "Calculate relative position-aware dot-product self-attention.\n\n Only works for masked self-attention (no looking forward).\n\n The attention calculation is augmented with learned representations for the\n relative position between each element in q and each element in k and v.\n\n Args:\n q: a Tensor with shape [batch, heads, length, depth].\n k: a Tensor with shape [batch, heads, length, depth].\n v: a Tensor with shape [batch, heads, length, depth].\n bias: bias Tensor.\n max_relative_position: an integer indicating the maximum relative distance\n to look back - changing this invalidates checkpoints\n dropout_rate: a floating point number.\n image_shapes: optional tuple of integer scalars.\n name: an optional string.\n make_image_summary: Whether to make an attention image summary.\n dropout_broadcast_dims: an optional list of integers less than 4\n specifying in which dimensions to broadcast the dropout decisions.\n saves memory.\n heads_share_relative_embedding: a boolean indicating wheather to share\n relative embeddings between attention heads.\n add_relative_to_values: a boolean for whether to add relative component to\n values.\n\n Returns:\n A Tensor.\n\n Raises:\n ValueError: if max_relative_position is not > 0.\n " ]
Please provide a description of the function:def _absolute_position_to_relative_position_unmasked(x): batch, heads, length, _ = common_layers.shape_list(x) # padd along column x = tf.pad(x, [[0, 0], [0, 0], [0, 0], [0, length-1]]) x_flat = tf.reshape(x, [batch, heads, length**2 + length*(length -1)]) # add 0's in the beginning that will skew the elements after reshape x_flat = tf.pad(x_flat, [[0, 0], [0, 0], [length, 0]]) x = tf.reshape(x_flat, [batch, heads, length, 2*length]) x = tf.slice(x, [0, 0, 0, 1], [batch, heads, length, 2*length -1]) return x
[ "Helper function for dot_product_unmasked_self_attention_relative_v2.\n\n Rearrange an attention logits or weights Tensor.\n\n The dimensions of the input represent:\n [batch, heads, query_position, memory_position]\n\n The dimensions of the output represent:\n [batch, heads, query_position, memory_position - query_position + length - 1]\n\n Only works with unmasked_attention.\n\n Args:\n x: a Tensor with shape [batch, heads, length, length]\n\n Returns:\n a Tensor with shape [batch, heads, length, 2*length-1]\n " ]
Please provide a description of the function:def get_relative_embeddings_left_right(max_relative_position, length, depth, num_heads, heads_share_relative_embedding, name): initializer_stddev = depth**-0.5 max_relative_position_unmasked = 2 * max_relative_position - 1 if heads_share_relative_embedding: embedding_shape = (max_relative_position_unmasked, depth) else: embedding_shape = (num_heads, max_relative_position_unmasked, depth) relative_embeddings = tf.get_variable( name=name, shape=embedding_shape, initializer=tf.random_normal_initializer(stddev=initializer_stddev)) # Pad first before slice to avoid using tf.cond. pad_length = tf.maximum(length - max_relative_position, 0) slice_start_position = tf.maximum(max_relative_position-length, 0) if heads_share_relative_embedding: padded_relative_embeddings = tf.pad( relative_embeddings, [[pad_length, pad_length], [0, 0]]) used_relative_embeddings = tf.slice( padded_relative_embeddings, [slice_start_position, 0], [2 * length - 1, -1]) else: padded_relative_embeddings = tf.pad( relative_embeddings, [[0, 0], [pad_length, pad_length], [0, 0]]) used_relative_embeddings = tf.slice( padded_relative_embeddings, [0, slice_start_position, 0], [-1, 2 * length - 1, -1]) return used_relative_embeddings
[ "Instantiate or retrieve relative embeddings, sliced according to length.\n\n Use for unmasked case where the relative attention looks both left and right.\n\n Args:\n max_relative_position: an Integer for the number of entries in the relative\n embedding, which corresponds to the max relative distance that is\n considered.\n length: an Integer, specifies the length of the input sequence for which\n this relative embedding is retrieved for.\n depth: an Integer, specifies the depth for relative embeddings.\n num_heads: an Integer, specifies the number of heads.\n heads_share_relative_embedding: a Boolean specifying if the relative\n embedding is shared across heads.\n name: a string giving the name of the embedding variables.\n\n Returns:\n a Tensor with shape [length, depth]\n " ]
Please provide a description of the function:def dot_product_unmasked_self_attention_relative_v2( q, k, v, bias, max_relative_position=None, dropout_rate=0.0, image_shapes=None, name=None, make_image_summary=True, dropout_broadcast_dims=None, heads_share_relative_embedding=False, add_relative_to_values=False): if not max_relative_position: raise ValueError("Max relative position (%s) should be > 0 when using " "relative self attention." % (max_relative_position)) with tf.variable_scope( name, default_name="dot_product_unmasked_self_attention_relative_v2", values=[q, k, v]): # This calculation only works for self attention. # q, k and v must therefore have the same shape. q.get_shape().assert_is_compatible_with(k.get_shape()) q.get_shape().assert_is_compatible_with(v.get_shape()) # [batch, num_heads, query_length, memory_length] logits = tf.matmul(q, k, transpose_b=True) length = common_layers.shape_list(q)[2] k_shape = common_layers.shape_list(k) num_heads = k_shape[1] depth_k = k_shape[-1] key_relative_embeddings = get_relative_embeddings_left_right( max_relative_position, length, depth_k, num_heads, heads_share_relative_embedding, "key_relative_embeddings") unmasked_rel_logits = matmul_with_relative_keys( q, key_relative_embeddings, heads_share_relative_embedding) unmasked_rel_logits = _relative_position_to_absolute_position_unmasked( unmasked_rel_logits) logits += unmasked_rel_logits if bias is not None: logits += bias weights = tf.nn.softmax(logits, name="attention_weights") # dropping out the attention links for each of the heads weights = common_layers.dropout_with_broadcast_dims( weights, 1.0 - dropout_rate, broadcast_dims=dropout_broadcast_dims) # relative_weights.set_shape([None, None, None, max_length]) if common_layers.should_generate_summaries() and make_image_summary: attention_image_summary(weights, image_shapes) ret = tf.matmul(weights, v) if add_relative_to_values: # Adds the contribution of the weighted relative embeddings to the values. # [batch, num_heads, query_length, 2*memory_length-1] relative_weights = _absolute_position_to_relative_position_unmasked( weights) depth_v = common_layers.shape_list(v)[3] value_relative_embeddings = get_relative_embeddings_left_right( max_relative_position, length, depth_v, num_heads, heads_share_relative_embedding, "value_relative_embeddings") ret += matmul_with_relative_values( relative_weights, value_relative_embeddings, heads_share_relative_embedding) return ret
[ "Calculate relative position-aware dot-product self-attention.\n\n The attention calculation is augmented with learned representations for the\n relative position between each element in q and each element in k and v.\n\n Args:\n q: a Tensor with shape [batch, heads, length, depth].\n k: a Tensor with shape [batch, heads, length, depth].\n v: a Tensor with shape [batch, heads, length, depth].\n bias: bias Tensor.\n max_relative_position: an integer the max relative embedding considered.\n Changing this invalidates checkpoints.\n dropout_rate: a floating point number.\n image_shapes: optional tuple of integer scalars.\n name: an optional string.\n make_image_summary: Whether to make an attention image summary.\n dropout_broadcast_dims: an optional list of integers less than 4\n specifying in which dimensions to broadcast the dropout decisions.\n saves memory.\n heads_share_relative_embedding: a boolean indicating wheather to share\n relative embeddings between attention heads.\n add_relative_to_values: a boolean for whether to add relative component to\n values.\n\n Returns:\n A Tensor.\n\n Raises:\n ValueError: if max_relative_position is not > 0.\n " ]
Please provide a description of the function:def _matmul_with_relative_keys_2d(x, y, heads_share_relative_embedding): if heads_share_relative_embedding: ret = tf.einsum("bhxyd,md->bhxym", x, y) else: ret = tf.einsum("bhxyd,hmd->bhxym", x, y) return ret
[ "Helper function for dot_product_unmasked_self_attention_relative_2d." ]
Please provide a description of the function:def dot_product_unmasked_self_attention_relative_2d( q, k, v, bias, max_relative_position=None, dropout_rate=0.0, image_shapes=None, name=None, make_image_summary=True, dropout_broadcast_dims=None, heads_share_relative_embedding=False, add_relative_to_values=False): if not max_relative_position: raise ValueError("Max relative position (%s) should be > 0 when using " "relative self attention." % (max_relative_position)) if add_relative_to_values: raise ValueError("Adding relative embeddings to values is not implemented") with tf.variable_scope( name, default_name="dot_product_self_attention_relative_v2", values=[q, k, v]): # This calculation only works for self attention. # q, k and v must therefore have the same shape. q.get_shape().assert_is_compatible_with(k.get_shape()) q.get_shape()[:-1].assert_is_compatible_with(v.get_shape()[:-1]) (height, width) = (common_layers.shape_list(q)[2], common_layers.shape_list(q)[3]) k_shape = common_layers.shape_list(k) num_heads = k_shape[1] depth_k = k_shape[-1] depth_v = common_layers.shape_list(v)[-1] # flatten height width flatten_hw = lambda x, d: tf.reshape(x, [-1, num_heads, height*width, d]) # [batch, num_heads, query_length, memory_length] logits = tf.matmul(flatten_hw(q, depth_k), flatten_hw(k, depth_k), transpose_b=True) def _compute_2d_relative_logits( query, key_relative_embeddings, height, width, heads_share_relative_embedding, transpose_mask): unmasked_rel_logits = _matmul_with_relative_keys_2d( query, key_relative_embeddings, heads_share_relative_embedding) # collapse height and heads unmasked_rel_logits = tf.reshape(unmasked_rel_logits, [-1, num_heads*height, width, 2*width-1]) unmasked_rel_logits = ( _relative_position_to_absolute_position_unmasked( unmasked_rel_logits)) # shape it back for tiling unmasked_rel_logits = tf.reshape( unmasked_rel_logits, [-1, num_heads, height, width, width]) # tiling it height times unmasked_rel_logits = tf.expand_dims( unmasked_rel_logits, axis=3) unmasked_rel_logits = tf.tile(unmasked_rel_logits, [1, 1, 1, height, 1, 1]) # bringing it to the right shape for adding to the logits. unmasked_rel_logits = tf.transpose(unmasked_rel_logits, transpose_mask) unmasked_rel_logits = tf.reshape(unmasked_rel_logits, [-1, num_heads, height*width, height*width]) return unmasked_rel_logits # Relative logits in width dimension first. width_key_relative_embeddings = get_relative_embeddings_left_right( max_relative_position, width, depth_k, num_heads, heads_share_relative_embedding, "width_key_relative_embeddings") # [batch, heads, height, 2*width-1, 2*width-1] width_unmasked_rel_logits = _compute_2d_relative_logits( q, width_key_relative_embeddings, height, width, heads_share_relative_embedding, [0, 1, 2, 4, 3, 5]) logits += width_unmasked_rel_logits # Relative logits in height dimension next. For ease, we transpose # height and width and repeat the above steps, and transpose to eventually # put the logits in their right positions. # [batch, heads, height, 2*height-1, 2*width-1] height_key_relative_embeddings = get_relative_embeddings_left_right( max_relative_position, height, depth_k, num_heads, heads_share_relative_embedding, "height_key_relative_embeddings") height_unmasked_rel_logits = _compute_2d_relative_logits( tf.transpose(q, [0, 1, 3, 2, 4]), height_key_relative_embeddings, width, height, heads_share_relative_embedding, [0, 1, 4, 2, 5, 3]) logits += height_unmasked_rel_logits if bias is not None: logits += bias weights = tf.nn.softmax(logits, name="attention_weights") # dropping out the attention links for each of the heads weights = common_layers.dropout_with_broadcast_dims( weights, 1.0 - dropout_rate, broadcast_dims=dropout_broadcast_dims) if common_layers.should_generate_summaries() and make_image_summary: attention_image_summary(weights, image_shapes) ret = tf.matmul(weights, flatten_hw(v, depth_v)) # reshape back the same spatial dimensions as q return ( tf.reshape(ret, [-1, num_heads, height, width, depth_v]), height_key_relative_embeddings, width_key_relative_embeddings)
[ "Calculate relative position unmasked dot-product self-attention 2d.\n\n\n The attention calculation is augmented with learned representations for the\n relative position between each element in q and each element in k and v in\n height and width dimensions. for query index (i,j) and key index (l, m),\n the logit is q_i k_j^T + q_i rh_{l-i}^T + q_i rw_{m-j}^T, where rh and ry are\n the set of relative embeddings in height and width spatial dimensions,\n respectively.\n\n Args:\n q: a Tensor with shape [batch, heads, height, width, depth].\n k: a Tensor with shape [batch, heads, height, width, depth].\n v: a Tensor with shape [batch, heads, height, width, depth].\n bias: bias Tensor.\n max_relative_position: an integer the max relative embedding considered.\n Changing this invalidates checkpoints.\n dropout_rate: a floating point number.\n image_shapes: optional tuple of integer scalars.\n name: an optional string.\n make_image_summary: Whether to make an attention image summary.\n dropout_broadcast_dims: an optional list of integers less than 4\n specifying in which dimensions to broadcast the dropout decisions.\n saves memory.\n heads_share_relative_embedding: a boolean indicating wheather to share\n relative embeddings between attention heads.\n add_relative_to_values: a boolean for adding relative embeddings to values.\n\n Returns:\n [batch, heads, height, width, depth] tensor, the output of attention.\n height_key_relative_embeddings: a 3d or 2d tensor, depending on head sharing\n settings, which are the relative embeddings for height.\n width_key_relative_embeddings: a 3d or 2d tensor, depending on head sharing\n settings, which are the relative embeddings for width.\n\n Raises:\n ValueError: if max_relative_position is not > 0.\n ", "compute relative logits." ]
Please provide a description of the function:def _split_along_width(x_left_right_blocks): (_, x_num_h_blocks, x_num_outer_w_blocks, x_memory_flange_h, x_memory_flange_w, depth) = common_layers.shape_list(x_left_right_blocks) x_num_w_blocks = (x_num_outer_w_blocks-1)//2 # get it ready for splitting the left and right memory blocks x_left_right_blocks = tf.reshape(x_left_right_blocks, [-1, x_num_h_blocks, x_num_outer_w_blocks//2, 2, x_memory_flange_h, x_memory_flange_w, depth]) x_left_blocks, x_right_blocks = tf.split(x_left_right_blocks, num_or_size_splits=2, axis=3) x_left_blocks = tf.squeeze(x_left_blocks, axis=3) x_right_blocks = tf.squeeze(x_right_blocks, axis=3) x_left_blocks = tf.slice(x_left_blocks, [0, 0, 0, 0, 0, 0], [-1, -1, x_num_w_blocks, -1, -1, -1]) x_right_blocks = tf.slice(x_right_blocks, [0, 0, 1, 0, 0, 0], [-1, -1, x_num_w_blocks, -1, -1, -1]) return x_left_blocks, x_right_blocks
[ "Helper function for local 2d attention.\n\n Takes a tensor of [batch, heads, num_h_blocks, num_w_blocks,\n height, width, depth] and returns two tensors which contain every alternate\n position along the width\n\n\n Args:\n x_left_right_blocks: A [batch, num_h_blocks, num_w_blocks,\n height, width, depth] tensor\n\n Returns:\n x_left_blocks, x_right_blocks: two [batch, num_h_blocks,\n (num_w_blocks-2)/2, height, width,\n depth] tensors\n\n " ]
Please provide a description of the function:def _get_left_right_blocks(x): (_, x_num_outer_h_blocks, x_num_outer_w_blocks, x_memory_flange_h, x_memory_flange_w, depth) = common_layers.shape_list(x) x_left_right_blocks = tf.slice(x, [0, 1, 0, 0, 0, 0], [-1, x_num_outer_h_blocks-2, -1, -1, -1, -1]) num_blocks_h = (x_num_outer_h_blocks-2)//2 x_left_right_blocks = tf.reshape(x_left_right_blocks, [-1, num_blocks_h, 2, x_num_outer_w_blocks, x_memory_flange_h, x_memory_flange_w, depth]) x_left_right_blocks = tf.transpose(x_left_right_blocks, [0, 1, 3, 2, 4, 5, 6]) x_left_right_blocks = tf.reshape(x_left_right_blocks, [-1, num_blocks_h, x_num_outer_w_blocks, 2*x_memory_flange_h, x_memory_flange_w, depth]) # get it ready for splitting the left and right memory blocks x_left_blocks, x_right_blocks = _split_along_width(x_left_right_blocks) return x_left_blocks, x_right_blocks
[ "Helper function. Assumes that memory_flange is half of query sizes.\n\n This function splits the tensor of width 'n' into two halves, where the\n first half gets the width indices 0, 2, 4.. and the second half gets the\n width indices 3, 5, ... We also fuse two blocks along the h dimension.\n\n Args:\n x: a 6-d tensor.\n\n Returns:\n x_left_blocks, x_right_blocks: Two 6-d tensors\n " ]
Please provide a description of the function:def _extract_blocks(x, block_h, block_w): (_, height, width, depth) = common_layers.shape_list(x) assert height % block_h == 0 assert width % block_w == 0 x = tf.reshape(x, [-1, height//block_h, block_h, width//block_w, block_w, depth]) return tf.transpose(x, [0, 1, 3, 2, 4, 5])
[ "Helper function for local 2d attention.\n\n Args:\n x: a [batch, height, width, depth] tensor\n block_h: An integer. block height\n block_w: An inteter. block width\n\n returns:\n a [batch, num_heads, height/block_h, width/block_w, depth] tensor\n " ]
Please provide a description of the function:def get_2d_local_memory(x, query_shape, memory_flange): (_, height, width, depth_x) = common_layers.shape_list(x) x_center_blocks = _extract_blocks(x, query_shape[0], query_shape[1]) # add extra padding to x so that we can extract the memory region # around the center paddings = [[0, 0], [memory_flange[0], memory_flange[0]], [memory_flange[1], memory_flange[1]], [0, 0]] padded_x = tf.pad(x, paddings) padded_x.set_shape([None, height+2*memory_flange[0], width+2*memory_flange[1], depth_x]) x_outer_memory_blocks = _extract_blocks(padded_x, memory_flange[0], memory_flange[1]) # We'll extract left and right memory blocks, top and bottom memory blocks, # and then the corner memory blocks # Each of these after will have shape # [batch, num_h_blocks, num_w_blocks, query_shape[0], # memory_flange[1], depth] x_left_blocks, x_right_blocks = _get_left_right_blocks( x_outer_memory_blocks) t_hw_block = lambda x: tf.transpose(x, [0, 2, 1, 4, 3, 5]) # now to get top and bottom blocks, we should just transpose the outer # blocks, call the same function and transpose back to get shape # [batch, num_h_blocks, num_w_blocks, memory_flange[0], # query_shape[1], depth] x_top_center_blocks, x_bottom_center_blocks = ( map(t_hw_block, _get_left_right_blocks( t_hw_block(x_outer_memory_blocks)))) # now to get the corner blocks x_left_corner_blocks, x_right_corner_blocks = _split_along_width( x_outer_memory_blocks) # now to extract top and bottom for both k and v # we need to transpose because _split_along_width separates along # the width # each of these should have shape [batch, num_h_blocks, # num_w_blocks, memory_flange[0], memory_flange[1], depth] t_hw = lambda x: tf.transpose(x, [0, 2, 1, 3, 4, 5]) x_top_left_corner_blocks, x_bottom_left_corner_blocks = ( map(t_hw, _split_along_width(t_hw(x_left_corner_blocks)))) x_top_right_corner_blocks, x_bottom_right_corner_blocks = ( map(t_hw, _split_along_width(t_hw(x_right_corner_blocks)))) # The memory is top_left top_center top_right # left_center middle right_center # bottom_left bottom_center bottom_right # Assembling the above row by row # first [x_top_left, x_top, x_top_right] # to get [batch, num_h_blocks, num_w_blocks, memory_flange[0], # query_shape[1]+2*memory_flange[1], depth] # then [x_left, x_center, x_right] # then [x_bottom_left, x_bottom, x_bottom_right] x_top_memory = tf.concat( [x_top_left_corner_blocks, x_top_center_blocks, x_top_right_corner_blocks], axis=4) x_middle_memory = tf.concat( [x_left_blocks, x_center_blocks, x_right_blocks], axis=4) x_bottom_memory = tf.concat( [x_bottom_left_corner_blocks, x_bottom_center_blocks, x_bottom_right_corner_blocks], axis=4) # concat along height x = tf.concat([x_top_memory, x_middle_memory, x_bottom_memory], axis=3) return x
[ "Stitches together the local 2d memory blocks.\n\n Args:\n x: a [batch, height, width, depth tensor]\n query_shape: 2-d integer list of query shape\n memory_flange: 2-d integer list of memory flanges\n\n Returns:\n x: A [batch, num_h_blocks, num_w_blocks,\n query_shape[0]+2*memory_flange[0],query_shape[1]+2*memory_flange[1]]\n tensor.\n " ]
Please provide a description of the function:def get_2d_local_memory_v2(x, query_shape, memory_flange): (_, height, width, depth_x) = common_layers.shape_list(x) # add extra padding to x so that we can extract the memory region # around the center paddings = [[0, 0], [memory_flange[0], memory_flange[0]], [memory_flange[1], memory_flange[1]], [0, 0]] padded_x = tf.pad(x, paddings) padded_x.set_shape([None, height+2*memory_flange[0], width+2*memory_flange[1], depth_x]) num_h_memory_blocks = height//query_shape[0] + 1 num_w_memory_blocks = width//query_shape[1] + 1 x_memory_blocks = _extract_blocks(padded_x, query_shape[0], query_shape[1]) x_width_blocks = tf.split(x_memory_blocks, num_w_memory_blocks, 2) x_left_width = tf.concat(x_width_blocks[:num_w_memory_blocks - 1], axis=2) x_right_width = tf.concat(x_width_blocks[1:], axis=2) x_memory_blocks = tf.concat([x_left_width, x_right_width], axis=4) x_height_blocks = tf.split(x_memory_blocks, num_h_memory_blocks, 1) x_top_height = tf.concat(x_height_blocks[:num_h_memory_blocks - 1], axis=1) x_bottom_height = tf.concat(x_height_blocks[1:], axis=1) x = tf.concat([x_top_height, x_bottom_height], axis=3) return x
[ "Gathering memory blocks around query blocks. flange is half of query .\n\n Only works if memory flanges are half of query sizes.\n\n Args:\n x: a [batch, height, width, depth tensor]\n query_shape: 2-d integer list of query shape\n memory_flange: 2-d integer list of memory flanges\n\n Returns:\n x: A [batch, num_h_blocks, num_w_blocks,\n query_shape[0]+2*memory_flange[0],query_shape[1]+2*memory_flange[1]]\n tensor.\n " ]
Please provide a description of the function:def dot_product_unmasked_attention_local_2d_tpu( q, k, v, bias, max_relative_position=None, query_shape=(8, 8), dropout_rate=0.0, image_shapes=None, name=None, make_image_summary=False, dropout_broadcast_dims=None): if max_relative_position: raise ValueError("Relative local 2d attention not implemented") with tf.variable_scope( name, default_name="dot_product_unmasked_attention_local_2d_tpu", values=[q, k, v]): # This calculation only works for self attention. # q, k and v must therefore have the same shape. q.get_shape().assert_is_compatible_with(k.get_shape()) q.get_shape().assert_is_compatible_with(v.get_shape()) orig_q_shape = common_layers.shape_list(q) # Pad query, key, value to ensure multiple of corresponding lengths. memory_flange = [int(query_shape[0]//2), int(query_shape[1]//2)] q = pad_to_multiple_2d(q, query_shape) k = pad_to_multiple_2d(k, query_shape) v = pad_to_multiple_2d(v, query_shape) q_shape = common_layers.shape_list(q) (height, width) = (q_shape[2], q_shape[3]) _, num_heads, height, width, depth_k = common_layers.shape_list(k) depth_v = common_layers.shape_list(v)[-1] num_h_blocks = height//query_shape[0] num_w_blocks = width//query_shape[1] # Extract center queries, keys, and values q = tf.reshape(q, [-1, height, width, depth_k]) queries = _extract_blocks( q, query_shape[0], query_shape[1]) k = tf.reshape(k, [-1, height, width, depth_k]) keys = get_2d_local_memory_v2( k, query_shape, memory_flange) v = tf.reshape(v, [-1, height, width, depth_v]) values = get_2d_local_memory_v2( v, query_shape, memory_flange) memory_h = query_shape[0] + 2*memory_flange[0] memory_w = query_shape[1] + 2*memory_flange[1] queries = tf.reshape(queries, [-1, num_heads, num_h_blocks, num_w_blocks, query_shape[0]*query_shape[1], depth_k]) keys = tf.reshape(keys, [-1, num_heads, num_h_blocks, num_w_blocks, memory_h*memory_w, depth_k]) values = tf.reshape(values, [-1, num_heads, num_h_blocks, num_w_blocks, memory_h*memory_w, depth_v]) logits = tf.matmul(queries, keys, transpose_b=True) if bias is not None: logits += bias weights = tf.nn.softmax(logits, name="attention_weights") # Dropping out the attention links for each of the heads weights = common_layers.dropout_with_broadcast_dims( weights, 1.0 - dropout_rate, broadcast_dims=dropout_broadcast_dims) if common_layers.should_generate_summaries() and make_image_summary: attention_image_summary(weights, image_shapes) ret = tf.matmul(weights, values) # we need to get it back to shape [batch, heads, height, width] ret = tf.reshape(ret, [-1, num_heads, num_h_blocks, num_w_blocks, query_shape[0], query_shape[1], depth_v]) ret = tf.transpose(ret, [0, 1, 2, 4, 3, 5, 6]) ret = tf.reshape(ret, [-1, num_heads, num_h_blocks*query_shape[0], num_w_blocks*query_shape[1], depth_v]) # slice if padding was introduced ret = tf.slice(ret, [0, 0, 0, 0, 0], [-1, -1, orig_q_shape[2], orig_q_shape[3], -1]) return ret
[ "Calculate unmasked dot-product local self-attention 2d on tpu.\n\n Args:\n q: a Tensor with shape [batch, heads, height, width, depth].\n k: a Tensor with shape [batch, heads, height, width, depth].\n v: a Tensor with shape [batch, heads, height, width, depth].\n bias: bias Tensor.\n max_relative_position: an integer the max relative embedding considered.\n Changing this invalidates checkpoints.\n query_shape: a two tuple indicating query shape\n dropout_rate: a floating point number.\n image_shapes: optional tuple of integer scalars.\n name: an optional string.\n make_image_summary: Whether to make an attention image summary.\n dropout_broadcast_dims: an optional list of integers less than 4\n specifying in which dimensions to broadcast the dropout decisions.\n saves memory.\n\n Returns:\n [batch, heads, height, width, depth] tensor, the output of attention.\n\n " ]
Please provide a description of the function:def dot_product_unmasked_attention_local_2d_tpu_simple( x, bias, total_key_depth, total_value_depth, num_heads, query_shape=(8, 8), dropout_rate=0.0, image_shapes=None, make_image_summary=False, dropout_broadcast_dims=None): # This calculation only works for self attention. # q, k and v must therefore have the same shape. orig_x_shape = common_layers.shape_list(x) # Pad query, key, value to ensure multiple of corresponding lengths if # necessary is_padded = False if (orig_x_shape[1]%query_shape[0]) != 0 or ( orig_x_shape[2]%query_shape[1]) != 0: x = pad_to_multiple_2d(x, query_shape) is_padded = True _, height, width, depth = common_layers.shape_list(x) assert depth%num_heads == 0 num_h_blocks = height//query_shape[0] num_w_blocks = width//query_shape[1] # Extract center queries, keys, and values x_blocks = _extract_blocks(x, query_shape[0], query_shape[1]) x_blocks = tf.reshape(x_blocks, [-1, query_shape[0]*query_shape[1], depth]) q, k, v = compute_qkv(x_blocks, None, total_key_depth, total_value_depth) hsplit = lambda x: split_heads(x, num_heads) q, k, v = map(hsplit, [q, k, v]) logits = tf.matmul(q, k, transpose_b=True) if bias is not None: logits += bias weights = tf.nn.softmax(logits, name="attention_weights") # Dropping out the attention links for each of the heads weights = common_layers.dropout_with_broadcast_dims( weights, 1.0 - dropout_rate, broadcast_dims=dropout_broadcast_dims) if common_layers.should_generate_summaries() and make_image_summary: attention_image_summary(weights, image_shapes) output = tf.matmul(weights, v) output = combine_heads(output) # we need to get it back to shape [batch, height, width] ret = tf.reshape(output, [-1, num_h_blocks, num_w_blocks, query_shape[0], query_shape[1], total_value_depth]) ret = tf.transpose(ret, [0, 1, 3, 2, 4, 5]) ret = tf.reshape(ret, [-1, num_h_blocks*query_shape[0], num_w_blocks*query_shape[1], total_value_depth]) # slice if padding was introduced if is_padded: ret = tf.slice(ret, [0, 0, 0, 0], [-1, orig_x_shape[1], orig_x_shape[2], -1]) return ret, q, k, v
[ "Calculate simple unmasked dot-product local self-attention 2d on tpu.\n\n The query, key, and value blocks are the same. We do not do a second linear\n transformation after computing the values\n\n Args:\n x: a Tensor with shape [batch, height, width, depth].\n bias: bias Tensor.\n total_key_depth: the dimensions of the keys\n total_value_depth: the dimensions of the values\n num_heads: number of heads\n query_shape: a two tuple indicating query shape\n dropout_rate: a floating point number.\n image_shapes: optional tuple of integer scalars.\n make_image_summary: Whether to make an attention image summary.\n dropout_broadcast_dims: an optional list of integers less than 4\n specifying in which dimensions to broadcast the dropout decisions.\n saves memory.\n\n Returns:\n ret: [batch, height, width, total_value_depth] tensor,\n the output of attention.\n q: [batch, height, width, total_key_depth] query tensor\n k: [batch, height, width, total_key_depth] key tensor\n v: [batch, height, width, total_value_depth] value tensor\n\n " ]
Please provide a description of the function:def masked_within_block_local_attention_1d(q, k, v, block_length=64, name=None): with tf.variable_scope( name, default_name="within_local_attention_1d", values=[q, k, v]): batch, heads, length, depth_k = common_layers.shape_list(q) depth_v = common_layers.shape_list(v)[-1] if isinstance(block_length, tf.Tensor): const = tf.contrib.util.constant_value(block_length) if const is not None: block_length = int(const) # Pad query, key, value to ensure multiple of block length. original_length = length padding_size = tf.mod(-length, block_length) length += padding_size padding = [[0, 0], [0, 0], [0, padding_size], [0, 0]] q = tf.pad(q, padding) k = tf.pad(k, padding) v = tf.pad(v, padding) # Compute attention for all subsequent query blocks. num_blocks = tf.div(length, block_length) q = tf.reshape(q, [batch, heads, num_blocks, block_length, depth_k]) k = tf.reshape(k, [batch, heads, num_blocks, block_length, depth_k]) v = tf.reshape(v, [batch, heads, num_blocks, block_length, depth_v]) # [batch, heads, num_blocks, block_length, block_length] attention = tf.matmul(q, k, transpose_b=True) attention += tf.reshape(attention_bias_lower_triangle(block_length), [1, 1, 1, block_length, block_length]) attention = tf.nn.softmax(attention) # [batch, heads, num_blocks, block_length, depth_v] output = tf.matmul(attention, v) output = tf.reshape(output, [batch, heads, -1, depth_v]) # Remove the padding if introduced. output = tf.slice(output, [0, 0, 0, 0], [-1, -1, original_length, -1]) output.set_shape([None if isinstance(dim, tf.Tensor) else dim for dim in (batch, heads, length, depth_v)]) return output
[ "Attention to the source and a neighborhood to the left within a block.\n\n The sequence is divided into blocks of length block_length. Attention for a\n given query position can only see memory positions less than or equal to the\n query position in the corresponding block.\n\n Args:\n q: a Tensor with shape [batch, heads, length, depth_k]\n k: a Tensor with shape [batch, heads, length, depth_k]\n v: a Tensor with shape [batch, heads, length, depth_v]\n block_length: an integer\n name: an optional string\n\n Returns:\n a Tensor of shape [batch, heads, length, depth_v]\n " ]
Please provide a description of the function:def _relative_position_to_absolute_position_unmasked(x): x_shape = common_layers.shape_list(x) batch = x_shape[0] heads = x_shape[1] length = x_shape[2] # Concat columns of pad to shift from relative to absolute indexing. col_pad = tf.zeros((batch, heads, length, 1)) x = tf.concat([x, col_pad], axis=3) # Concat extra elements so to add up to shape (len+1, 2*len-1). flat_x = tf.reshape(x, [batch, heads, length * 2 * length]) flat_pad = tf.zeros((batch, heads, length-1)) flat_x_padded = tf.concat([flat_x, flat_pad], axis=2) # Reshape and slice out the padded elements. final_x = tf.reshape(flat_x_padded, [batch, heads, length+1, 2*length-1]) final_x = final_x[:, :, :, length-1:] final_x = final_x[:, :, :length, :] return final_x
[ "Converts tensor from relative to aboslute indexing for local attention.\n\n Args:\n x: a Tensor of shape [batch (or batch*num_blocks), heads,\n length, 2 * length - 1]\n\n Returns:\n A Tensor of shape [batch (or batch*num_blocks), heads, length, length-1]\n " ]
Please provide a description of the function:def masked_local_attention_1d(q, k, v, block_length=128, make_image_summary=False, dropout_rate=0., name=None): with tf.variable_scope( name, default_name="local_attention_1d", values=[q, k, v]): batch, heads, length, depth_k = common_layers.shape_list(q) depth_v = common_layers.shape_list(v)[-1] if isinstance(block_length, tf.Tensor): const = tf.contrib.util.constant_value(block_length) if const is not None: block_length = int(const) # If (length < 2 * block_length), then we use only one block. if isinstance(length, int) and isinstance(block_length, int): block_length = length if length < block_length * 2 else block_length else: block_length = tf.where( tf.less(length, block_length * 2), length, block_length) # Pad query, key, value to ensure multiple of block length. original_length = length padding_size = tf.mod(-length, block_length) length += padding_size padding = [[0, 0], [0, 0], [0, padding_size], [0, 0]] q = tf.pad(q, padding) k = tf.pad(k, padding) v = tf.pad(v, padding) if isinstance(length, int) and isinstance(block_length, int): num_blocks = length // block_length else: num_blocks = tf.div(length, block_length) # Compute attention for the first query block. first_q = tf.slice(q, [0, 0, 0, 0], [-1, -1, block_length, -1]) first_k = tf.slice(k, [0, 0, 0, 0], [-1, -1, block_length, -1]) first_v = tf.slice(v, [0, 0, 0, 0], [-1, -1, block_length, -1]) first_output = dot_product_attention( first_q, first_k, first_v, attention_bias_lower_triangle(block_length), dropout_rate=dropout_rate, make_image_summary=make_image_summary, name="first_block") # Compute attention for all subsequent query blocks. q = tf.reshape(q, [batch, heads, num_blocks, block_length, depth_k]) k = tf.reshape(k, [batch, heads, num_blocks, block_length, depth_k]) v = tf.reshape(v, [batch, heads, num_blocks, block_length, depth_v]) local_k = _make_local_block(k, depth_k, batch, heads, num_blocks, block_length) local_v = _make_local_block(v, depth_v, batch, heads, num_blocks, block_length) tail_q = tf.slice(q, [0, 0, 1, 0, 0], [-1, -1, -1, -1, -1]) tail_q = tf.reshape(tail_q, [batch, heads, num_blocks - 1, block_length, depth_k]) local_length = common_layers.shape_list(local_k)[3] # make sure source_pos <= target_pos good_part = common_layers.ones_matrix_band_part( block_length, local_length, -1, block_length, out_shape=[1, 1, 1, block_length, local_length]) bias = (1.0 - good_part) * -1e9 # TODO(noam): figure out how to show a summary for the remaining blocks. # The naive way currently causes errors due to empty tensors. # output: [batch, heads, num_blocks-1, block_length, depth_v] tail_output = dot_product_attention( tail_q, local_k, local_v, bias, dropout_rate=dropout_rate, make_image_summary=False, name="tail_block") tail_output = tf.reshape( tail_output, [batch, heads, (num_blocks - 1) * block_length, depth_v]) output = tf.concat([first_output, tail_output], axis=2) # Remove the padding if introduced. output = tf.slice(output, [0, 0, 0, 0], [-1, -1, original_length, -1]) output = tf.reshape(output, [batch, heads, original_length, depth_v]) return output
[ "Attention to the source position and a neighborhood to the left of it.\n\n The sequence is divided into blocks of length block_length. Attention for a\n given query position can only see memory positions less than or equal to the\n query position, in the corresponding block and the previous block.\n\n Args:\n q: a Tensor with shape [batch, heads, length, depth_k]\n k: a Tensor with shape [batch, heads, length, depth_k]\n v: a Tensor with shape [batch, heads, length, depth_v]\n block_length: an integer\n make_image_summary: a boolean, whether to make an attention image summary.\n dropout_rate: Dropout rate for attention dropout\n name: an optional string\n\n Returns:\n a Tensor of shape [batch, heads, length, depth_v]\n " ]
Please provide a description of the function:def _make_local_block(x, depth, batch, heads, num_blocks, block_length): prev_block = tf.slice(x, [0, 0, 0, 0, 0], [-1, -1, num_blocks - 1, -1, -1]) cur_block = tf.slice(x, [0, 0, 1, 0, 0], [-1, -1, -1, -1, -1]) local_block = tf.concat([prev_block, cur_block], 3) return tf.reshape(local_block, [batch, heads, num_blocks - 1, block_length * 2, depth])
[ "Helper function to create a local version of the keys or values for 1d." ]
Please provide a description of the function:def masked_relative_local_attention_1d(q, k, v, block_length=128, make_image_summary=False, dropout_rate=0., heads_share_relative_embedding=False, add_relative_to_values=False, name=None): if not name: raise ValueError("Name must be assigned since reuse for variable scope is " "set to tf.AUTO_REUSE, in order to reuse relative " "embeddings of keys and values.") # Reuse flag is set to auto_reuse to reuse relative embeddings of keys and # values across blocks (first and tail blocks). with tf.variable_scope( name, default_name="masked_relative_local_attention_1d", values=[q, k, v], reuse=tf.AUTO_REUSE): default_block_length = block_length batch = common_layers.shape_list(q)[0] heads = common_layers.shape_list(q)[1] length = common_layers.shape_list(q)[2] # If (length < 2 * block_length), then we use only one block. if isinstance(length, int) and isinstance(block_length, int): block_length = length if length < block_length * 2 else block_length else: block_length = tf.where( tf.less(length, block_length * 2), length, block_length) depth_k = common_layers.shape_list(k)[3] depth_v = common_layers.shape_list(v)[3] original_length = length padding_size = tf.mod(-length, block_length) length += padding_size padding = [[0, 0], [0, 0], [0, padding_size], [0, 0]] q = tf.pad(q, padding) k = tf.pad(k, padding) v = tf.pad(v, padding) num_blocks = length // block_length # compute attention for the first query block. first_q = tf.slice(q, [0, 0, 0, 0], [-1, -1, block_length, -1]) first_k = tf.slice(k, [0, 0, 0, 0], [-1, -1, block_length, -1]) first_v = tf.slice(v, [0, 0, 0, 0], [-1, -1, block_length, -1]) # Relative embeddings will be used later as well. # TODO(avaswani,annahuang): check why 2*bl was breaking for music # Needs to be known at static shape inference time, hence cannot be # 2 * block_length. rel_embed_length = 4 * default_block_length # We only multiply with the needed embeddings as we slice them out. first_rel_embeddings = get_relative_embeddings_left( rel_embed_length, block_length, depth_k, heads, heads_share_relative_embedding, "relative_embeddings") first_rel_logits = matmul_with_relative_keys( first_q, first_rel_embeddings, heads_share_relative_embedding) first_logits = tf.matmul(first_q, first_k, transpose_b=True) first_logits += ( _relative_position_to_absolute_position_masked(first_rel_logits)) # adding a mask first_logits += ( common_layers.cast_like(attention_bias_lower_triangle(block_length), first_logits)) first_att = tf.nn.softmax(first_logits, name="first_attention_weights") # dropping out the attention links for each of the heads first_att = common_layers.dropout_with_broadcast_dims( first_att, 1.0 - dropout_rate, broadcast_dims=None) # only call image summary for the first block if common_layers.should_generate_summaries() and make_image_summary: attention_image_summary(first_att, None) first_output = tf.matmul(first_att, first_v) # compute attention for all subsequent query blocks. q = tf.reshape(q, [batch, heads, num_blocks, block_length, depth_k]) k = tf.reshape(k, [batch, heads, num_blocks, block_length, depth_k]) v = tf.reshape(v, [batch, heads, num_blocks, block_length, depth_v]) local_k = _make_local_block(k, depth_k, batch, heads, num_blocks, block_length) local_v = _make_local_block(v, depth_v, batch, heads, num_blocks, block_length) tail_q = tf.slice(q, [0, 0, 1, 0, 0], [-1, -1, -1, -1, -1]) tail_q = tf.reshape(tail_q, [batch, heads, num_blocks - 1, block_length, depth_k]) local_length = common_layers.shape_list(local_k)[3] # collapsing num blocks and batch size so that we can reuse # functions def _reshape_for_relative(x): x_shape = common_layers.shape_list(x) # [batch, num_blocks, heads, length, depth] x = tf.transpose(x, [0, 2, 1, 3, 4]) x = tf.reshape(x, [batch*x_shape[2], heads, x_shape[3], x_shape[4]]) return x rel_tail_q = _reshape_for_relative(tail_q) rel_k = _reshape_for_relative(local_k) rel_v = _reshape_for_relative(local_v) rel_embeddings = get_relative_embeddings_left( rel_embed_length, 2 * block_length, depth_k, heads, heads_share_relative_embedding, "relative_embeddings") rel_logits = matmul_with_relative_keys( rel_tail_q, rel_embeddings, heads_share_relative_embedding) # Computing relative logits separately for the masked and unmasked parts # because the reshaping logic is different for both masked_rel_logits = tf.slice(rel_logits, [0, 0, 0, block_length], [-1, -1, -1, -1]) masked_rel_logits = _relative_position_to_absolute_position_masked( masked_rel_logits) unmasked_rel_logits = tf.slice(rel_logits, [0, 0, 0, 0], [-1, -1, -1, 2*block_length-1]) unmasked_rel_logits = _relative_position_to_absolute_position_unmasked( unmasked_rel_logits) all_rel_logits = tf.concat([unmasked_rel_logits, masked_rel_logits], axis=3) all_logits = ( tf.matmul(rel_tail_q, rel_k, transpose_b=True) + all_rel_logits) # make sure source_pos <= target_pos good_part = common_layers.ones_matrix_band_part(block_length, local_length, -1, block_length) mask = (1.0 - good_part) * -1e9 mask = common_layers.cast_like(mask, all_logits) all_logits += tf.reshape(mask, [1, 1, block_length, local_length]) weights = tf.nn.softmax(all_logits, name="attention_weights") # [batch (* num_blocks), heads, query_length (=block_length), # key_length (=2*block_length)] weights = common_layers.dropout_with_broadcast_dims( weights, 1.0 - dropout_rate, broadcast_dims=None) output = tf.matmul(weights, rel_v) if add_relative_to_values: # Adds the contribution of the weighted relative embeddings to the values. weights_for_unmasked, weights_for_masked = ( tf.split(weights, 2, axis=3)) rel_weights_unmasked = _absolute_position_to_relative_position_unmasked( weights_for_unmasked) rel_weights_masked = _absolute_position_to_relative_position_masked( weights_for_masked) value_rel_embeddings_unmasked = get_relative_embeddings_left( rel_embed_length, 2 * block_length, depth_v, heads, heads_share_relative_embedding, "value_relative_embeddings") # The unmasked part starts with index -1 as opposed 0 has take uptil last. if heads_share_relative_embedding: value_rel_embeddings_unmasked = value_rel_embeddings_unmasked[:-1, :] else: value_rel_embeddings_unmasked = value_rel_embeddings_unmasked[:, :-1, :] value_rel_embeddings_masked = get_relative_embeddings_left( rel_embed_length, block_length, depth_v, heads, heads_share_relative_embedding, "value_relative_embeddings") # [batch (*num_blocks), heads, query length, key length] rel_weights = tf.concat( [rel_weights_unmasked, rel_weights_masked], axis=3) if heads_share_relative_embedding: value_rel_embeddings_concat_axis = 0 else: value_rel_embeddings_concat_axis = 1 value_rel_embeddings = tf.concat( [value_rel_embeddings_unmasked, value_rel_embeddings_masked], axis=value_rel_embeddings_concat_axis) output_rel = matmul_with_relative_values( rel_weights, value_rel_embeddings, heads_share_relative_embedding) output += output_rel # bring to [batch, heads, num_blocks-1, block_length, depth] output = tf.reshape(output, [batch, num_blocks-1, heads, block_length, depth_v]) output = tf.transpose(output, [0, 2, 1, 3, 4]) output = tf.reshape( output, [batch, heads, (num_blocks - 1) * block_length, depth_v]) output = tf.concat([first_output, output], axis=2) output = tf.slice(output, [0, 0, 0, 0], [-1, -1, original_length, -1]) output = tf.reshape(output, [batch, heads, original_length, depth_v]) return output
[ "Masked local 1d attention with relative positions.\n\n The sequence is divided into blocks of length block_size.\n Attention for a given query position can only see memory positions\n less than or equal to the query position, in the corresponding block\n and the previous block.\n\n If mask_right is True, then a target position cannot see greater source\n positions.\n\n Args:\n q: a Tensor with shape [batch, heads, length, depth_k]\n k: a Tensor with shape [batch, heads, length, depth_k]\n v: a Tensor with shape [batch, heads, length, depth_v]\n block_length: an integer\n make_image_summary: a boolean, whether to make an attention image summary.\n dropout_rate: Dropout rate for attention dropout\n heads_share_relative_embedding: a boolean for sharing relative embeddings.\n add_relative_to_values: a boolean for whether to add relative component to\n values.\n name: an optional string\n\n Returns:\n a Tensor of shape [batch, heads, length, depth_v]\n\n Raises:\n ValueError: wwhen the name for the variable scope is not passed.\n " ]
Please provide a description of the function:def local_attention_1d(q, k, v, block_length=128, filter_width=100, name=None): with tf.variable_scope( name, default_name="local_self_attention_1d", values=[q, k, v]): # Check that q, k, v have the same shape except in their depth dimension. q.get_shape()[:-1].assert_is_compatible_with(k.get_shape()[:-1]) q.get_shape()[:-1].assert_is_compatible_with(v.get_shape()[:-1]) batch_size, num_heads, original_length, _ = common_layers.shape_list(q) # Pad query, key, value to ensure multiple of corresponding lengths. def pad_to_multiple(x, pad_length): x_length = common_layers.shape_list(x)[2] return tf.pad(x, [[0, 0], [0, 0], [0, -x_length % pad_length], [0, 0]]) def pad_l_and_r(x, pad_length): return tf.pad(x, [[0, 0], [0, 0], [pad_length, pad_length], [0, 0]]) # Set up query blocks. # [batch, heads, blocks_q, block_length, depth_k] q = pad_to_multiple(q, block_length) q = reshape_by_blocks(q, common_layers.shape_list(q), block_length) total_query_blocks = common_layers.shape_list(q)[2] # Set up key and value blocks. # [batch, heads, blocks_k, block_length, depth_k] blocks_per_filter_width = filter_width // block_length remaining_items = filter_width % block_length k = pad_to_multiple(k, block_length) v = pad_to_multiple(v, block_length) k = pad_l_and_r(k, filter_width + block_length - remaining_items) v = pad_l_and_r(v, filter_width + block_length - remaining_items) k = reshape_by_blocks(k, common_layers.shape_list(k), block_length) v = reshape_by_blocks(v, common_layers.shape_list(v), block_length) total_kv_blocks = common_layers.shape_list(k)[2] slices = [] # prepare the left-most and right-most partial blocks if needed if remaining_items: first_partial_block_k = tf.slice( k, [0, 0, 0, block_length - remaining_items, 0], [-1, -1, total_query_blocks, -1, -1]) first_partial_block_v = tf.slice( v, [0, 0, 0, block_length - remaining_items, 0], [-1, -1, total_query_blocks, -1, -1]) last_partial_block_k = tf.slice( k, [0, 0, total_kv_blocks - total_query_blocks, 0, 0], [-1, -1, -1, remaining_items, -1]) last_partial_block_v = tf.slice( v, [0, 0, total_kv_blocks - total_query_blocks, 0, 0], [-1, -1, -1, remaining_items, -1]) slices.append((first_partial_block_k, first_partial_block_v)) slices.append((last_partial_block_k, last_partial_block_v)) # Prepare the rest of the blocks first_block_index = 1 if remaining_items else 0 attention_blocks = 2 * blocks_per_filter_width + 1 for i in range(first_block_index, attention_blocks + first_block_index): block_k = tf.slice(k, [0, 0, i, 0, 0], [-1, -1, total_query_blocks, -1, -1]) block_v = tf.slice(v, [0, 0, i, 0, 0], [-1, -1, total_query_blocks, -1, -1]) slices.append((block_k, block_v)) # [batch, heads, blocks_q, block_length + 2 * filter_width, depth_k] k = tf.concat([s[0] for s in slices], axis=3) v = tf.concat([s[1] for s in slices], axis=3) attention_bias = tf.expand_dims(embedding_to_padding(k) * -1e9, axis=-2) depth_v = common_layers.shape_list(v)[-1] output = dot_product_attention( q, k, v, attention_bias, dropout_rate=0., name="local_1d", make_image_summary=False) output = tf.reshape(output, [batch_size, num_heads, -1, depth_v]) # Remove the padding if introduced. output = tf.slice(output, [0, 0, 0, 0], [-1, -1, original_length, -1]) output.set_shape([None if isinstance(dim, tf.Tensor) else dim for dim in (batch_size, num_heads, original_length, depth_v)]) return output
[ "Strided block local self-attention.\n\n The sequence is divided into blocks of length block_length. Attention for a\n given query position can see all memory positions in the corresponding block\n and filter_width many positions to the left and right of the block.\n\n Args:\n q: a Tensor with shape [batch, heads, length, depth_k]\n k: a Tensor with shape [batch, heads, length, depth_k]\n v: a Tensor with shape [batch, heads, length, depth_v]\n block_length: an integer\n filter_width: an integer indicating how much to look left and right of the\n block.\n name: an optional string\n\n Returns:\n a Tensor of shape [batch, heads, length, depth_v]\n " ]
Please provide a description of the function:def reshape_by_blocks(x, x_shape, memory_block_size): x = tf.reshape(x, [ x_shape[0], x_shape[1], x_shape[2] // memory_block_size, memory_block_size, x_shape[3] ]) return x
[ "Reshapes input by splitting its length over blocks of memory_block_size.\n\n Args:\n x: a Tensor with shape [batch, heads, length, depth]\n x_shape: tf.TensorShape of x.\n memory_block_size: Integer which divides length.\n\n Returns:\n Tensor with shape\n [batch, heads, length // memory_block_size, memory_block_size, depth].\n " ]
Please provide a description of the function:def dilated_self_attention_1d(q, k, v, query_block_size=128, memory_block_size=128, gap_size=2, num_memory_blocks=2, name=None): with tf.variable_scope( name, default_name="dilated_self_attention_1d", values=[q, k, v]): v_list_shape = v.get_shape().as_list() assert v_list_shape == k.shape.as_list(), "K and V depths must be equal" v_shape = common_layers.shape_list(v) depth_v = v_shape[3] batch_size = v_shape[0] num_heads = v_shape[1] original_length = common_layers.shape_list(q)[2] # Pad query, key, value to ensure multiple of corresponding lengths. def pad_to_multiple(x, pad_length): x_length = common_layers.shape_list(x)[2] return tf.pad(x, [[0, 0], [0, 0], [0, -x_length % pad_length], [0, 0]]) def pad_l_and_r(x, pad_length): return tf.pad(x, [[0, 0], [0, 0], [pad_length, pad_length], [0, 0]]) q = pad_to_multiple(q, query_block_size) v = pad_to_multiple(v, query_block_size) k = pad_to_multiple(k, query_block_size) # Set up query blocks. new_q_shape = common_layers.shape_list(q) q = reshape_by_blocks(q, new_q_shape, query_block_size) self_k_part = reshape_by_blocks(k, new_q_shape, query_block_size) self_v_part = reshape_by_blocks(v, new_q_shape, query_block_size) # Set up key and value windows. k_v_padding = (gap_size + memory_block_size) * num_memory_blocks k = pad_l_and_r(k, k_v_padding) v = pad_l_and_r(v, k_v_padding) # Get gather indices. index_length = (new_q_shape[2] - query_block_size + memory_block_size) indices = tf.range(0, index_length, delta=1, name="index_range") indices = tf.reshape(indices, [1, -1, 1]) # [1, length, 1] for convs kernel = tf.expand_dims(tf.eye(memory_block_size), axis=1) gather_indices = tf.nn.conv1d( tf.cast(indices, tf.float32), kernel, query_block_size, padding="VALID", name="gather_conv") gather_indices = tf.squeeze(tf.cast(gather_indices, tf.int32), axis=0) # Get left and right memory blocks for each query. # [length, batch, heads, dim] k_t = tf.transpose(k, [2, 0, 1, 3]) v_t = tf.transpose(v, [2, 0, 1, 3]) left_k = gather_dilated_memory_blocks( k_t[:-k_v_padding, :, :, :], num_memory_blocks, gap_size, query_block_size, memory_block_size, gather_indices) left_v = gather_dilated_memory_blocks( v_t[:-k_v_padding, :, :, :], num_memory_blocks, gap_size, query_block_size, memory_block_size, gather_indices) right_k = gather_dilated_memory_blocks( k_t[k_v_padding:, :, :, :], num_memory_blocks, gap_size, query_block_size, memory_block_size, gather_indices, direction="right") right_v = gather_dilated_memory_blocks( v_t[k_v_padding:, :, :, :], num_memory_blocks, gap_size, query_block_size, memory_block_size, gather_indices, direction="right") k_windows = tf.concat([left_k, self_k_part, right_k], axis=3) v_windows = tf.concat([left_v, self_v_part, right_v], axis=3) attention_bias = tf.expand_dims( embedding_to_padding(k_windows) * -1e9, axis=-2) output = dot_product_attention( q, k_windows, v_windows, attention_bias, dropout_rate=0., name="dilated_1d", make_image_summary=False) output = tf.reshape(output, [batch_size, num_heads, -1, depth_v]) # Remove the padding if introduced. output = tf.slice(output, [0, 0, 0, 0], [-1, -1, original_length, -1]) output.set_shape(v_list_shape) return output
[ "Dilated self-attention.\n\n Args:\n q: a Tensor with shape [batch, heads, length, depth]\n k: a Tensor with shape [batch, heads, length, depth]\n v: a Tensor with shape [batch, heads, length, depth]\n query_block_size: an integer indicating size of query block\n memory_block_size: an integer indicating the size of a memory block.\n gap_size: an integer indicating the gap size\n num_memory_blocks: how many memory blocks to look at to the left and right.\n Each will be separated by gap_size.\n name: an optional string\n\n Returns:\n a Tensor of shape [batch, heads, length, depth]\n " ]
Please provide a description of the function:def gather_dilated_memory_blocks(x, num_memory_blocks, gap_size, query_block_size, memory_block_size, gather_indices, direction="left"): gathered_blocks = [] # gathering memory blocks for block_id in range(num_memory_blocks): block_end_index = -(query_block_size + gap_size * (block_id + 1) + memory_block_size * block_id) block_start_index = ( (memory_block_size + gap_size) * (num_memory_blocks - (block_id + 1))) if direction != "left": [block_end_index, block_start_index] = [-block_start_index, -block_end_index] if block_end_index == 0: x_block = x[block_start_index:] else: x_block = x[block_start_index:block_end_index] def gather_dilated_1d_blocks(x, gather_indices): x_new = tf.gather(x, gather_indices) # [batch, heads, blocks, block_length, dim] return tf.transpose(x_new, [2, 3, 0, 1, 4]) gathered_blocks.append(gather_dilated_1d_blocks(x_block, gather_indices)) return tf.concat(gathered_blocks, 3)
[ "Gathers blocks with gaps in between.\n\n Args:\n x: Tensor of shape [length, batch, heads, depth]\n num_memory_blocks: how many memory blocks to look in \"direction\". Each will\n be separated by gap_size.\n gap_size: an integer indicating the gap size\n query_block_size: an integer indicating size of query block\n memory_block_size: an integer indicating the size of a memory block.\n gather_indices: The indices to gather from.\n direction: left or right\n\n Returns:\n Tensor of shape [batch, heads, blocks, block_length, depth]\n " ]
Please provide a description of the function:def masked_dilated_self_attention_1d(q, k, v, query_block_size=64, memory_block_size=64, gap_size=2, num_memory_blocks=2, name=None): with tf.variable_scope( name, default_name="masked_dilated_self_attention_1d", values=[q, k, v]): v_list_shape = v.get_shape().as_list() assert v_list_shape == k.shape.as_list(), "K and V depths must be equal" v_shape = common_layers.shape_list(v) depth_v = v_shape[3] batch_size = v_shape[0] num_heads = v_shape[1] original_length = common_layers.shape_list(q)[2] # Pad query, key, value to ensure multiple of corresponding lengths. def pad_to_multiple(x, pad_length): x_length = common_layers.shape_list(x)[2] return tf.pad(x, [[0, 0], [0, 0], [0, -x_length % pad_length], [0, 0]]) def pad_l(x, left_pad_length): return tf.pad(x, [[0, 0], [0, 0], [left_pad_length, 0], [0, 0]]) q = pad_to_multiple(q, query_block_size) v = pad_to_multiple(v, query_block_size) k = pad_to_multiple(k, query_block_size) # Set up query blocks. new_q_shape = common_layers.shape_list(q) q = reshape_by_blocks(q, new_q_shape, query_block_size) # Set up key and value windows. self_k_part = reshape_by_blocks(k, new_q_shape, query_block_size) self_v_part = reshape_by_blocks(v, new_q_shape, query_block_size) k_v_padding = (gap_size + memory_block_size) * num_memory_blocks k = pad_l(k, k_v_padding) v = pad_l(v, k_v_padding) # Get gather indices. index_length = (new_q_shape[2] - query_block_size + memory_block_size) indices = tf.range(0, index_length, delta=1, name="index_range") indices = tf.reshape(indices, [1, -1, 1]) # [1, length, 1] for convs kernel = tf.expand_dims(tf.eye(memory_block_size), axis=1) gather_indices = tf.nn.conv1d( tf.cast(indices, tf.float32), kernel, query_block_size, padding="VALID", name="gather_conv") gather_indices = tf.squeeze(tf.cast(gather_indices, tf.int32), axis=0) # Get left and right memory blocks for each query. # [length, batch, heads, dim] k_t = tf.transpose(k, [2, 0, 1, 3]) v_t = tf.transpose(v, [2, 0, 1, 3]) k_unmasked_windows = gather_dilated_memory_blocks( k_t, num_memory_blocks, gap_size, query_block_size, memory_block_size, gather_indices) v_unmasked_windows = gather_dilated_memory_blocks( v_t, num_memory_blocks, gap_size, query_block_size, memory_block_size, gather_indices) # Combine memory windows. block_q_shape = common_layers.shape_list(q) masked_attention_bias = tf.tile( tf.expand_dims(attention_bias_lower_triangle(query_block_size), axis=0), [block_q_shape[0], block_q_shape[1], block_q_shape[2], 1, 1]) padding_attention_bias = tf.expand_dims( embedding_to_padding(k_unmasked_windows) * -1e9, axis=-2) padding_attention_bias = tf.tile(padding_attention_bias, [1, 1, 1, query_block_size, 1]) attention_bias = tf.concat( [masked_attention_bias, padding_attention_bias], axis=-1) # combine memory windows k_windows = tf.concat([self_k_part, k_unmasked_windows], 3) v_windows = tf.concat([self_v_part, v_unmasked_windows], 3) output = dot_product_attention( q, k_windows, v_windows, attention_bias, dropout_rate=0., name="dilated_1d", make_image_summary=False) output = tf.reshape(output, [batch_size, num_heads, -1, depth_v]) # Remove the padding if introduced. output = tf.slice(output, [0, 0, 0, 0], [-1, -1, original_length, -1]) output.set_shape(v_list_shape) return output
[ "Dilated self-attention. TODO(avaswani): Try it and write a paper on it.\n\n Args:\n q: a Tensor with shape [batch, heads, length, depth]\n k: a Tensor with shape [batch, heads, length, depth]\n v: a Tensor with shape [batch, heads, length, depth]\n query_block_size: an integer\n memory_block_size: an integer indicating how much to look left.\n gap_size: an integer indicating the gap size\n num_memory_blocks: how many memory blocks to look at to the left. Each will\n be separated by gap_size.\n name: an optional string\n\n Returns:\n a Tensor of shape [batch, heads, length, depth]\n " ]
Please provide a description of the function:def local_attention_2d(q, k, v, query_shape=(8, 16), memory_flange=(8, 16), name=None): with tf.variable_scope( name, default_name="local_self_attention_2d", values=[q, k, v]): v_shape = common_layers.shape_list(v) # Pad query, key, value to ensure multiple of corresponding lengths. q = pad_to_multiple_2d(q, query_shape) k = pad_to_multiple_2d(k, query_shape) v = pad_to_multiple_2d(v, query_shape) paddings = [[0, 0], [0, 0], [memory_flange[0], memory_flange[1]], [memory_flange[0], memory_flange[1]], [0, 0]] k = tf.pad(k, paddings) v = tf.pad(v, paddings) # Set up query blocks. q_indices = gather_indices_2d(q, query_shape, query_shape) q_new = gather_blocks_2d(q, q_indices) # Set up key and value blocks. memory_shape = (query_shape[0] + 2 * memory_flange[0], query_shape[1] + 2 * memory_flange[1]) k_and_v_indices = gather_indices_2d(k, memory_shape, query_shape) k_new = gather_blocks_2d(k, k_and_v_indices) v_new = gather_blocks_2d(v, k_and_v_indices) attention_bias = tf.expand_dims( tf.to_float(embedding_to_padding(k_new)) * -1e9, axis=-2) output = dot_product_attention( q_new, k_new, v_new, attention_bias, dropout_rate=0., name="local_2d", make_image_summary=False) # Put representations back into original shapes. padded_q_shape = common_layers.shape_list(q) output = scatter_blocks_2d(output, q_indices, padded_q_shape) # Remove the padding if introduced. output = tf.slice(output, [0, 0, 0, 0, 0], [-1, -1, v_shape[2], v_shape[3], -1]) return output
[ "Strided block local self-attention.\n\n The 2-D sequence is divided into 2-D blocks of shape query_shape. Attention\n for a given query position can only see memory positions less than or equal to\n the query position. The memory positions are the corresponding block with\n memory_flange many positions to add to the height and width of the block\n (namely, left, top, and right).\n\n Args:\n q: a Tensor with shape [batch, heads, h, w, depth_k]\n k: a Tensor with shape [batch, heads, h, w, depth_k]\n v: a Tensor with shape [batch, heads, h, w, depth_v]. In the current\n implementation, depth_v must be equal to depth_k.\n query_shape: an tuple indicating the height and width of each query block.\n memory_flange: an integer indicating how much to look in height and width\n from each query block.\n name: an optional string\n\n Returns:\n a Tensor of shape [batch, heads, h, w, depth_v]\n " ]
Please provide a description of the function:def pad_to_multiple_2d(x, block_shape): old_shape = x.get_shape().dims last = old_shape[-1] if len(old_shape) == 4: height_padding = -common_layers.shape_list(x)[1] % block_shape[0] width_padding = -common_layers.shape_list(x)[2] % block_shape[1] paddings = [[0, 0], [0, height_padding], [0, width_padding], [0, 0]] elif len(old_shape) == 5: height_padding = -common_layers.shape_list(x)[2] % block_shape[0] width_padding = -common_layers.shape_list(x)[3] % block_shape[1] paddings = [[0, 0], [0, 0], [0, height_padding], [0, width_padding], [0, 0]] padded_x = tf.pad(x, paddings) padded_shape = padded_x.get_shape().as_list() padded_shape = padded_shape[:-1] + [last] padded_x.set_shape(padded_shape) return padded_x
[ "Making sure x is a multiple of shape.\n\n Args:\n x: a [batch, heads, h, w, depth] or [batch, h, w, depth] tensor\n block_shape: a 2-d list of integer shapes\n\n Returns:\n padded_x: a [batch, heads, h, w, depth] or [batch, h, w, depth] tensor\n " ]
Please provide a description of the function:def reshape_range(tensor, i, j, shape): t_shape = common_layers.shape_list(tensor) target_shape = t_shape[:i] + shape + t_shape[j:] return tf.reshape(tensor, target_shape)
[ "Reshapes a tensor between dimensions i and j." ]
Please provide a description of the function:def gather_blocks_2d(x, indices): x_shape = common_layers.shape_list(x) x = reshape_range(x, 2, 4, [tf.reduce_prod(x_shape[2:4])]) # [length, batch, heads, dim] x_t = tf.transpose(x, [2, 0, 1, 3]) x_new = tf.gather(x_t, indices) # returns [batch, heads, num_blocks, block_length ** 2, dim] return tf.transpose(x_new, [2, 3, 0, 1, 4])
[ "Gathers flattened blocks from x." ]
Please provide a description of the function:def scatter_blocks_2d(x, indices, shape): x_shape = common_layers.shape_list(x) # [length, batch, heads, dim] x_t = tf.transpose( tf.reshape(x, [x_shape[0], x_shape[1], -1, x_shape[-1]]), [2, 0, 1, 3]) x_t_shape = common_layers.shape_list(x_t) indices = tf.reshape(indices, [-1, 1]) scattered_x = tf.scatter_nd(indices, x_t, x_t_shape) scattered_x = tf.transpose(scattered_x, [1, 2, 0, 3]) return tf.reshape(scattered_x, shape)
[ "scatters blocks from x into shape with indices." ]
Please provide a description of the function:def gather_indices_2d(x, block_shape, block_stride): # making an identity matrix kernel kernel = tf.eye(block_shape[0] * block_shape[1]) kernel = reshape_range(kernel, 0, 1, [block_shape[0], block_shape[1], 1]) # making indices [1, h, w, 1] to appy convs x_shape = common_layers.shape_list(x) indices = tf.range(x_shape[2] * x_shape[3]) indices = tf.reshape(indices, [1, x_shape[2], x_shape[3], 1]) indices = tf.nn.conv2d( tf.cast(indices, tf.float32), kernel, strides=[1, block_stride[0], block_stride[1], 1], padding="VALID") # making indices [num_blocks, dim] to gather dims = common_layers.shape_list(indices)[:3] if all([isinstance(dim, int) for dim in dims]): num_blocks = functools.reduce(operator.mul, dims, 1) else: num_blocks = tf.reduce_prod(dims) indices = tf.reshape(indices, [num_blocks, -1]) return tf.cast(indices, tf.int32)
[ "Getting gather indices." ]
Please provide a description of the function:def make_2d_block_raster_mask(query_shape, memory_flange): # mask inside the query block query_triangle = common_layers.ones_matrix_band_part( np.prod(query_shape), np.prod(query_shape), -1, 0) split_query_masks = tf.split(query_triangle, query_shape[0], axis=1) # adding mask for left and right mask_pieces = [ tf.concat( # pylint: disable=g-complex-comprehension [tf.ones([np.prod(query_shape), memory_flange[1]]), split_query_masks[i], tf.zeros([np.prod(query_shape), memory_flange[1]])], axis=1) for i in range(query_shape[0]) ] # adding mask for top final_mask = tf.concat( [ tf.ones([ np.prod(query_shape), (query_shape[1] + 2 * memory_flange[1]) * memory_flange[0] ]), tf.concat(mask_pieces, axis=1) ], axis=1) # 0.0 is visible location, 1.0 is masked. return 1. - final_mask
[ "Creates a mask for 2d block raster scan.\n\n The query mask can look to the left, top left, top, and top right, but\n not to the right. Inside the query, we have the standard raster scan\n masking.\n Args:\n query_shape: A tuple of ints (query_height, query_width)\n memory_flange: A tuple of ints\n (memory_flange_height, memory_flange_width)\n\n Returns:\n A tensor of shape query_size, memory_size\n " ]
Please provide a description of the function:def get_memory_region(x, query_block_shape, memory_flange, q_indices): # Padding x to be multiple of query_shape and then # extracting the memory blocks from the same regions as the query blocks x_query_padded = pad_to_multiple_2d(x, query_block_shape) x_center = gather_blocks_2d(x_query_padded, q_indices) # Then padding the flange region paddings = [[0, 0], [0, 0], [memory_flange[0], 0], [memory_flange[1], memory_flange[1]], [0, 0]] x_memory_padded = tf.pad(x_query_padded, paddings) left_x = None top_x = None # Extracting the memory regions around the query block. left_x_region extends # to the left and the top_x_region is the combination of top left, top, and # top right of the query block # if no left region if memory_flange[1] > 0: left_x_region = x_memory_padded[:, :, memory_flange[ 0]:, :-(query_block_shape[1] + memory_flange[1]), :] left_memory_shape = (query_block_shape[0], memory_flange[1]) left_indices = gather_indices_2d(left_x_region, left_memory_shape, query_block_shape) left_x = gather_blocks_2d(left_x_region, left_indices) # if no top region if memory_flange[0] > 0: top_x_region = x_memory_padded[:, :, :-query_block_shape[0], :, :] top_memory_shape = (memory_flange[0], query_block_shape[1] + 2 * memory_flange[1]) top_indices = gather_indices_2d(top_x_region, top_memory_shape, query_block_shape) top_x = gather_blocks_2d(top_x_region, top_indices) x_flange = None if top_x is not None and left_x is not None: x_flange = tf.concat([top_x, left_x], axis=3) else: x_flange = top_x if top_x is not None else left_x return x_flange, x_center
[ "Get the memory regions that surround a 2d query.\n\n The memory regions will be the left and top right.\n\n Args:\n x: A tensor with shape [batch, heads, height, width, depth]\n query_block_shape: a 2-d tuple of integers\n memory_flange: a 2-d tuple of integers\n q_indices: a tensor of indices for each of the center blocks.\n [num_blocks, block_length]\n Returns:\n x_flange: A tensor of shape [batch, heads, #blocks, block_length, depth]\n " ]
Please provide a description of the function:def get_shifted_center_blocks(x, indices): center_x = gather_blocks_2d(x, indices) # Shift right along the length dimension def shift_right_2d_blocks(x): shifted_targets = ( tf.pad(x, [[0, 0], [0, 0], [0, 0], [1, 0], [0, 0]])[:, :, :, :-1, :]) return shifted_targets x_shifted = shift_right_2d_blocks(center_x) return x_shifted
[ "Get right shifted blocks for masked local attention 2d.\n\n Args:\n x: A tensor with shape [batch, heads, height, width, depth]\n indices: The indices to gather blocks\n\n Returns:\n x_shifted: a tensor of extracted blocks, each block right shifted along\n length.\n ", "Shift the second to last dimension of x right by one." ]
Please provide a description of the function:def right_shift_blockwise(x, query_shape, name=None): with tf.variable_scope( name, default_name="right_shift_blockwise", values=[x]): x_list_shape = x.get_shape().as_list() x_shape = common_layers.shape_list(x) # Add a dummy dimension for heads. x = tf.expand_dims(x, axis=1) x = pad_to_multiple_2d(x, query_shape) padded_x_shape = common_layers.shape_list(x) # Set up q blocks. x_indices = gather_indices_2d(x, query_shape, query_shape) x_new = get_shifted_center_blocks(x, x_indices) # Put representations back into original shapes. output = scatter_blocks_2d(x_new, x_indices, padded_x_shape) # Remove the dummy head dimension. output = tf.squeeze(output, axis=1) # Remove the padding if introduced. output = tf.slice(output, [0, 0, 0, 0], [-1, x_shape[1], x_shape[2], -1]) output.set_shape(x_list_shape) return output
[ "Right shifts once in every block.\n\n Args:\n x: a tensor of shape [batch, height, width, depth]\n query_shape: A 2d tuple of ints\n name: a string\n\n Returns:\n output: a tensor of the same shape as x\n " ]
Please provide a description of the function:def masked_local_attention_2d(q, k, v, query_shape=(8, 16), memory_flange=(8, 16), name=None): with tf.variable_scope( name, default_name="local_masked_self_attention_2d", values=[q, k, v]): v_shape = common_layers.shape_list(v) # Pad query to ensure multiple of corresponding lengths. q = pad_to_multiple_2d(q, query_shape) # Set up query blocks. q_indices = gather_indices_2d(q, query_shape, query_shape) q_new = gather_blocks_2d(q, q_indices) # Set up key and value blocks. k_flange, k_center = get_memory_region(k, query_shape, memory_flange, q_indices) v_flange, v_center = get_memory_region(v, query_shape, memory_flange, q_indices) if k_flange is not None: k_new = tf.concat([k_flange, k_center], axis=3) v_new = tf.concat([v_flange, v_center], axis=3) else: k_new = k_center v_new = v_center # Set up the masks. query_elements = np.prod(query_shape) padding_mask = None if k_flange is not None: padding_mask = tf.expand_dims( embedding_to_padding(k_flange) * -1e9, axis=-2) padding_mask = tf.tile(padding_mask, [1, 1, 1, query_elements, 1]) center_attention_bias = attention_bias_lower_triangle( np.prod(query_elements)) center_attention_bias = tf.reshape( center_attention_bias, [1, 1, 1, query_elements, query_elements]) v_center_shape = common_layers.shape_list(v_center) center_attention_bias = tf.tile( center_attention_bias, [v_center_shape[0], v_center_shape[1], v_center_shape[2], 1, 1]) if padding_mask is not None: # Combine the mask for padding and visible region. attention_bias = tf.concat([padding_mask, center_attention_bias], axis=4) else: attention_bias = center_attention_bias output = dot_product_attention( q_new, k_new, v_new, attention_bias, dropout_rate=0., name="masked_local_2d", make_image_summary=False) # Put representations back into original shapes. padded_q_shape = common_layers.shape_list(q) output = scatter_blocks_2d(output, q_indices, padded_q_shape) # Remove the padding if introduced. output = tf.slice(output, [0, 0, 0, 0, 0], [-1, -1, v_shape[2], v_shape[3], -1]) return output
[ "Strided block local self-attention.\n\n Each position in a query block can attend to all the generated queries in\n the query block, which are generated in raster scan, and positions that are\n generated to the left and top. The shapes are specified by query shape and\n memory flange. Note that if you're using this function, you do not need to\n right shift. Right shifting happens inside this function separately for each\n block.\n\n Args:\n q: a Tensor with shape [batch, heads, h, w, depth_k]\n k: a Tensor with shape [batch, heads, h, w, depth_k]\n v: a Tensor with shape [batch, heads, h, w, depth_v]. In the current\n implementation, depth_v must be equal to depth_k.\n query_shape: an tuple indicating the height and width of each query block.\n query_shape = block_shape\n memory_flange: an integer indicating how much to look in height and width\n from each query block.\n memory shape = query_shape + (block_flange[0], 2*block_flange[1])\n name: an optional string\n\n Returns:\n a Tensor of shape [batch, heads, h, w, depth_v]\n " ]
Please provide a description of the function:def compute_attention_component(antecedent, total_depth, filter_width=1, padding="VALID", name="c", vars_3d_num_heads=0, layer_collection=None): if layer_collection is not None: if filter_width != 1 or vars_3d_num_heads != 0: raise ValueError( "KFAC implementation only supports filter_width=1 (actual: {}) and " "vars_3d_num_heads=0 (actual: {}).".format( filter_width, vars_3d_num_heads)) if vars_3d_num_heads > 0: assert filter_width == 1 input_depth = antecedent.get_shape().as_list()[-1] depth_per_head = total_depth // vars_3d_num_heads initializer_stddev = input_depth ** -0.5 if "q" in name: initializer_stddev *= depth_per_head ** -0.5 var = tf.get_variable( name, [input_depth, vars_3d_num_heads, total_depth // vars_3d_num_heads], initializer=tf.random_normal_initializer(stddev=initializer_stddev)) var = tf.cast(var, antecedent.dtype) var = tf.reshape(var, [input_depth, total_depth]) return tf.tensordot(antecedent, var, axes=1) if filter_width == 1: return common_layers.dense( antecedent, total_depth, use_bias=False, name=name, layer_collection=layer_collection) else: return common_layers.conv1d( antecedent, total_depth, filter_width, padding=padding, name=name)
[ "Computes attention compoenent (query, key or value).\n\n Args:\n antecedent: a Tensor with shape [batch, length, channels]\n total_depth: an integer\n filter_width: An integer specifying how wide you want the attention\n component to be.\n padding: One of \"VALID\", \"SAME\" or \"LEFT\". Default is VALID: No padding.\n name: a string specifying scope name.\n vars_3d_num_heads: an optional integer (if we want to use 3d variables)\n layer_collection: A tensorflow_kfac.LayerCollection. Only used by the\n KFAC optimizer. Default is None.\n\n Returns:\n c : [batch, length, depth] tensor\n " ]
Please provide a description of the function:def compute_qkv(query_antecedent, memory_antecedent, total_key_depth, total_value_depth, q_filter_width=1, kv_filter_width=1, q_padding="VALID", kv_padding="VALID", vars_3d_num_heads=0, layer_collection=None): if memory_antecedent is None: memory_antecedent = query_antecedent q = compute_attention_component( query_antecedent, total_key_depth, q_filter_width, q_padding, "q", vars_3d_num_heads=vars_3d_num_heads, layer_collection=layer_collection) k = compute_attention_component( memory_antecedent, total_key_depth, kv_filter_width, kv_padding, "k", vars_3d_num_heads=vars_3d_num_heads, layer_collection=layer_collection) v = compute_attention_component( memory_antecedent, total_value_depth, kv_filter_width, kv_padding, "v", vars_3d_num_heads=vars_3d_num_heads, layer_collection=layer_collection) return q, k, v
[ "Computes query, key and value.\n\n Args:\n query_antecedent: a Tensor with shape [batch, length_q, channels]\n memory_antecedent: a Tensor with shape [batch, length_m, channels]\n total_key_depth: an integer\n total_value_depth: an integer\n q_filter_width: An integer specifying how wide you want the query to be.\n kv_filter_width: An integer specifying how wide you want the keys and values\n to be.\n q_padding: One of \"VALID\", \"SAME\" or \"LEFT\". Default is VALID: No padding.\n kv_padding: One of \"VALID\", \"SAME\" or \"LEFT\". Default is VALID: No padding.\n vars_3d_num_heads: an optional (if we want to use 3d variables)\n layer_collection: A tensorflow_kfac.LayerCollection. Only used by the\n KFAC optimizer. Default is None.\n\n Returns:\n q, k, v : [batch, length, depth] tensors\n " ]
Please provide a description of the function:def multihead_attention(query_antecedent, memory_antecedent, bias, total_key_depth, total_value_depth, output_depth, num_heads, dropout_rate, attention_type="dot_product", max_relative_position=None, heads_share_relative_embedding=False, add_relative_to_values=False, image_shapes=None, block_length=128, block_width=128, q_filter_width=1, kv_filter_width=1, q_padding="VALID", kv_padding="VALID", cache=None, gap_size=0, num_memory_blocks=2, name="multihead_attention", save_weights_to=None, make_image_summary=True, dropout_broadcast_dims=None, vars_3d=False, layer_collection=None, recurrent_memory=None, chunk_number=None, hard_attention_k=0, max_area_width=1, max_area_height=1, memory_height=1, area_key_mode="mean", area_value_mode="sum", training=True, **kwargs): if total_key_depth % num_heads != 0: raise ValueError("Key depth (%d) must be divisible by the number of " "attention heads (%d)." % (total_key_depth, num_heads)) if total_value_depth % num_heads != 0: raise ValueError("Value depth (%d) must be divisible by the number of " "attention heads (%d)." % (total_value_depth, num_heads)) vars_3d_num_heads = num_heads if vars_3d else 0 if layer_collection is not None: if cache is not None: raise ValueError("KFAC implementation only supports cache is None.") if vars_3d: raise ValueError("KFAC implementation does not support 3d vars.") if recurrent_memory is not None: if memory_antecedent is not None: raise ValueError("Recurrent memory requires memory_antecedent is None.") if cache is not None: raise ValueError("Cache is not supported when using recurrent memory.") if vars_3d: raise ValueError("3d vars are not supported when using recurrent memory.") if layer_collection is not None: raise ValueError("KFAC is not supported when using recurrent memory.") if chunk_number is None: raise ValueError("chunk_number is required when using recurrent memory.") with tf.variable_scope(name, default_name="multihead_attention", values=[query_antecedent, memory_antecedent]): if recurrent_memory is not None: ( recurrent_memory_transaction, query_antecedent, memory_antecedent, bias, ) = recurrent_memory.pre_attention( chunk_number, query_antecedent, memory_antecedent, bias, ) if cache is None or memory_antecedent is None: q, k, v = compute_qkv(query_antecedent, memory_antecedent, total_key_depth, total_value_depth, q_filter_width, kv_filter_width, q_padding, kv_padding, vars_3d_num_heads=vars_3d_num_heads, layer_collection=layer_collection) if cache is not None: if attention_type not in ["dot_product", "dot_product_relative"]: # TODO(petershaw): Support caching when using relative position # representations, i.e. "dot_product_relative" attention. raise NotImplementedError( "Caching is not guaranteed to work with attention types other than" " dot_product.") if bias is None: raise ValueError("Bias required for caching. See function docstring " "for details.") if memory_antecedent is not None: # Encoder-Decoder Attention Cache q = compute_attention_component(query_antecedent, total_key_depth, q_filter_width, q_padding, "q", vars_3d_num_heads=vars_3d_num_heads) k = cache["k_encdec"] v = cache["v_encdec"] else: k = split_heads(k, num_heads) v = split_heads(v, num_heads) decode_loop_step = kwargs.get("decode_loop_step") if decode_loop_step is None: k = cache["k"] = tf.concat([cache["k"], k], axis=2) v = cache["v"] = tf.concat([cache["v"], v], axis=2) else: # Inplace update is required for inference on TPU. # Inplace_ops only supports inplace_update on the first dimension. # The performance of current implementation is better than updating # the tensor by adding the result of matmul(one_hot, # update_in_current_step) tmp_k = tf.transpose(cache["k"], perm=[2, 0, 1, 3]) tmp_k = inplace_ops.alias_inplace_update( tmp_k, decode_loop_step, tf.squeeze(k, axis=2)) k = cache["k"] = tf.transpose(tmp_k, perm=[1, 2, 0, 3]) tmp_v = tf.transpose(cache["v"], perm=[2, 0, 1, 3]) tmp_v = inplace_ops.alias_inplace_update( tmp_v, decode_loop_step, tf.squeeze(v, axis=2)) v = cache["v"] = tf.transpose(tmp_v, perm=[1, 2, 0, 3]) q = split_heads(q, num_heads) if cache is None: k = split_heads(k, num_heads) v = split_heads(v, num_heads) key_depth_per_head = total_key_depth // num_heads if not vars_3d: q *= key_depth_per_head**-0.5 additional_returned_value = None if callable(attention_type): # Generic way to extend multihead_attention x = attention_type(q, k, v, **kwargs) if isinstance(x, tuple): x, additional_returned_value = x # Unpack elif attention_type == "dot_product": if max_area_width > 1 or max_area_height > 1: x = area_attention.dot_product_area_attention( q, k, v, bias, dropout_rate, image_shapes, save_weights_to=save_weights_to, dropout_broadcast_dims=dropout_broadcast_dims, max_area_width=max_area_width, max_area_height=max_area_height, memory_height=memory_height, area_key_mode=area_key_mode, area_value_mode=area_value_mode, training=training) else: x = dot_product_attention(q, k, v, bias, dropout_rate, image_shapes, save_weights_to=save_weights_to, make_image_summary=make_image_summary, dropout_broadcast_dims=dropout_broadcast_dims, activation_dtype=kwargs.get( "activation_dtype"), hard_attention_k=hard_attention_k) elif attention_type == "dot_product_relative": x = dot_product_attention_relative( q, k, v, bias, max_relative_position, dropout_rate, image_shapes, save_weights_to=save_weights_to, make_image_summary=make_image_summary, cache=cache is not None, allow_memory=recurrent_memory is not None, hard_attention_k=hard_attention_k) elif attention_type == "dot_product_unmasked_relative_v2": x = dot_product_unmasked_self_attention_relative_v2( q, k, v, bias, max_relative_position, dropout_rate, image_shapes, make_image_summary=make_image_summary, dropout_broadcast_dims=dropout_broadcast_dims, heads_share_relative_embedding=heads_share_relative_embedding, add_relative_to_values=add_relative_to_values) elif attention_type == "dot_product_relative_v2": x = dot_product_self_attention_relative_v2( q, k, v, bias, max_relative_position, dropout_rate, image_shapes, make_image_summary=make_image_summary, dropout_broadcast_dims=dropout_broadcast_dims, heads_share_relative_embedding=heads_share_relative_embedding, add_relative_to_values=add_relative_to_values) elif attention_type == "local_within_block_mask_right": x = masked_within_block_local_attention_1d( q, k, v, block_length=block_length) elif attention_type == "local_relative_mask_right": x = masked_relative_local_attention_1d( q, k, v, block_length=block_length, make_image_summary=make_image_summary, dropout_rate=dropout_rate, heads_share_relative_embedding=heads_share_relative_embedding, add_relative_to_values=add_relative_to_values, name="masked_relative_local_attention_1d") elif attention_type == "local_mask_right": x = masked_local_attention_1d( q, k, v, block_length=block_length, make_image_summary=make_image_summary) elif attention_type == "local_unmasked": x = local_attention_1d( q, k, v, block_length=block_length, filter_width=block_width) elif attention_type == "masked_dilated_1d": x = masked_dilated_self_attention_1d(q, k, v, block_length, block_width, gap_size, num_memory_blocks) else: assert attention_type == "unmasked_dilated_1d" x = dilated_self_attention_1d(q, k, v, block_length, block_width, gap_size, num_memory_blocks) x = combine_heads(x) # Set last dim specifically. x.set_shape(x.shape.as_list()[:-1] + [total_value_depth]) if vars_3d: o_var = tf.get_variable( "o", [num_heads, total_value_depth // num_heads, output_depth]) o_var = tf.cast(o_var, x.dtype) o_var = tf.reshape(o_var, [total_value_depth, output_depth]) x = tf.tensordot(x, o_var, axes=1) else: x = common_layers.dense( x, output_depth, use_bias=False, name="output_transform", layer_collection=layer_collection) if recurrent_memory is not None: x = recurrent_memory.post_attention(recurrent_memory_transaction, x) if additional_returned_value is not None: return x, additional_returned_value return x
[ "Multihead scaled-dot-product attention with input/output transformations.\n\n Args:\n query_antecedent: a Tensor with shape [batch, length_q, channels]\n memory_antecedent: a Tensor with shape [batch, length_m, channels] or None\n bias: bias Tensor (see attention_bias())\n total_key_depth: an integer\n total_value_depth: an integer\n output_depth: an integer\n num_heads: an integer dividing total_key_depth and total_value_depth\n dropout_rate: a floating point number\n attention_type: a string, either \"dot_product\", \"dot_product_relative\",\n \"local_mask_right\", \"local_unmasked\", \"masked_dilated_1d\",\n \"unmasked_dilated_1d\", graph, or any attention function\n with the signature (query, key, value, **kwargs)\n max_relative_position: Maximum distance between inputs to generate\n unique relation embeddings for. Only relevant\n when using \"dot_product_relative\" attention.\n heads_share_relative_embedding: boolean to share relative embeddings\n add_relative_to_values: a boolean for whether to add relative component to\n values.\n image_shapes: optional tuple of integer scalars.\n see comments for attention_image_summary()\n block_length: an integer - relevant for \"local_mask_right\"\n block_width: an integer - relevant for \"local_unmasked\"\n q_filter_width: An integer specifying how wide you want the query to be.\n kv_filter_width: An integer specifying how wide you want the keys and values\n to be.\n q_padding: One of \"VALID\", \"SAME\" or \"LEFT\". Default is VALID: No padding.\n kv_padding: One of \"VALID\", \"SAME\" or \"LEFT\". Default is \"VALID\":\n no padding.\n cache: dict containing Tensors which are the results of previous\n attentions, used for fast decoding. Expects the dict to contrain two\n keys ('k' and 'v'), for the initial call the values for these keys\n should be empty Tensors of the appropriate shape.\n 'k' [batch_size, 0, key_channels]\n 'v' [batch_size, 0, value_channels]\n gap_size: Integer option for dilated attention to indicate spacing between\n memory blocks.\n num_memory_blocks: Integer option to indicate how many memory blocks to look\n at.\n name: an optional string.\n save_weights_to: an optional dictionary to capture attention weights\n for vizualization; the weights tensor will be appended there under\n a string key created from the variable scope (including name).\n make_image_summary: Whether to make an attention image summary.\n dropout_broadcast_dims: an optional list of integers less than 4\n specifying in which dimensions to broadcast the dropout decisions.\n saves memory.\n vars_3d: use 3-dimensional variables for input/output transformations\n layer_collection: A tensorflow_kfac.LayerCollection. Only used by the\n KFAC optimizer. Default is None.\n recurrent_memory: An optional transformer_memory.RecurrentMemory, which\n retains state across chunks. Default is None.\n chunk_number: an optional integer Tensor with shape [batch] used to operate\n the recurrent_memory.\n hard_attention_k: integer, if > 0 triggers hard attention (picking top-k).\n max_area_width: the max width allowed for an area.\n max_area_height: the max height allowed for an area.\n memory_height: the height of the memory.\n area_key_mode: the mode for computing area keys, which can be \"mean\",\n \"concat\", \"sum\", \"sample_concat\", and \"sample_sum\".\n area_value_mode: the mode for computing area values, which can be either\n \"mean\", or \"sum\".\n training: indicating if it is in the training mode.\n **kwargs (dict): Parameters for the attention function.\n\n Caching:\n WARNING: For decoder self-attention, i.e. when memory_antecedent == None,\n the caching assumes that the bias contains future masking.\n\n The caching works by saving all the previous key and value values so that\n you are able to send just the last query location to this attention\n function. I.e. if the cache dict is provided it assumes the query is of the\n shape [batch_size, 1, hidden_dim] rather than the full memory.\n\n Returns:\n The result of the attention transformation. The output shape is\n [batch_size, length_q, hidden_dim]\n unless the cache dict is provided in which case only the last memory\n position is calculated and the output shape is [batch_size, 1, hidden_dim]\n Optionally returns an additional loss parameters (ex: load balance loss for\n the experts) returned by the attention_type function.\n\n Raises:\n ValueError: if the key depth or value depth are not divisible by the\n number of attention heads.\n " ]
Please provide a description of the function:def multihead_attention_2d(query_antecedent, memory_antecedent, total_key_depth, total_value_depth, output_depth, num_heads, attention_type="local_attention_2d", query_shape=(8, 16), memory_flange=(8, 16), name=None): if total_key_depth % num_heads != 0: raise ValueError("Key depth (%d) must be divisible by the number of " "attention heads (%d)." % (total_key_depth, num_heads)) if total_value_depth % num_heads != 0: raise ValueError("Value depth (%d) must be divisible by the number of " "attention heads (%d)." % (total_value_depth, num_heads)) with tf.variable_scope( name, default_name="multihead_attention_2d", values=[query_antecedent, memory_antecedent]): q, k, v = compute_qkv(query_antecedent, memory_antecedent, total_key_depth, total_value_depth) # after splitting, shape is [batch, heads, h, w, depth] q = split_heads_2d(q, num_heads) k = split_heads_2d(k, num_heads) v = split_heads_2d(v, num_heads) key_depth_per_head = total_key_depth // num_heads q *= key_depth_per_head**-0.5 if attention_type == "local_attention_2d": x = local_attention_2d( q, k, v, query_shape=query_shape, memory_flange=memory_flange) elif attention_type == "masked_local_attention_2d": assert attention_type == "masked_local_attention_2d" x = masked_local_attention_2d( q, k, v, query_shape=query_shape, memory_flange=memory_flange) else: assert attention_type == "unmasked_local_attention_2d_tpu" x = dot_product_unmasked_attention_local_2d_tpu( q, k, v, None, max_relative_position=None, query_shape=query_shape) x = combine_heads_2d(x) x = common_layers.dense( x, output_depth, use_bias=False, name="output_transform") return x
[ "2d Multihead scaled-dot-product attention with inp/output transformations.\n\n Args:\n query_antecedent: a Tensor with shape [batch, h, w, depth_k]\n memory_antecedent: a Tensor with shape [batch, h, w, depth_k]\n total_key_depth: an integer\n total_value_depth: an integer\n output_depth: an integer\n num_heads: an integer dividing total_key_depth and total_value_depth\n attention_type: String, type of attention function to use.\n query_shape: an tuple indicating the height and width of each query block.\n memory_flange: an integer indicating how much to look in height and width\n name: an optional string\n\n Returns:\n A Tensor of shape [batch, h, w, output_depth]\n\n Raises:\n ValueError: if the key depth or value depth are not divisible by the\n number of attention heads.\n " ]
Please provide a description of the function:def ffn_self_attention_layer(x, filter_depth, output_depth, num_parts, dropout_rate, share_kv=False, name=None): with tf.variable_scope( name, default_name="feedforward_self_attention", values=[x]): x_shape = common_layers.shape_list(x) part_depth = filter_depth // num_parts if not share_kv: combined = common_layers.dense( x, filter_depth * 3, use_bias=False, name="qkv_transform") combined = tf.expand_dims(combined, axis=2) q, k, v = tf.split(combined, 3, axis=3) else: q = tf.expand_dims( common_layers.dense( x, filter_depth, use_bias=False, name="q_transform"), axis=2) kv_combined = tf.expand_dims( common_layers.dense( tf.concat([x, x], axis=1), filter_depth, use_bias=False, name="kv_transform"), axis=2) k, v = tf.split(kv_combined, [x_shape[1], x_shape[1]], axis=1) batch_q = tf.reshape(q, [-1, 1, num_parts, part_depth]) batch_k = tf.reshape(k, [-1, 1, num_parts, part_depth]) batch_v = tf.reshape(v, [-1, 1, num_parts, part_depth]) batch_q *= part_depth**-0.5 # non-masked bias bias = None x = dot_product_attention(batch_q, batch_k, batch_v, bias, dropout_rate) x = tf.reshape(x, [x_shape[0], x_shape[1], filter_depth]) x = common_layers.dense( x, output_depth, use_bias=False, name="output_transform") return x
[ "Self-attention feedforward layer.\n\n We use self-attention to do feedforward computations. We apply this function\n positionwise where for each position, we linearly transform the output to have\n depth filter_depth, and break up the result depth-wise into num_parts\n contiguous parts. The parts self-attend, we concatenate the results\n depth-wise, and we linearly transform to a depth of output_depth. The goal is\n to get multiplicative interactions between components of a representation.\n\n Args:\n x: a Tensor with shape [batch, length, channels]\n filter_depth: an integer\n output_depth: an integer\n num_parts: an integer dividing filter depth\n dropout_rate: a floating point number\n share_kv: Share the key value transform\n name: an optional string\n\n Returns:\n A Tensor with shape [batch, length, output_depth].\n " ]
Please provide a description of the function:def parameter_attention(x, total_key_depth, total_value_depth, output_depth, memory_rows, num_heads, dropout_rate, name=None): with tf.variable_scope(name, default_name="parameter_attention", values=[x]): head_size_k = total_key_depth // num_heads head_size_v = total_value_depth // num_heads var_shape_k = [num_heads, memory_rows, head_size_k] var_shape_v = [num_heads, memory_rows, head_size_v] k = tf.get_variable( "k", var_shape_k, initializer=tf.random_normal_initializer( 0, output_depth**-0.5 * (num_heads**0.5))) v = tf.get_variable( "v", var_shape_v, initializer=tf.random_normal_initializer( 0, output_depth**-0.5 * (output_depth**0.5))) batch_size = common_layers.shape_list(x)[0] length = common_layers.shape_list(x)[1] q = common_layers.dense( x, total_key_depth, use_bias=False, name="q_transform") if dropout_rate: # This is a cheaper form of attention dropout where we use to use # the same dropout decisions across batch elements and query positions, # but different decisions across heads and memory positions. v = tf.nn.dropout( v, 1.0 - dropout_rate, noise_shape=[num_heads, memory_rows, 1]) # query is [batch, length, hidden_size] # reshape and transpose it to [heads, batch * length, head_size] q = tf.reshape(q, [batch_size, length, num_heads, head_size_k]) q = tf.transpose(q, [2, 0, 1, 3]) q = tf.reshape(q, [num_heads, batch_size * length, head_size_k]) weights = tf.matmul(q, k, transpose_b=True) weights = tf.nn.softmax(weights) y = tf.matmul(weights, v) y = tf.reshape(y, [num_heads, batch_size, length, head_size_v]) y = tf.transpose(y, [1, 2, 0, 3]) y = tf.reshape(y, [batch_size, length, total_value_depth]) y.set_shape([None, None, total_value_depth]) y = common_layers.dense( y, output_depth, use_bias=False, name="output_transform") return y
[ "Attention over parameters.\n\n We use the same multi-headed attention as in the other layers, but the memory\n keys and values are model parameters. There are no linear transformation on\n the keys or values.\n\n We are also a bit more careful about memory usage, since the number of\n memory positions may be very large.\n\n Args:\n x: a Tensor with shape [batch, length_q, channels]\n total_key_depth: an integer\n total_value_depth: an integer\n output_depth: an integer\n memory_rows: an integer\n num_heads: an integer dividing total_key_depth and total_value_depth\n dropout_rate: a floating point number\n name: an optional string\n\n Returns:\n A Tensor with shape [batch, length_q, output_depth].\n " ]
Please provide a description of the function:def coordinate_tensor(shape, axis): if axis < 0: axis = tf.size(shape) + axis # Convert to positive for the one_hot indice r = tf.range(shape[axis]) r_shape = tf.one_hot( axis, tf.size(shape), on_value=-1, off_value=1, dtype=tf.int32) return tf.zeros(shape, dtype=tf.int32) + tf.reshape(r, r_shape)
[ "Return a tensor with given shape containing coordinate along given axis.\n\n Args:\n shape: a Tensor representing the shape of the output Tensor\n axis: an integer\n\n Returns:\n A tensor with shape shape and type tf.int32, where each elements its\n coordinate along the given axis.\n " ]
Please provide a description of the function:def self_attention_expert(x, batch_coordinate, mask_right=True, split_batch=False, attention_num_head=1, attention_kq_size=None, attention_v_size=None): depth = x.get_shape().as_list()[-1] length = common_layers.shape_list(batch_coordinate)[0] # Print a warning message if one of the expert isn't used (useful at # inference where summaries aren't used and the gating function don't add # noise) global _expert_count # Hack to make each expert have a unique id _expert_count += 1 length = tf.cond( tf.equal(length, 0), lambda: tf.Print( # pylint: disable=g-long-lambda length, [length], "Expert {} empty: ".format(_expert_count)), lambda: length, ) tf.summary.scalar("batch_size", length, family="experts_stats_batch_size") attention_kq_size = attention_kq_size or depth attention_v_size = attention_v_size or depth def length_not_null(x, batch_coordinate): # Mask between the sequences (not used if map_ids is used) bias_batch = attention_bias_coordinates(batch_coordinate) def add_or_set_if(prev_bias, new_bias, condition): if not condition: return prev_bias if prev_bias is None: return new_bias return prev_bias + new_bias def mask_and_call_attention(x): # Mask to prevent sequences of attending to the future length = common_layers.shape_list(x)[1] # x has shape [1, length,...] bias_past = tf.reshape( attention_bias_lower_triangle(length), [length, length]) # bias has shape [length, length] bias = None bias = add_or_set_if(bias, bias_past, mask_right) bias = add_or_set_if(bias, bias_batch, not split_batch) bias = tf.reshape(bias, [1, 1, length, length]) return multihead_attention( x, None, bias, total_key_depth=attention_kq_size, total_value_depth=attention_v_size, output_depth=depth, num_heads=attention_num_head, dropout_rate=0.0) if split_batch: out = expert_utils.map_ids(x, batch_coordinate, mask_and_call_attention) else: x = tf.reshape(x, [1, length, depth]) out = mask_and_call_attention(x) out = tf.squeeze(out, 0) return out # If the length is empty, just forward an empty tensor (avoid having to # evaluate multihead_attention with tensor having dim equal to zeros) out = tf.cond( tf.equal(length, 0), lambda: tf.zeros(shape=[0, depth], dtype=tf.float32, name="empty_out"), lambda: length_not_null(x, batch_coordinate), ) return out
[ "Implementing attention that runs inside each expert.\n\n Args:\n x: A tensor of shape[batch, depth]. Contains representations from\n different positions, which are lexicographically ordered.\n batch_coordinate: A tensor of shape [batch, 1] containing the batch\n coordinate of each element in x. This is needed to make sure that\n positions from different sequences don't attend to each other.\n mask_right: A bool. If true, we will not attend to positions on the right,\n just as decoder self attention.\n split_batch (bool): If True, each sequence of the batch is processed\n individually on a loop. If False, the sequences are processed all at\n once and a mask is applied to isolate the sequences from each others\n attention_num_head (int): number of attention heads\n attention_kq_size (int): dimension used for the attention key, and query\n attention_v_size (int): dimension used for the attention value\n\n Returns:\n out: A tensor of shape [batch, depth].\n example use:\n expert_utils.local_moe(\n ...\n expert_fn=functools.partial(self_attention_expert, mask_right=)\n )\n ", "Branch of the graph only evaluated when length isn't null.", "Add the bias together while considering the None case.", "Function applied once for each sequence of the batch." ]
Please provide a description of the function:def local_expert_attention(x, k, loss_coef, attention_num_experts, train=True, batch_coordinate=None, **kwargs): if batch_coordinate is None: batch_coordinate = tf.expand_dims( coordinate_tensor(common_layers.shape_list(x)[:-1], axis=0), axis=-1) with tf.variable_scope("local_expert_attention"): additional_dispatch_params = {"batch_coordinate": batch_coordinate} return expert_utils.local_moe( x, train, functools.partial(self_attention_expert, **kwargs), attention_num_experts, k=k, loss_coef=loss_coef, pass_x=True, pass_gates=False, additional_dispatch_params=additional_dispatch_params, )
[ "Attention using a mixture of experts.\n\n Positions sent to the same expert can attend to each other.\n The mixture of experts is \"local\" in that it is replicated on each\n datashard.\n\n local_moe flatten all batches so to avoid problems with padding (ex: all\n padding going to the same expert, self attention attending to non null\n padding tokens,...), the padding should be removed before.\n\n Args:\n x: a Tensor with shape [batch, length, depth] or [1, batch*length, depth]\n k: The number of experts to dispatch each example to\n loss_coef: a scalar. A multiplier for the expert loss\n attention_num_experts: The number of experts to use\n train: a boolean for the current mode\n batch_coordinate (tf.Tensor): int32 tensor of shape [1, batch*length, 1]\n containing the batch ids. If None, deduced from first dim of x.\n **kwargs: Arguments to forward to self_attention_expert\n\n Returns:\n y: a Tensor with shape [batch, length, depth]\n loss: a Scalar\n " ]
Please provide a description of the function:def expert_dot_product(q, k, v, info_q, info_k): length_q = common_layers.shape_list(q)[0] length_k = common_layers.shape_list(k)[0] depth_v = v.get_shape().as_list()[-1] # Create the mask bias = attention_bias_coordinates(info_q.coordinates, info_k.coordinates) if info_k.order is not None: bias += attention_bias_future(info_q.order, info_k.order) # Restore batch and head dimension q, k, v = [tf.expand_dims(tf.expand_dims(t, 0), 0) for t in (q, k, v)] def is_zero(): zeros = tf.zeros(shape=[1, 1, length_q, depth_v], dtype=tf.float32) zeros = tf.Print(zeros, [length_k, length_q], "length_k/length_q: ") return zeros def is_not_zero(): return dot_product_attention( q, k, v, bias=bias, # No image summary to avoid "Retval[0] does not have value" (because # inside a condition) make_image_summary=False, ) # TODO(epot): Should make sure a query gets at least one key. Because the # different sequences of a batch are merged, it's possible that a # query from a sequence only receive memory from another sequence, so # with the mask, the query will perform a softmax on -infinity values. # A hack could be to add at least one sequence of each batch on each group so # the query can attend to at least one element. # Softmax(Q.K)*V v_out = tf.cond( tf.logical_or(tf.equal(length_q, 0), tf.equal(length_k, 0)), is_zero, is_not_zero, ) # Remove batch and head dimension v_out = tf.squeeze(v_out, axis=0) v_out = tf.squeeze(v_out, axis=0) return v_out
[ "Perform dot product on a subset of the sequence.\n\n Can add a mask to the attention to prevent sequences to attend to each other\n and to prevent attention to the future.\n\n Args:\n q (tf.Tensor): Queries of shape [length_expert_q, depth_k]\n k (tf.Tensor): Keys of shape [length_expert_k, depth_k]\n v (tf.Tensor): Values of shape [length_expert_k, depth_v]\n info_q (BatchInfo): Batch info for queries. If None, no mask is added\n info_k (BatchInfo): Batch info for keys\n\n Returns:\n tf.Tensor: dot product attention output ([length_expert_q, depth_v])\n " ]
Please provide a description of the function:def dot_product_single_head(q, k, v, gates_q, gates_k, bi): nb_buckets = gates_q.get_shape().as_list()[-1] q_dispatcher = expert_utils.SparseDispatcher(nb_buckets, gates_q) k_dispatcher = expert_utils.SparseDispatcher(nb_buckets, gates_k) def eventually_dispatch(dispatcher, value): if value is not None: return dispatcher.dispatch(value) return [None] * nb_buckets # Iterate over every dispatched group list_v_out = [] for ( q_i, k_i, v_i, qbc, qbo, kbc, kbo, ) in zip( # Dispatch queries, keys and values q_dispatcher.dispatch(q), k_dispatcher.dispatch(k), k_dispatcher.dispatch(v), # Also dispatch the sequence positions and batch coordinates eventually_dispatch(q_dispatcher, bi.coordinates), eventually_dispatch(q_dispatcher, bi.order), eventually_dispatch(k_dispatcher, bi.coordinates), eventually_dispatch(k_dispatcher, bi.order), ): list_v_out.append( expert_dot_product( q_i, k_i, v_i, info_q=BatchInfo(coordinates=qbc, order=qbo), info_k=BatchInfo(coordinates=kbc, order=kbo))) # Combine all buckets together to restore the original length return q_dispatcher.combine(list_v_out)
[ "Perform a dot product attention on a single sequence on a single head.\n\n This function dispatch the q, k, v and loop over the buckets to compute the\n attention dot product on each subsequences.\n\n Args:\n q (tf.Tensor): [length_q, depth_q]\n k (tf.Tensor): [length_k, depth_q]\n v (tf.Tensor): [length_k, depth_v]\n gates_q (tf.Tensor): One-hot vector of shape [length_q, nb_buckets]\n gates_k (tf.Tensor): One-hot vector of shape [length_k, nb_buckets]\n bi (BatchInfo): Contains the batch coordinates and sequence order\n\n Returns:\n tf.Tensor: [length_q, depth_v]\n " ]
Please provide a description of the function:def map_fn_switch(fn, elems, use_map_fn=True, **kwargs): if use_map_fn: return tf.map_fn(fn, elems, **kwargs) elems_unpacked = (tf.unstack(e) for e in elems) out_unpacked = [fn(e) for e in zip(*elems_unpacked)] out = tf.stack(out_unpacked) return out
[ "Construct the graph with either tf.map_fn or a python for loop.\n\n This function is mainly for for benchmarking purpose.\n\n tf.map_fn is dynamic but is much slower than creating a static graph with\n for loop. However, having a for loop make the graph much longer to build\n and can consume too much RAM on distributed setting.\n\n Args:\n fn (fct): same that tf.map_fn but for now can only return a single tensor\n value (instead of a tuple of tensor for the general case)\n elems (tuple): same that tf.map_fn\n use_map_fn (bool): If True, tf.map_fn is used, if False, for _ in _: is used\n instead\n **kwargs: Additional tf.map_fn arguments (ignored if use_map_fn is False)\n\n Returns:\n tf.Tensor: the output of tf.map_fn\n " ]
Please provide a description of the function:def sparse_dot_product_attention(q, k, v, bi, use_map_fn, experts_params): batch_size, nb_heads, _, depth = common_layers.shape_list(q) @expert_utils.add_name_scope() def flatten_first_dims(x): # Case 1: Either constant batch size of size 1 or batch already flattened if x.get_shape().as_list()[0] == 1: return tf.squeeze(x, axis=0) # Case 2: Flatten batch dimension x = tf.transpose(x, perm=[1, 0, 2, 3]) x = tf.reshape(x, [nb_heads, -1, depth]) return x def flatten_batch(x): if x is None: return x return expert_utils.flatten_all_but_last(x) q = flatten_first_dims(q) k = flatten_first_dims(k) v = flatten_first_dims(v) bi = BatchInfo( coordinates=flatten_batch(bi.coordinates), order=flatten_batch(bi.order), ) # Unstack heads list_q = tf.unstack(q) # list[tf.Tensor(shape=[batch * length, depth])] list_k = tf.unstack(k) list_v = tf.unstack(v) list_gates_q = [] list_gates_k = [] total_loss = 0.0 # There might be a more optimized way to compute all heads at once for single_q, single_k, _ in zip(list_q, list_k, list_v): # Each head get its own dispatcher lhs_gating = LshGating( depth=single_q.get_shape().as_list()[-1], **experts_params) list_gates_q.append(lhs_gating.get_gates(single_q)) list_gates_k.append(lhs_gating.get_gates(single_k)) gates_q = tf.stack(list_gates_q) gates_k = tf.stack(list_gates_k) # Process each head separately. v_out = map_fn_switch( lambda args: dot_product_single_head(bi=bi, *args), elems=(q, k, v, gates_q, gates_k), dtype=(tf.float32), parallel_iterations=2, use_map_fn=use_map_fn, ) # Restore original shape as expected by multihead_attention if isinstance(batch_size, int) and batch_size == 1: v_out = tf.expand_dims(v_out, axis=0) # Restore batch_size = 1 else: v_out = tf.reshape(v_out, [nb_heads, batch_size, -1, depth]) v_out = tf.transpose(v_out, [1, 0, 2, 3]) return v_out, total_loss / nb_heads
[ "Sparse multihead self attention.\n\n Perform an approximation of the full multihead attention by dispatching\n the tokens using their keys/values. Thus the attention matrix are only\n computed each times on a subset of the tokens.\n\n Notes:\n * The function don't perform scaling here (multihead_attention does\n the /sqrt(depth)).\n * The padding should have been removed (so batch size should be 1 but length\n contains the elements from all different batches)\n * Right now, only self attention is supported so length_q and length_kv\n should be identical and the function will add triangular mask.\n * If bi.order is not None, The bias is added inside this function to\n prevent attention to the future.\n\n Args:\n q (tf.Tensor): Queries of shape [batch, heads, length_q, depth_k]\n k (tf.Tensor): Keys of shape [batch, heads, length_q, depth_k]\n v (tf.Tensor): Values of shape [batch, heads, length_kv, depth_v]\n bi (BatchInfo): Contains the batch coordinates and sequence order\n use_map_fn (bool): Use either tf.map_fn of python for loop to compute the\n heads separately\n experts_params (dict): Additional params for the local expert\n\n Returns:\n tf.Tensor: Approximation of Softmax(Q.K) * V, of shape\n [batch, heads, length_q, depth_v]\n ", "Reshape such that x is [num_heads, -1, depth]." ]
Please provide a description of the function:def dot_product_batched_head(q, k, v, gates_q, gates_k, mask_right=False): nb_buckets = common_layers.shape_list(gates_q)[-1] @expert_utils.add_name_scope() def get_dispatcher(gates): length = common_layers.shape_list(gates)[1] # Count the number of ones per batch (and keep the max value) nb_elems_to_dispatch = tf.reduce_sum(gates, axis=[1, 2]) nb_elems_to_dispatch = tf.reduce_max(nb_elems_to_dispatch) nb_elems_to_dispatch = tf.to_int32(nb_elems_to_dispatch) capacity = nb_elems_to_dispatch // nb_buckets * 2 # Capacity is hardcoded capacity = tf.minimum(length, capacity) tf.summary.scalar("dispatch_capacity", capacity, family="lsh") return expert_utils.TruncatingDispatcher(gates, capacity) def add_summary_capacity(x, prefix): # Monitor if capacity overflow x = x[0, ...] # Take first batch/head x = tf.reduce_sum(x, axis=0) tf.summary.scalar(prefix + "_min", tf.reduce_min(x), family="lsh") tf.summary.scalar(prefix + "_max", tf.reduce_max(x), family="lsh") tf.summary.histogram(prefix + "capacity_distribution", x, family="lsh") for i in range(3): # Show the first 3 buckets tf.summary.scalar("{}_{}".format(prefix, i), x[i], family="lsh") add_summary_capacity(gates_q, "q") add_summary_capacity(gates_k, "k") q_dispatcher = get_dispatcher(gates_q) k_dispatcher = get_dispatcher(gates_k) q = q_dispatcher.dispatch(q) k = k_dispatcher.dispatch(k) v = k_dispatcher.dispatch(v) # Bias of shape [batch*heads, nb_buckets, 1, capacity] broadcasted to every # queries bias = tf.expand_dims((k_dispatcher.nonpadding() - 1.0) * 1e9, 2) if mask_right: q_coordinate = tf.to_float( tf.expand_dims(q_dispatcher.length_coordinate(), 3)) k_coordinate = tf.to_float( tf.expand_dims(k_dispatcher.length_coordinate(), 2)) bias += tf.to_float(tf.greater(k_coordinate, q_coordinate)) * -1e9 # The sequence padding is not masked but is ignored on the next layers # q, k, v now have shape [batch*heads, nb_bucket, capacity, depth] # The buckets can be seen as different heads v_out = dot_product_attention(q, k, v, bias=bias) # Combine all buckets together to restore the original length return q_dispatcher.combine(v_out)
[ "Perform a dot product attention on a single sequence on a single head.\n\n This function dispatch the q, k, v and loop over the buckets to compute the\n attention dot product on each subsequences.\n\n Args:\n q (tf.Tensor): [batch*heads, length_q, depth_q]\n k (tf.Tensor): [batch*heads, length_k, depth_q]\n v (tf.Tensor): [batch*heads, length_k, depth_v]\n gates_q (tf.Tensor): One-hot of shape [batch*heads, length_q, nb_buckets]\n gates_k (tf.Tensor): One-hot of shape [batch*heads, length_k, nb_buckets]\n mask_right (bool): Add a bias to prevent attention to the future\n\n Returns:\n tf.Tensor: [length_q, depth_v]\n ", "Construct dispatcher for gates." ]
Please provide a description of the function:def sparse_dot_product_attention_truncated( q, k, v, bi, # Unused experts_params, use_map_fn=False, # Unused mask_right=False, ): # pylint: disable=unused-argument # Currently depth is the same for for q and v batch_size, nb_heads, _, depth = common_layers.shape_list(q) total_loss = 0.0 # Each head get its own dispatcher list_lsh = [LshGating(depth=depth, **experts_params) for _ in range(nb_heads)] @expert_utils.add_name_scope() def get_gates_head(x, add_first=False): length = common_layers.shape_list(x)[2] # Invert heads/batch x = tf.transpose(x, perm=[1, 0, 2, 3]) x = tf.reshape(x, [nb_heads, batch_size * length, depth]) list_x = tf.unstack(x) # list[tf.Tensor(shape=[batch * length, depth])] # Unstack heads list_gates = [] # There might be a more optimized way to compute all heads at once for lsh, single_x in zip(list_lsh, list_x): # Each head get its own dispatcher gates = lsh.get_gates(single_x) nb_buckets = gates.get_shape().as_list()[-1] # Reshape to [batch, length, depth] but should consider sequence # padding in that case (also dispatch the padding) gates = tf.reshape(gates, [batch_size, length, nb_buckets]) list_gates.append(gates) gates = tf.stack(list_gates) # Restore original shape gates = tf.reshape(gates, [nb_heads, batch_size, length, nb_buckets]) gates = tf.transpose(gates, [1, 0, 2, 3]) # Dispatch the first element to every gates to avoid empty buckets if add_first: gates = tf.maximum(gates, tf.reshape(tf.one_hot([0], length), [1, 1, length, 1])) return gates gates_q = get_gates_head(q) gates_k = get_gates_head(k, add_first=True) # [batch, heads, length, depth] => [batch*heads, length, depth] q, k, v, gates_q, gates_k = [ combine_first_two_dimensions(t) for t in (q, k, v, gates_q, gates_k) ] v_out = dot_product_batched_head(q, k, v, gates_q, gates_k, mask_right) # Restore original dimension v_out = tf.reshape(v_out, [batch_size, nb_heads, -1, depth]) return v_out, total_loss / nb_heads
[ "Sparse multihead self attention.\n\n Perform an approximation of the full multihead attention by dispatching\n the tokens using their keys/values. Thus the attention matrix are only\n computed each times on a subset of the tokens.\n\n Notes:\n * The function don't perform scaling here (multihead_attention does\n the /sqrt(depth)).\n * The padding should have been removed (so batch size should be 1 but length\n contains the elements from all different batches)\n * Right now, only self attention is supported so length_q and length_kv\n should be identical and the function will add triangular mask.\n * If bi.order is not None, The bias is added inside this function to\n prevent attention to the future.\n\n Args:\n q (tf.Tensor): Queries of shape [batch, heads, length_q, depth_k]\n k (tf.Tensor): Keys of shape [batch, heads, length_q, depth_k]\n v (tf.Tensor): Values of shape [batch, heads, length_kv, depth_v]\n bi (BatchInfo): Contains the batch coordinates and sequence order\n experts_params (dict): Additional params for the local expert\n use_map_fn (bool): Use either tf.map_fn of python for loop to compute the\n heads separately\n mask_right (bool):\n Returns:\n tf.Tensor: Approximation of Softmax(Q.K) * V, of shape\n [batch, heads, length_q, depth_v]\n ", "Return the gates for each heads of the current x.\n\n Args:\n x (tf.Tensor): of shape [batch, heads, length, depth]\n add_first (bool): if True, add the first element on each bucket\n\n Returns:\n tf.Tensor: gates of shape [batch, heads, length, num_buckets]\n " ]
Please provide a description of the function:def deconv_elems_1d(x, factor, out_depth=None): out_depth = out_depth or x.get_shape().as_list()[-1] x = tf.expand_dims(x, 1) # [batch_size, 1, length, depth] x = layers().Conv2DTranspose( filters=out_depth, kernel_size=(1, factor), strides=(1, factor), padding="valid", data_format="channels_last", )(x) # [batch_size, 1, length*factor, out_depth] x = tf.squeeze(x, 1) # [batch_size, length*factor, depth] return x
[ "Increase the length and change the dimensionality.\n\n Expand/project each positions of dim depth of the input into\n factor*tokens of dim out_depth\n\n Args:\n x (tf.Tensor): shape [batch_size, length, depth]\n factor (int): Multiplicative factor of each tokens.\n out_depth (int): Output depth (if None, keep depth constant)\n\n Returns:\n tf.Tensor: shape [batch_size, length*factor, out_depth]\n " ]
Please provide a description of the function:def conv_elems_1d(x, factor, out_depth=None): out_depth = out_depth or x.get_shape().as_list()[-1] # with tf.control_dependencies( # Dynamic assertion # [tf.assert_equal(tf.shape(x)[1] % factor, 0)]): x = tf.expand_dims(x, 1) # [batch_size, 1, length, depth] x = layers().Conv2D( filters=out_depth, kernel_size=(1, factor), strides=(1, factor), padding="valid", data_format="channels_last", )(x) # [batch_size, 1, length//factor, out_depth] x = tf.squeeze(x, 1) # [batch_size, length//factor, depth] return x
[ "Decrease the length and change the dimensionality.\n\n Merge/restore/compress factors positions of dim depth of the input into\n a single position of dim out_depth.\n This is basically just a strided convolution without overlap\n between each strides. The original length has to be divided by factor.\n\n Args:\n x (tf.Tensor): shape [batch_size, length, depth]\n factor (int): Length compression factor.\n out_depth (int): Output depth\n\n Returns:\n tf.Tensor: shape [batch_size, length//factor, out_depth]\n " ]
Please provide a description of the function:def local_reduction_attention(x, block_length, multihead_params): @expert_utils.add_name_scope() def dot_product_self_local_attention_flattened(q, k, v): _, num_head, _, depth = q.get_shape().as_list() # Extract the blocks def pad_and_reshape(x): length_x = common_layers.shape_list(x)[2] # Add some padding, but won't matter as the last block will never be # attended by the query (after compression) x = tf.pad(x, [[0, 0], [0, 0], [0, -length_x % block_length], [0, 0]]) x = tf.reshape( x, [ common_layers.shape_list(x)[0], # Batch num_head, # Head common_layers.shape_list(x)[2] // block_length, # Num blocks block_length, # Block length depth, # Depth ]) return x q, k, v = [pad_and_reshape(t) for t in (q, k, v)] # Perform attention on the flattened dot product logits = tf.matmul(q, k, transpose_b=True) logits = tf.reshape( logits, [ common_layers.shape_list(logits)[0], # Batch num_head, # Head common_layers.shape_list(logits)[2], # Num blocks block_length**2, # Flatten last dimension ]) weights = tf.nn.softmax(logits) weights = tf.reshape( weights, [ common_layers.shape_list(weights)[0], # Batch num_head, # Head common_layers.shape_list(weights)[2], # Num blocks block_length, block_length, # Restore the block length dimension ]) weights = tf.reduce_sum(weights, axis=3, keep_dims=True) # Compress block v_out = tf.matmul(weights, v) # [1, block_length] @ [block_length, depth] v_out = tf.squeeze(v_out, axis=3) return v_out return multihead_attention( x, None, bias=None, output_depth=x.get_shape().as_list()[-1], attention_type=dot_product_self_local_attention_flattened, **multihead_params)
[ "Reduce the length dimension using self attention.\n\n Args:\n x (tf.Tensor): float32 of shape [batch, length, depth]\n block_length (int): Block length for local attention (Compression factor)\n multihead_params (dict): parameters for multihead attention\n\n Returns:\n tf.Tensor: Compressed tensor of shape [batch, length // factor, depth]\n ", "Strided block local self-attention.\n\n No overlap between the blocks.\n\n Args:\n q (tf.Tensor): shape [batch, heads, length, depth_k]\n k (tf.Tensor): shape [batch, heads, length, depth_k]\n v (tf.Tensor): shape [batch, heads, length, depth_v]\n\n Returns:\n tf.Tensor: shape [batch, heads, length, depth_v]\n ", "Split the length dim into [num_block, block_length]." ]
Please provide a description of the function:def multihead_self_attention_reduced( x, memory_antecedent=None, bias=None, factor=None, multihead_params=None, nonlinearity="none", reduction_type="conv", add_mask=True, ): if not factor or not multihead_params: raise ValueError("factor and multihead_params should be set") if memory_antecedent is not None: raise NotImplementedError( "multihead_self_attention_reduced only works with self-attention") depth = x.get_shape().as_list()[-1] # Could try to have some overlap between the blocks but that would # create conv artifacts, would make it difficult to not attend to the future # within one group and the padding should be handled specially. # Reduce the memory dimension if reduction_type == "attention": memory_x = local_reduction_attention(x, factor, multihead_params) elif reduction_type == "conv": # With valid padding, the last block won't be computed (not attended anyway) memory_x = conv_elems_1d(x, factor) else: raise ValueError("Unknown reduction type {}".format(reduction_type)) if nonlinearity == "silu": memory_x *= tf.nn.sigmoid(memory_x) elif nonlinearity != "none": raise ValueError("Unknown non linearity {}".format(nonlinearity)) memory_x = tf.concat( # Add the first elem to make it attendable by everyone (otherwise the # first block cannot attend to anything) [x[:, :1, :], memory_x], axis=1, ) # Construct the bias @expert_utils.add_name_scope() def construct_bias_vectors(t, axis): length = tf.to_float(common_layers.shape_list(t)[1]) length_coordinates = tf.range(length, dtype=tf.float32) length_coordinates = tf.expand_dims(length_coordinates, axis=axis) # [1, length_k] or [length_q, 1] return length_coordinates if add_mask: # Create mask to prevent attention to the future bias = tf.to_float( tf.greater( # Because we add the first elem to the memory block and it can be # attended by anyone,we don't need to add +1 anymore to prevent self # attention Use * factor to make sure the last tokens of a block # cannot attend the block construct_bias_vectors(memory_x, 0) * factor, # +epsilon to avoid float equality construct_bias_vectors(x, 1) + 1e-3, )) * -1e9 bias = tf.expand_dims(bias, axis=0) bias = tf.expand_dims(bias, axis=0) # [1, 1, length_k, length_q] else: bias = None return multihead_attention( query_antecedent=x, memory_antecedent=memory_x, bias=bias, output_depth=depth, **multihead_params)
[ "Reduce the length dimension by compressing with conv.\n\n Args:\n x (tf.Tensor): float32 of shape [batch, length, depth]\n memory_antecedent (tf.Tensor): Unsupported for now\n bias (tf.Tensor): Ignored\n factor (int): compression factor for the memory sequence\n multihead_params (dict): parameters for multihead attention\n nonlinearity (str): Add some non-linearity after the memory block\n reduction_type (str): type of compression\n add_mask (bool): If True, add the bias to prevent attention to the future\n\n Returns:\n (tf.Tensor): float32 of shape [batch, length, depth]\n\n Raises:\n ValueError: If reduction_type or nonlinearity is invalid\n " ]
Please provide a description of the function:def scaled_dot_product_attention_simple(q, k, v, bias, name=None): with tf.variable_scope( name, default_name="scaled_dot_product_attention_simple"): scalar = tf.rsqrt(tf.to_float(common_layers.shape_list(q)[2])) logits = tf.matmul(q * scalar, k, transpose_b=True) if bias is not None: logits += bias weights = tf.nn.softmax(logits, name="attention_weights") if common_layers.should_generate_summaries(): tf.summary.image( "attention", tf.expand_dims(tf.pow(weights, 0.2), 3), max_outputs=1) return tf.matmul(weights, v)
[ "Scaled dot-product attention. One head. One spatial dimension.\n\n Args:\n q: a Tensor with shape [batch, length_q, depth_k]\n k: a Tensor with shape [batch, length_kv, depth_k]\n v: a Tensor with shape [batch, length_kv, depth_v]\n bias: optional Tensor broadcastable to [batch, length_q, length_kv]\n name: an optional string\n\n Returns:\n A Tensor.\n " ]
Please provide a description of the function:def multihead_self_attention_memory_efficient(x, bias, num_heads, head_size=None, epsilon=1e-6, forget=True, test_vars=None, name=None): io_size = x.get_shape().as_list()[-1] if head_size is None: assert io_size % num_heads == 0 head_size = io_size / num_heads def forward_internal(x, wqkv, wo, attention_bias, norm_scale, norm_bias): n = common_layers.layer_norm_compute(x, epsilon, norm_scale, norm_bias) wqkv_split = tf.unstack(wqkv, num=num_heads) wo_split = tf.unstack(wo, num=num_heads) y = 0 for h in range(num_heads): with tf.control_dependencies([y] if h > 0 else []): combined = tf.nn.conv1d(n, wqkv_split[h], 1, "SAME") q, k, v = tf.split(combined, 3, axis=2) o = scaled_dot_product_attention_simple(q, k, v, attention_bias) y += tf.nn.conv1d(o, wo_split[h], 1, "SAME") return y key = ( "multihead_self_attention_memory_efficient %s %s" % (num_heads, epsilon)) if not forget: forward_fn = forward_internal elif key in _function_cache: forward_fn = _function_cache[key] else: @function.Defun(compiled=True) def grad_fn(x, wqkv, wo, attention_bias, norm_scale, norm_bias, dy): with tf.control_dependencies([dy]): n = common_layers.layer_norm_compute(x, epsilon, norm_scale, norm_bias) wqkv_split = tf.unstack(wqkv, num=num_heads) wo_split = tf.unstack(wo, num=num_heads) deps = [] dwqkvs = [] dwos = [] dn = 0 for h in range(num_heads): with tf.control_dependencies(deps): combined = tf.nn.conv1d(n, wqkv_split[h], 1, "SAME") q, k, v = tf.split(combined, 3, axis=2) o = scaled_dot_product_attention_simple(q, k, v, attention_bias) partial_y = tf.nn.conv1d(o, wo_split[h], 1, "SAME") pdn, dwqkvh, dwoh = tf.gradients( ys=[partial_y], xs=[n, wqkv_split[h], wo_split[h]], grad_ys=[dy]) dn += pdn dwqkvs.append(dwqkvh) dwos.append(dwoh) deps = [dn, dwqkvh, dwoh] dwqkv = tf.stack(dwqkvs) dwo = tf.stack(dwos) with tf.control_dependencies(deps): dx, dnorm_scale, dnorm_bias = tf.gradients( ys=[n], xs=[x, norm_scale, norm_bias], grad_ys=[dn]) return (dx, dwqkv, dwo, tf.zeros_like(attention_bias), dnorm_scale, dnorm_bias) @function.Defun( grad_func=grad_fn, compiled=True, separate_compiled_gradients=True) def forward_fn(x, wqkv, wo, attention_bias, norm_scale, norm_bias): return forward_internal(x, wqkv, wo, attention_bias, norm_scale, norm_bias) _function_cache[key] = forward_fn if bias is not None: bias = tf.squeeze(bias, 1) with tf.variable_scope(name, default_name="multihead_attention", values=[x]): # TODO(noam): it would be nice to save memory by casting x to float16 # here, but this causes problems with the gradients. Figure out if there # is a way to leave the gradients as float32. if test_vars is not None: wqkv, wo, norm_scale, norm_bias = list(test_vars) else: wqkv = tf.get_variable( "wqkv", [num_heads, 1, io_size, 3 * head_size], initializer=tf.random_normal_initializer(stddev=io_size**-0.5)) wo = tf.get_variable( "wo", [num_heads, 1, head_size, io_size], initializer=tf.random_normal_initializer( stddev=(head_size * num_heads)**-0.5)) norm_scale, norm_bias = common_layers.layer_norm_vars(io_size) y = forward_fn(x, wqkv, wo, bias, norm_scale, norm_bias) y.set_shape(x.get_shape()) return y
[ "Multihead scaled-dot-product self-attention.\n\n Includes layer norm.\n\n Returns multihead-self-attention(layer_norm(x))\n\n Computes one attention head at a time to avoid exhausting memory.\n\n If forget=True, then forget all forwards activations and recompute on\n the backwards pass.\n\n Args:\n x: a Tensor with shape [batch, length, input_size]\n bias: an attention bias tensor broadcastable to [batch, 1, length, length]\n num_heads: an integer\n head_size: an optional integer - defaults to input_size/num_heads\n epsilon: a float, for layer norm\n forget: a boolean - forget forwards activations and recompute on backprop\n test_vars: optional tuple of variables for testing purposes\n name: an optional string\n\n Returns:\n A Tensor.\n ", "Forward function.", "Custom gradient function." ]
Please provide a description of the function:def _idx_to_bits(self, i): bits = bin(i)[2:].zfill(self.nb_hyperplanes) # Pad the bits str with 0 return [-1.0 if b == "0" else 1.0 for b in bits]
[ "Convert an group index to its bit representation." ]
Please provide a description of the function:def get_gates(self, x): # The balance loss don't propagate to the rest of the network x = tf.stop_gradient(x) # [length, depth] * [depth, nb_vectors * replicat] x = tf.matmul(x, self.t_vectors) # [length, nb_vector * replicat] x = tf.sign(x) # Get on which side of the hyperplane the keys are. # x = tf.reshape(x, [-1, nb_replicat, nb_vector]) # [length, replicat, nb_vector] * [nb_vector, 2^nb_vector - 1] x = tf.matmul(x, self.t_group, transpose_b=True) / self.nb_hyperplanes # We get a similarity score for each of the group between [-1, 1] # [length, (replicat,) 2^nb_vector - 1] # Do an argmax to get the most likely group for each replicat x = tf.argmax(x, axis=-1) # [length(, replicat)] # One-hot for compatibility with the sparse dispatcher x = tf.one_hot(x, self.nb_buckets) # TODO(epot): Use a loss to force an even distribution return x
[ "Return the bucket id of the given tensor.\n\n Args:\n x (tf.Tensor): float32 of shape [length, depth]\n\n Returns:\n tf.Tensor: One-hot vector int64 of shape [heads, length, nb_buckets]\n containing the id of the bucket\n " ]