tfm.vision.layers.MultilevelDetectionGenerator

Generates detected boxes with scores and classes for one-stage detector.

tfm.vision.layers.MultilevelDetectionGenerator(
    apply_nms: bool = True,
    pre_nms_top_k: int = 5000,
    pre_nms_score_threshold: float = 0.05,
    nms_iou_threshold: float = 0.5,
    max_num_detections: int = 100,
    nms_version: str = 'v1',
    use_cpu_nms: bool = False,
    soft_nms_sigma: Optional[float] = None,
    tflite_post_processing_config: Optional[Dict[str, Any]] = None,
    pre_nms_top_k_sharding_block: Optional[int] = None,
    nms_v3_refinements: Optional[int] = None,
    return_decoded: Optional[bool] = None,
    use_class_agnostic_nms: Optional[bool] = None,
    box_coder_weights: Optional[List[float]] = None,
    **kwargs
)

Args
`apply_nms`	A `bool` of whether or not apply non maximum suppression. If False, the decoded boxes and their scores are returned.
`pre_nms_top_k`	An `int` of the number of top scores proposals to be kept before applying NMS.
`pre_nms_score_threshold`	A `float` of the score threshold to apply before applying NMS. Proposals whose scores are below this threshold are thrown away.
`nms_iou_threshold`	A `float` in [0, 1], the NMS IoU threshold.
`max_num_detections`	An `int` of the final number of total detections to generate.
`nms_version`	A string of `batched`, `v1` or `v2` specifies NMS version
`use_cpu_nms`	A `bool` of whether or not enforce NMS to run on CPU.
`soft_nms_sigma`	A `float` representing the sigma parameter for Soft NMS. When soft_nms_sigma=0.0, we fall back to standard NMS.
`tflite_post_processing_config`	An optional dictionary containing post-processing parameters used for TFLite custom NMS op.
`pre_nms_top_k_sharding_block`	For v3 (edge tpu friendly) NMS, avoids creating long axis for pre_nms_top_k. Will do top_k in shards of size [num_classes, pre_nms_top_k_sharding_block * boxes_per_location]
`nms_v3_refinements`	For v3 (edge tpu friendly) NMS, sets how close result should be to standard NMS. When None, 2 is used. Here is some experimental deviations for different refinement values: if == 0, AP is reduced 1.0%, AR is reduced 5% on COCO if == 1, AP is reduced 0.2%, AR is reduced 2% on COCO if == 2, AP is reduced <0.1%, AR is reduced <1% on COCO
`return_decoded`	A `bool` of whether to return decoded boxes before NMS regardless of whether `apply_nms` is True or not.
`use_class_agnostic_nms`	A `bool` of whether non max suppression is operated on all the boxes using max scores across all classes.
`box_coder_weights`	An optional `list` of 4 positive floats to scale y, x, h, and w when encoding box coordinates. If set to None, does not perform scaling. For Faster RCNN, the open-source implementation recommends using [10.0, 10.0, 5.0, 5.0].
`**kwargs`	Additional keyword arguments passed to Layer.

Raises
`ValueError`	If `use_class_agnostic_nms` is required by `nms_version` is not specified as `v2`.

Attributes
`activity_regularizer`	Optional regularizer function for the output of this layer.
`compute_dtype`	The dtype of the layer's computations. This is equivalent to `Layer.dtype_policy.compute_dtype`. Unless mixed precision is used, this is the same as `Layer.dtype`, the dtype of the weights. Layers automatically cast their inputs to the compute dtype, which causes computations and the output to be in the compute dtype as well. This is done by the base Layer class in `Layer.call`, so you do not have to insert these casts if implementing your own layer. Layers often perform certain internal computations in higher precision when `compute_dtype` is float16 or bfloat16 for numeric stability. The output will still typically be float16 or bfloat16 in such cases.
`dtype`	The dtype of the layer weights. This is equivalent to `Layer.dtype_policy.variable_dtype`. Unless mixed precision is used, this is the same as `Layer.compute_dtype`, the dtype of the layer's computations.
`dtype_policy`	The dtype policy associated with this layer. This is an instance of a `tf.keras.mixed_precision.Policy`.
`dynamic`	Whether the layer is dynamic (eager-only); set in the constructor.
`input`	Retrieves the input tensor(s) of a layer. Only applicable if the layer has exactly one input, i.e. if it is connected to one incoming layer.
`input_spec`	`InputSpec` instance(s) describing the input format for this layer. When you create a layer subclass, you can set `self.input_spec` to enable the layer to run input compatibility checks when it is called. Consider a `Conv2D` layer: it can only be called on a single input tensor of rank 4. As such, you can set, in `__init__()`: `self.input_spec = tf.keras.layers.InputSpec(ndim=4)` Now, if you try to call the layer on an input that isn't rank 4 (for instance, an input of shape `(2,)`, it will raise a nicely-formatted error: `ValueError: Input 0 of layer conv2d is incompatible with the layer: expected ndim=4, found ndim=1. Full shape received: [2]` Input checks that can be specified via `input_spec` include: Structure (e.g. a single input, a list of 2 inputs, etc) Shape Rank (ndim) Dtype For more information, see `tf.keras.layers.InputSpec`.
`losses`	List of losses added using the `add_loss()` API. Variable regularization tensors are created when this property is accessed, so it is eager safe: accessing `losses` under a `tf.GradientTape` will propagate gradients back to the corresponding variables. `class MyLayer(tf.keras.layers.Layer):` `def call(self, inputs):` `self.add_loss(tf.abs(tf.reduce_mean(inputs)))` `return inputs` `l = MyLayer()` `l(np.ones((10, 1)))` `l.losses` `[1.0]` `inputs = tf.keras.Input(shape=(10,))` `x = tf.keras.layers.Dense(10)(inputs)` `outputs = tf.keras.layers.Dense(1)(x)` `model = tf.keras.Model(inputs, outputs)` `# Activity regularization.` `len(model.losses)` `0` `model.add_loss(tf.abs(tf.reduce_mean(x)))` `len(model.losses)` `1` `inputs = tf.keras.Input(shape=(10,))` `d = tf.keras.layers.Dense(10, kernel_initializer='ones')` `x = d(inputs)` `outputs = tf.keras.layers.Dense(1)(x)` `model = tf.keras.Model(inputs, outputs)` `# Weight regularization.` `model.add_loss(lambda: tf.reduce_mean(d.kernel))` `model.losses` `[<tf.Tensor: shape=(), dtype=float32, numpy=1.0>]`
`metrics`	List of metrics attached to the layer.
`non_trainable_weights`	List of all non-trainable weights tracked by this layer. Non-trainable weights are not updated during training. They are expected to be updated manually in `call()`.
`output`	Retrieves the output tensor(s) of a layer. Only applicable if the layer has exactly one output, i.e. if it is connected to one incoming layer.
`supports_masking`	Whether this layer supports computing a mask using `compute_mask`.
`trainable`
`trainable_weights`	List of all trainable weights tracked by this layer. Trainable weights are updated via gradient descent during training.
`variable_dtype`	Alias of `Layer.dtype`, the dtype of the weights.
`weights`	Returns the list of all layer variables/weights.

Methods

`add_loss`

add_loss(
    losses, **kwargs
)

Add loss tensor(s), potentially dependent on layer inputs.

Some losses (for instance, activity regularization losses) may be dependent on the inputs passed when calling a layer. Hence, when reusing the same layer on different inputs a and b, some entries in layer.losses may be dependent on a and some on b. This method automatically keeps track of dependencies.

This method can be used inside a subclassed layer or model's call function, in which case losses should be a Tensor or list of Tensors.

Example:

class MyLayer(tf.keras.layers.Layer):
  def call(self, inputs):
    self.add_loss(tf.abs(tf.reduce_mean(inputs)))
    return inputs

The same code works in distributed training: the input to add_loss() is treated like a regularization loss and averaged across replicas by the training loop (both built-in Model.fit() and compliant custom training loops).

The add_loss method can also be called directly on a Functional Model during construction. In this case, any loss Tensors passed to this Model must be symbolic and be able to be traced back to the model's Inputs. These losses become part of the model's topology and are tracked in get_config.

Example:

inputs = tf.keras.Input(shape=(10,))
x = tf.keras.layers.Dense(10)(inputs)
outputs = tf.keras.layers.Dense(1)(x)
model = tf.keras.Model(inputs, outputs)
# Activity regularization.
model.add_loss(tf.abs(tf.reduce_mean(x)))

If this is not the case for your loss (if, for example, your loss references a Variable of one of the model's layers), you can wrap your loss in a zero-argument lambda. These losses are not tracked as part of the model's topology since they can't be serialized.

Example:

inputs = tf.keras.Input(shape=(10,))
d = tf.keras.layers.Dense(10)
x = d(inputs)
outputs = tf.keras.layers.Dense(1)(x)
model = tf.keras.Model(inputs, outputs)
# Weight regularization.
model.add_loss(lambda: tf.reduce_mean(d.kernel))

Args
`losses`	Loss tensor, or list/tuple of tensors. Rather than tensors, losses may also be zero-argument callables which create a loss tensor.
`**kwargs`	Used for backwards compatibility only.

`build`

build(
    input_shape
)

Creates the variables of the layer (for subclass implementers).

This is a method that implementers of subclasses of Layer or Model can override if they need a state-creation step in-between layer instantiation and layer call. It is invoked automatically before the first execution of call().

This is typically used to create the weights of Layer subclasses (at the discretion of the subclass implementer).

Args
`input_shape`	Instance of `TensorShape`, or list of instances of `TensorShape` if the layer expects a list of inputs (one instance per input).

`build_from_config`

build_from_config(
    config
)

Builds the layer's states with the supplied config dict.

By default, this method calls the build(config["input_shape"]) method, which creates weights based on the layer's input shape in the supplied config. If your config contains other information needed to load the layer's state, you should override this method.

Args
`config`	Dict containing the input shape associated with this layer.

`compute_mask`

compute_mask(
    inputs, mask=None
)

Computes an output mask tensor.

Args
`inputs`	Tensor or list of tensors.
`mask`	Tensor or list of tensors.

Returns
None or a tensor (or list of tensors, one per output tensor of the layer).

`compute_output_shape`

compute_output_shape(
    input_shape
)

Computes the output shape of the layer.

This method will cause the layer's state to be built, if that has not happened before. This requires that the layer will later be used with inputs that match the input shape provided here.

Args
`input_shape`	Shape tuple (tuple of integers) or `tf.TensorShape`, or structure of shape tuples / `tf.TensorShape` instances (one per output tensor of the layer). Shape tuples can include None for free dimensions, instead of an integer.

Returns
A `tf.TensorShape` instance or structure of `tf.TensorShape` instances.

`count_params`

count_params()

Count the total number of scalars composing the weights.

Returns
An integer count.

Raises
`ValueError`	if the layer isn't yet built (in which case its weights aren't yet defined).

`from_config`

View source

@classmethod
from_config(
    config
)

Creates a layer from its config.

This method is the reverse of get_config, capable of instantiating the same layer from the config dictionary. It does not handle layer connectivity (handled by Network), nor weights (handled by set_weights).

Args
`config`	A Python dictionary, typically the output of get_config.

Returns
A layer instance.

`get_build_config`

get_build_config()

Returns a dictionary with the layer's input shape.

This method returns a config dict that can be used by build_from_config(config) to create all states (e.g. Variables and Lookup tables) needed by the layer.

By default, the config only contains the input shape that the layer was built with. If you're writing a custom layer that creates state in an unusual way, you should override this method to make sure this state is already created when Keras attempts to load its value upon model loading.

Returns
A dict containing the input shape associated with the layer.

`get_config`

View source

get_config()

Returns the config of the layer.

A layer config is a Python dictionary (serializable) containing the configuration of a layer. The same layer can be reinstantiated later (without its trained weights) from this configuration.

The config of a layer does not include connectivity information, nor the layer class name. These are handled by Network (one layer of abstraction above).

Note that get_config() does not guarantee to return a fresh copy of dict every time it is called. The callers should make a copy of the returned dict if they want to modify it.

Returns
Python dictionary.

`get_weights`

get_weights()

Returns the current weights of the layer, as NumPy arrays.

The weights of a layer represent the state of the layer. This function returns both trainable and non-trainable weight values associated with this layer as a list of NumPy arrays, which can in turn be used to load state into similarly parameterized layers.

For example, a Dense layer returns a list of two values: the kernel matrix and the bias vector. These can be used to set the weights of another Dense layer:

layer_a = tf.keras.layers.Dense(1,
  kernel_initializer=tf.constant_initializer(1.))
a_out = layer_a(tf.convert_to_tensor([[1., 2., 3.]]))
layer_a.get_weights()
[array([[1.],
       [1.],
       [1.]], dtype=float32), array([0.], dtype=float32)]
layer_b = tf.keras.layers.Dense(1,
  kernel_initializer=tf.constant_initializer(2.))
b_out = layer_b(tf.convert_to_tensor([[10., 20., 30.]]))
layer_b.get_weights()
[array([[2.],
       [2.],
       [2.]], dtype=float32), array([0.], dtype=float32)]
layer_b.set_weights(layer_a.get_weights())
layer_b.get_weights()
[array([[1.],
       [1.],
       [1.]], dtype=float32), array([0.], dtype=float32)]

Returns
Weights values as a list of NumPy arrays.

`load_own_variables`

load_own_variables(
    store
)

Loads the state of the layer.

You can override this method to take full control of how the state of the layer is loaded upon calling keras.models.load_model().

Args
`store`	Dict from which the state of the model will be loaded.

`save_own_variables`

save_own_variables(
    store
)

Saves the state of the layer.

You can override this method to take full control of how the state of the layer is saved upon calling model.save().

Args
`store`	Dict where the state of the model will be saved.

`set_weights`

set_weights(
    weights
)

Sets the weights of the layer, from NumPy arrays.

The weights of a layer represent the state of the layer. This function sets the weight values from numpy arrays. The weight values should be passed in the order they are created by the layer. Note that the layer's weights must be instantiated before calling this function, by calling the layer.

For example, a Dense layer returns a list of two values: the kernel matrix and the bias vector. These can be used to set the weights of another Dense layer:

layer_a = tf.keras.layers.Dense(1,
  kernel_initializer=tf.constant_initializer(1.))
a_out = layer_a(tf.convert_to_tensor([[1., 2., 3.]]))
layer_a.get_weights()
[array([[1.],
       [1.],
       [1.]], dtype=float32), array([0.], dtype=float32)]
layer_b = tf.keras.layers.Dense(1,
  kernel_initializer=tf.constant_initializer(2.))
b_out = layer_b(tf.convert_to_tensor([[10., 20., 30.]]))
layer_b.get_weights()
[array([[2.],
       [2.],
       [2.]], dtype=float32), array([0.], dtype=float32)]
layer_b.set_weights(layer_a.get_weights())
layer_b.get_weights()
[array([[1.],
       [1.],
       [1.]], dtype=float32), array([0.], dtype=float32)]

Args
`weights`	a list of NumPy arrays. The number of arrays and their shape must match number of the dimensions of the weights of the layer (i.e. it should match the output of `get_weights`).

Raises
`ValueError`	If the provided weights list does not match the layer's specifications.

`call`

View source

__call__(
    raw_boxes: Mapping[str, tf.Tensor],
    raw_scores: Mapping[str, tf.Tensor],
    anchor_boxes: Mapping[str, tf.Tensor],
    image_shape: tf.Tensor,
    raw_attributes: Optional[Mapping[str, tf.Tensor]] = None
) -> Mapping[str, Any]

Generates final detections.

Args
`raw_boxes`	A `dict` with keys representing FPN levels and values representing box tenors of shape `[batch, feature_h, feature_w, num_anchors * 4]`.
`raw_scores`	A `dict` with keys representing FPN levels and values representing logit tensors of shape `[batch, feature_h, feature_w, num_anchors * num_classes]`.
`anchor_boxes`	A `dict` with keys representing FPN levels and values representing anchor tenors of shape `[batch_size, K, 4]` representing the corresponding anchor boxes w.r.t `box_outputs`.
`image_shape`	A `tf.Tensor` of shape of [batch_size, 2] storing the image height and width w.r.t. the scaled image, i.e. the same image space as `box_outputs` and `anchor_boxes`.
`raw_attributes`	If not None, a `dict` of (attribute_name, attribute_prediction) pairs. `attribute_prediction` is a dict that contains keys representing FPN levels and values representing tenors of shape `[batch, feature_h, feature_w, num_anchors * attribute_size]`.

Returns

Returns
If `apply_nms` = True, the return is a dictionary with keys: `detection_boxes`: A `float` tf.Tensor of shape [batch, max_num_detections, 4] representing top detected boxes in [y1, x1, y2, x2]. `detection_scores`: A `float` tf.Tensor of shape [batch, max_num_detections] representing sorted confidence scores for detected boxes. The values are between [0, 1]. `detection_classes`: An `int` tf.Tensor of shape [batch, max_num_detections] representing classes for detected boxes. `num_detections`: An `int` tf.Tensor of shape [batch] only the first `num_detections` boxes are valid detections `detection_attributes`: A dict. Values of the dict is a `float` tf.Tensor of shape [batch, max_num_detections, attribute_size] representing attribute predictions for detected boxes. If `apply_nms` = False, the return is a dictionary with following keys. If `return_decoded` = True, the following items will also be included even if `apply_nms` = True: `decoded_boxes`: A `float` tf.Tensor of shape [batch, num_raw_boxes, 4] representing all the decoded boxes. `decoded_box_scores`: A `float` tf.Tensor of shape [batch, num_raw_boxes] representing socres of all the decoded boxes. `decoded_box_attributes`: A dict. Values in the dict is a `float` tf.Tensor of shape [batch, num_raw_boxes, attribute_size] representing attribute predictions of all the decoded boxes.

If apply_nms = True, the return is a dictionary with keys: detection_boxes: A float tf.Tensor of shape [batch, max_num_detections, 4] representing top detected boxes in [y1, x1, y2, x2]. detection_scores: A float tf.Tensor of shape [batch, max_num_detections] representing sorted confidence scores for detected boxes. The values are between [0, 1]. detection_classes: An int tf.Tensor of shape [batch, max_num_detections] representing classes for detected boxes. num_detections: An int tf.Tensor of shape [batch] only the first num_detections boxes are valid detections detection_attributes: A dict. Values of the dict is a float tf.Tensor of shape [batch, max_num_detections, attribute_size] representing attribute predictions for detected boxes. If apply_nms = False, the return is a dictionary with following keys. If return_decoded = True, the following items will also be included even if apply_nms = True: decoded_boxes: A float tf.Tensor of shape [batch, num_raw_boxes, 4] representing all the decoded boxes. decoded_box_scores: A float tf.Tensor of shape [batch, num_raw_boxes] representing socres of all the decoded boxes. decoded_box_attributes: A dict. Values in the dict is a float tf.Tensor of shape [batch, num_raw_boxes, attribute_size] representing attribute predictions of all the decoded boxes.

tfm.vision.layers.MultilevelDetectionGenerator

Args

Raises

Attributes

Methods

add_loss

Example:

Example:

Example:

build

build_from_config

compute_mask

compute_output_shape

count_params

from_config

get_build_config

get_config

get_weights

load_own_variables

save_own_variables

set_weights

__call__

`add_loss`

`build`

`build_from_config`

`compute_mask`

`compute_output_shape`

`count_params`

`from_config`

`get_build_config`

`get_config`

`get_weights`

`load_own_variables`

`save_own_variables`

`set_weights`

`call`