model.py 124.4 KB
Newer Older
W
Waleed Abdulla 已提交
1 2
"""
Mask R-CNN
C
Corey Hu 已提交
3
The main Mask R-CNN model implementation.
W
Waleed Abdulla 已提交
4 5 6 7 8 9 10 11 12 13

Copyright (c) 2017 Matterport, Inc.
Licensed under the MIT License (see LICENSE for details)
Written by Waleed Abdulla
"""

import os
import random
import datetime
import re
14
import math
W
Waleed Abdulla 已提交
15 16
import logging
from collections import OrderedDict
W
Waleed Abdulla 已提交
17
import multiprocessing
W
Waleed Abdulla 已提交
18
import numpy as np
19
import skimage.transform
W
Waleed Abdulla 已提交
20 21 22 23 24 25 26
import tensorflow as tf
import keras
import keras.backend as K
import keras.layers as KL
import keras.engine as KE
import keras.models as KM

J
jirka 已提交
27
from mrcnn import utils
W
Waleed Abdulla 已提交
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

# Requires TensorFlow 1.3+ and Keras 2.0.8+.
from distutils.version import LooseVersion
assert LooseVersion(tf.__version__) >= LooseVersion("1.3")
assert LooseVersion(keras.__version__) >= LooseVersion('2.0.8')


############################################################
#  Utility Functions
############################################################

def log(text, array=None):
    """Prints a text message. And, optionally, if a Numpy array is provided it
    prints it's shape, min, and max values.
    """
    if array is not None:
        text = text.ljust(25)
45
        text += ("shape: {:20}  min: {:10.5f}  max: {:10.5f}  {}".format(
W
Waleed Abdulla 已提交
46 47
            str(array.shape),
            array.min() if array.size else "",
48 49
            array.max() if array.size else "",
            array.dtype))
W
Waleed Abdulla 已提交
50 51 52 53
    print(text)


class BatchNorm(KL.BatchNormalization):
54 55
    """Extends the Keras BatchNormalization class to allow a central place
    to make changes if needed.
W
Waleed Abdulla 已提交
56 57

    Batch normalization has a negative effect on training if batches are small
58 59
    so this layer is often frozen (via setting in Config class) and functions
    as linear layer.
W
Waleed Abdulla 已提交
60 61
    """
    def call(self, inputs, training=None):
62 63 64 65
        """
        Note about training values:
            None: Train BN layers. This is the normal mode
            False: Freeze BN layers. Good when batch size is small
C
Corey Hu 已提交
66
            True: (don't use). Set layer in training mode even when making inferences
67 68
        """
        return super(self.__class__, self).call(inputs, training=training)
W
Waleed Abdulla 已提交
69 70


71 72
def compute_backbone_shapes(config, image_shape):
    """Computes the width and height of each stage of the backbone network.
73

74 75 76
    Returns:
        [N, (height, width)]. Where N is the number of stages
    """
77 78 79
    if callable(config.BACKBONE):
        return config.COMPUTE_BACKBONE_SHAPE(image_shape)

80 81 82 83 84 85 86 87
    # Currently supports ResNet only
    assert config.BACKBONE in ["resnet50", "resnet101"]
    return np.array(
        [[int(math.ceil(image_shape[0] / stride)),
            int(math.ceil(image_shape[1] / stride))]
            for stride in config.BACKBONE_STRIDES])


W
Waleed Abdulla 已提交
88 89 90 91 92 93 94 95
############################################################
#  Resnet Graph
############################################################

# Code adopted from:
# https://github.com/fchollet/deep-learning-models/blob/master/resnet50.py

def identity_block(input_tensor, kernel_size, filters, stage, block,
96
                   use_bias=True, train_bn=True):
W
Waleed Abdulla 已提交
97 98 99
    """The identity_block is the block that has no conv layer at shortcut
    # Arguments
        input_tensor: input tensor
C
Corey Hu 已提交
100
        kernel_size: default 3, the kernel size of middle conv layer at main path
W
Waleed Abdulla 已提交
101 102 103
        filters: list of integers, the nb_filters of 3 conv layer at main path
        stage: integer, current stage label, used for generating layer names
        block: 'a','b'..., current block label, used for generating layer names
104
        use_bias: Boolean. To use or not use a bias in conv layers.
C
Corey Hu 已提交
105
        train_bn: Boolean. Train or freeze Batch Norm layers
W
Waleed Abdulla 已提交
106 107 108 109 110 111 112
    """
    nb_filter1, nb_filter2, nb_filter3 = filters
    conv_name_base = 'res' + str(stage) + block + '_branch'
    bn_name_base = 'bn' + str(stage) + block + '_branch'

    x = KL.Conv2D(nb_filter1, (1, 1), name=conv_name_base + '2a',
                  use_bias=use_bias)(input_tensor)
113
    x = BatchNorm(name=bn_name_base + '2a')(x, training=train_bn)
W
Waleed Abdulla 已提交
114 115 116 117
    x = KL.Activation('relu')(x)

    x = KL.Conv2D(nb_filter2, (kernel_size, kernel_size), padding='same',
                  name=conv_name_base + '2b', use_bias=use_bias)(x)
118
    x = BatchNorm(name=bn_name_base + '2b')(x, training=train_bn)
W
Waleed Abdulla 已提交
119 120 121 122
    x = KL.Activation('relu')(x)

    x = KL.Conv2D(nb_filter3, (1, 1), name=conv_name_base + '2c',
                  use_bias=use_bias)(x)
123
    x = BatchNorm(name=bn_name_base + '2c')(x, training=train_bn)
W
Waleed Abdulla 已提交
124 125

    x = KL.Add()([x, input_tensor])
G
Gyuri Im 已提交
126
    x = KL.Activation('relu', name='res' + str(stage) + block + '_out')(x)
W
Waleed Abdulla 已提交
127 128 129
    return x


G
Gyuri Im 已提交
130
def conv_block(input_tensor, kernel_size, filters, stage, block,
131
               strides=(2, 2), use_bias=True, train_bn=True):
W
Waleed Abdulla 已提交
132 133 134
    """conv_block is the block that has a conv layer at shortcut
    # Arguments
        input_tensor: input tensor
C
Corey Hu 已提交
135
        kernel_size: default 3, the kernel size of middle conv layer at main path
W
Waleed Abdulla 已提交
136 137 138
        filters: list of integers, the nb_filters of 3 conv layer at main path
        stage: integer, current stage label, used for generating layer names
        block: 'a','b'..., current block label, used for generating layer names
139
        use_bias: Boolean. To use or not use a bias in conv layers.
C
Corey Hu 已提交
140
        train_bn: Boolean. Train or freeze Batch Norm layers
W
Waleed Abdulla 已提交
141 142 143 144 145 146 147 148 149
    Note that from stage 3, the first conv layer at main path is with subsample=(2,2)
    And the shortcut should have subsample=(2,2) as well
    """
    nb_filter1, nb_filter2, nb_filter3 = filters
    conv_name_base = 'res' + str(stage) + block + '_branch'
    bn_name_base = 'bn' + str(stage) + block + '_branch'

    x = KL.Conv2D(nb_filter1, (1, 1), strides=strides,
                  name=conv_name_base + '2a', use_bias=use_bias)(input_tensor)
150
    x = BatchNorm(name=bn_name_base + '2a')(x, training=train_bn)
W
Waleed Abdulla 已提交
151 152 153 154
    x = KL.Activation('relu')(x)

    x = KL.Conv2D(nb_filter2, (kernel_size, kernel_size), padding='same',
                  name=conv_name_base + '2b', use_bias=use_bias)(x)
155
    x = BatchNorm(name=bn_name_base + '2b')(x, training=train_bn)
W
Waleed Abdulla 已提交
156 157
    x = KL.Activation('relu')(x)

G
Gyuri Im 已提交
158 159
    x = KL.Conv2D(nb_filter3, (1, 1), name=conv_name_base +
                  '2c', use_bias=use_bias)(x)
160
    x = BatchNorm(name=bn_name_base + '2c')(x, training=train_bn)
W
Waleed Abdulla 已提交
161 162 163

    shortcut = KL.Conv2D(nb_filter3, (1, 1), strides=strides,
                         name=conv_name_base + '1', use_bias=use_bias)(input_tensor)
164
    shortcut = BatchNorm(name=bn_name_base + '1')(shortcut, training=train_bn)
W
Waleed Abdulla 已提交
165 166

    x = KL.Add()([x, shortcut])
G
Gyuri Im 已提交
167
    x = KL.Activation('relu', name='res' + str(stage) + block + '_out')(x)
W
Waleed Abdulla 已提交
168 169 170
    return x


171 172 173 174
def resnet_graph(input_image, architecture, stage5=False, train_bn=True):
    """Build a ResNet graph.
        architecture: Can be resnet50 or resnet101
        stage5: Boolean. If False, stage5 of the network is not created
C
Corey Hu 已提交
175
        train_bn: Boolean. Train or freeze Batch Norm layers
176
    """
W
Waleed Abdulla 已提交
177 178 179 180
    assert architecture in ["resnet50", "resnet101"]
    # Stage 1
    x = KL.ZeroPadding2D((3, 3))(input_image)
    x = KL.Conv2D(64, (7, 7), strides=(2, 2), name='conv1', use_bias=True)(x)
181
    x = BatchNorm(name='bn_conv1')(x, training=train_bn)
W
Waleed Abdulla 已提交
182 183 184
    x = KL.Activation('relu')(x)
    C1 = x = KL.MaxPooling2D((3, 3), strides=(2, 2), padding="same")(x)
    # Stage 2
185 186 187
    x = conv_block(x, 3, [64, 64, 256], stage=2, block='a', strides=(1, 1), train_bn=train_bn)
    x = identity_block(x, 3, [64, 64, 256], stage=2, block='b', train_bn=train_bn)
    C2 = x = identity_block(x, 3, [64, 64, 256], stage=2, block='c', train_bn=train_bn)
W
Waleed Abdulla 已提交
188
    # Stage 3
189 190 191 192
    x = conv_block(x, 3, [128, 128, 512], stage=3, block='a', train_bn=train_bn)
    x = identity_block(x, 3, [128, 128, 512], stage=3, block='b', train_bn=train_bn)
    x = identity_block(x, 3, [128, 128, 512], stage=3, block='c', train_bn=train_bn)
    C3 = x = identity_block(x, 3, [128, 128, 512], stage=3, block='d', train_bn=train_bn)
W
Waleed Abdulla 已提交
193
    # Stage 4
194
    x = conv_block(x, 3, [256, 256, 1024], stage=4, block='a', train_bn=train_bn)
W
Waleed Abdulla 已提交
195 196
    block_count = {"resnet50": 5, "resnet101": 22}[architecture]
    for i in range(block_count):
197
        x = identity_block(x, 3, [256, 256, 1024], stage=4, block=chr(98 + i), train_bn=train_bn)
W
Waleed Abdulla 已提交
198 199 200
    C4 = x
    # Stage 5
    if stage5:
201 202 203
        x = conv_block(x, 3, [512, 512, 2048], stage=5, block='a', train_bn=train_bn)
        x = identity_block(x, 3, [512, 512, 2048], stage=5, block='b', train_bn=train_bn)
        C5 = x = identity_block(x, 3, [512, 512, 2048], stage=5, block='c', train_bn=train_bn)
W
Waleed Abdulla 已提交
204 205 206 207 208 209 210 211 212 213 214
    else:
        C5 = None
    return [C1, C2, C3, C4, C5]


############################################################
#  Proposal Layer
############################################################

def apply_box_deltas_graph(boxes, deltas):
    """Applies the given deltas to the given boxes.
215 216
    boxes: [N, (y1, x1, y2, x2)] boxes to update
    deltas: [N, (dy, dx, log(dh), log(dw))] refinements to apply
W
Waleed Abdulla 已提交
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
    """
    # Convert to y, x, h, w
    height = boxes[:, 2] - boxes[:, 0]
    width = boxes[:, 3] - boxes[:, 1]
    center_y = boxes[:, 0] + 0.5 * height
    center_x = boxes[:, 1] + 0.5 * width
    # Apply deltas
    center_y += deltas[:, 0] * height
    center_x += deltas[:, 1] * width
    height *= tf.exp(deltas[:, 2])
    width *= tf.exp(deltas[:, 3])
    # Convert back to y1, x1, y2, x2
    y1 = center_y - 0.5 * height
    x1 = center_x - 0.5 * width
    y2 = y1 + height
    x2 = x1 + width
    result = tf.stack([y1, x1, y2, x2], axis=1, name="apply_box_deltas_out")
    return result


def clip_boxes_graph(boxes, window):
    """
239
    boxes: [N, (y1, x1, y2, x2)]
W
Waleed Abdulla 已提交
240 241
    window: [4] in the form y1, x1, y2, x2
    """
242
    # Split
W
Waleed Abdulla 已提交
243 244 245 246 247 248 249 250
    wy1, wx1, wy2, wx2 = tf.split(window, 4)
    y1, x1, y2, x2 = tf.split(boxes, 4, axis=1)
    # Clip
    y1 = tf.maximum(tf.minimum(y1, wy2), wy1)
    x1 = tf.maximum(tf.minimum(x1, wx2), wx1)
    y2 = tf.maximum(tf.minimum(y2, wy2), wy1)
    x2 = tf.maximum(tf.minimum(x2, wx2), wx1)
    clipped = tf.concat([y1, x1, y2, x2], axis=1, name="clipped_boxes")
251
    clipped.set_shape((clipped.shape[0], 4))
W
Waleed Abdulla 已提交
252 253 254 255 256 257 258
    return clipped


class ProposalLayer(KE.Layer):
    """Receives anchor scores and selects a subset to pass as proposals
    to the second stage. Filtering is done based on anchor scores and
    non-max suppression to remove overlaps. It also applies bounding
W
Waleed Abdulla 已提交
259
    box refinement deltas to anchors.
W
Waleed Abdulla 已提交
260 261 262 263

    Inputs:
        rpn_probs: [batch, anchors, (bg prob, fg prob)]
        rpn_bbox: [batch, anchors, (dy, dx, log(dh), log(dw))]
264
        anchors: [batch, (y1, x1, y2, x2)] anchors in normalized coordinates
W
Waleed Abdulla 已提交
265 266 267 268

    Returns:
        Proposals in normalized coordinates [batch, rois, (y1, x1, y2, x2)]
    """
G
Gyuri Im 已提交
269

270
    def __init__(self, proposal_count, nms_threshold, config=None, **kwargs):
W
Waleed Abdulla 已提交
271 272 273 274 275 276 277 278 279 280 281
        super(ProposalLayer, self).__init__(**kwargs)
        self.config = config
        self.proposal_count = proposal_count
        self.nms_threshold = nms_threshold

    def call(self, inputs):
        # Box Scores. Use the foreground class confidence. [Batch, num_rois, 1]
        scores = inputs[0][:, :, 1]
        # Box deltas [batch, num_rois, 4]
        deltas = inputs[1]
        deltas = deltas * np.reshape(self.config.RPN_BBOX_STD_DEV, [1, 1, 4])
282 283
        # Anchors
        anchors = inputs[2]
W
Waleed Abdulla 已提交
284 285 286

        # Improve performance by trimming to top anchors by score
        # and doing the rest on the smaller subset.
287
        pre_nms_limit = tf.minimum(self.config.PRE_NMS_LIMIT, tf.shape(anchors)[1])
G
Gyuri Im 已提交
288 289
        ix = tf.nn.top_k(scores, pre_nms_limit, sorted=True,
                         name="top_anchors").indices
W
Waleed Abdulla 已提交
290
        scores = utils.batch_slice([scores, ix], lambda x, y: tf.gather(x, y),
G
Gyuri Im 已提交
291
                                   self.config.IMAGES_PER_GPU)
W
Waleed Abdulla 已提交
292
        deltas = utils.batch_slice([deltas, ix], lambda x, y: tf.gather(x, y),
G
Gyuri Im 已提交
293
                                   self.config.IMAGES_PER_GPU)
294
        pre_nms_anchors = utils.batch_slice([anchors, ix], lambda a, x: tf.gather(a, x),
G
Gyuri Im 已提交
295 296
                                    self.config.IMAGES_PER_GPU,
                                    names=["pre_nms_anchors"])
W
Waleed Abdulla 已提交
297 298 299

        # Apply deltas to anchors to get refined anchors.
        # [batch, N, (y1, x1, y2, x2)]
300
        boxes = utils.batch_slice([pre_nms_anchors, deltas],
G
Gyuri Im 已提交
301 302 303
                                  lambda x, y: apply_box_deltas_graph(x, y),
                                  self.config.IMAGES_PER_GPU,
                                  names=["refined_anchors"])
W
Waleed Abdulla 已提交
304

305 306 307
        # Clip to image boundaries. Since we're in normalized coordinates,
        # clip to 0..1 range. [batch, N, (y1, x1, y2, x2)]
        window = np.array([0, 0, 1, 1], dtype=np.float32)
W
Waleed Abdulla 已提交
308
        boxes = utils.batch_slice(boxes,
G
Gyuri Im 已提交
309 310 311
                                  lambda x: clip_boxes_graph(x, window),
                                  self.config.IMAGES_PER_GPU,
                                  names=["refined_anchors_clipped"])
W
Waleed Abdulla 已提交
312 313 314 315 316 317

        # Filter out small boxes
        # According to Xinlei Chen's paper, this reduces detection accuracy
        # for small objects, so we're skipping it.

        # Non-max suppression
318
        def nms(boxes, scores):
W
Waleed Abdulla 已提交
319
            indices = tf.image.non_max_suppression(
320
                boxes, scores, self.proposal_count,
W
Waleed Abdulla 已提交
321
                self.nms_threshold, name="rpn_non_max_suppression")
322
            proposals = tf.gather(boxes, indices)
W
Waleed Abdulla 已提交
323
            # Pad if needed
W
Waleed Abdulla 已提交
324 325
            padding = tf.maximum(self.proposal_count - tf.shape(proposals)[0], 0)
            proposals = tf.pad(proposals, [(0, padding), (0, 0)])
W
Waleed Abdulla 已提交
326
            return proposals
327
        proposals = utils.batch_slice([boxes, scores], nms,
G
Gyuri Im 已提交
328
                                      self.config.IMAGES_PER_GPU)
W
Waleed Abdulla 已提交
329 330 331 332 333 334 335 336 337 338 339
        return proposals

    def compute_output_shape(self, input_shape):
        return (None, self.proposal_count, 4)


############################################################
#  ROIAlign Layer
############################################################

def log2_graph(x):
C
Corey Hu 已提交
340
    """Implementation of Log2. TF doesn't have a native implementation."""
W
Waleed Abdulla 已提交
341 342 343 344 345 346 347
    return tf.log(x) / tf.log(2.0)


class PyramidROIAlign(KE.Layer):
    """Implements ROI Pooling on multiple levels of the feature pyramid.

    Params:
348
    - pool_shape: [pool_height, pool_width] of the output pooled regions. Usually [7, 7]
W
Waleed Abdulla 已提交
349 350 351 352 353

    Inputs:
    - boxes: [batch, num_boxes, (y1, x1, y2, x2)] in normalized
             coordinates. Possibly padded with zeros if not enough
             boxes to fill the array.
354
    - image_meta: [batch, (meta data)] Image details. See compose_image_meta()
355
    - feature_maps: List of feature maps from different levels of the pyramid.
W
Waleed Abdulla 已提交
356 357 358
                    Each is [batch, height, width, channels]

    Output:
359
    Pooled regions in the shape: [batch, num_boxes, pool_height, pool_width, channels].
W
Waleed Abdulla 已提交
360 361 362
    The width and height are those specific in the pool_shape in the layer
    constructor.
    """
G
Gyuri Im 已提交
363

364
    def __init__(self, pool_shape, **kwargs):
W
Waleed Abdulla 已提交
365 366 367 368 369 370 371
        super(PyramidROIAlign, self).__init__(**kwargs)
        self.pool_shape = tuple(pool_shape)

    def call(self, inputs):
        # Crop boxes [batch, num_boxes, (y1, x1, y2, x2)] in normalized coords
        boxes = inputs[0]

372 373 374 375
        # Image meta
        # Holds details about the image. See compose_image_meta()
        image_meta = inputs[1]

W
Waleed Abdulla 已提交
376 377
        # Feature Maps. List of feature maps from different level of the
        # feature pyramid. Each is [batch, height, width, channels]
378
        feature_maps = inputs[2:]
W
Waleed Abdulla 已提交
379 380 381 382 383

        # Assign each ROI to a level in the pyramid based on the ROI area.
        y1, x1, y2, x2 = tf.split(boxes, 4, axis=2)
        h = y2 - y1
        w = x2 - x1
384 385
        # Use shape of first image. Images in a batch must have the same size.
        image_shape = parse_image_meta_graph(image_meta)['image_shape'][0]
W
Waleed Abdulla 已提交
386 387 388
        # Equation 1 in the Feature Pyramid Networks paper. Account for
        # the fact that our coordinates are normalized here.
        # e.g. a 224x224 ROI (in pixels) maps to P4
389
        image_area = tf.cast(image_shape[0] * image_shape[1], tf.float32)
G
Gyuri Im 已提交
390 391 392
        roi_level = log2_graph(tf.sqrt(h * w) / (224.0 / tf.sqrt(image_area)))
        roi_level = tf.minimum(5, tf.maximum(
            2, 4 + tf.cast(tf.round(roi_level), tf.int32)))
W
Waleed Abdulla 已提交
393 394 395 396 397 398 399 400 401
        roi_level = tf.squeeze(roi_level, 2)

        # Loop through levels and apply ROI pooling to each. P2 to P5.
        pooled = []
        box_to_level = []
        for i, level in enumerate(range(2, 6)):
            ix = tf.where(tf.equal(roi_level, level))
            level_boxes = tf.gather_nd(boxes, ix)

C
Corey Hu 已提交
402
            # Box indices for crop_and_resize.
W
Waleed Abdulla 已提交
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
            box_indices = tf.cast(ix[:, 0], tf.int32)

            # Keep track of which box is mapped to which level
            box_to_level.append(ix)

            # Stop gradient propogation to ROI proposals
            level_boxes = tf.stop_gradient(level_boxes)
            box_indices = tf.stop_gradient(box_indices)

            # Crop and Resize
            # From Mask R-CNN paper: "We sample four regular locations, so
            # that we can evaluate either max or average pooling. In fact,
            # interpolating only a single value at each bin center (without
            # pooling) is nearly as effective."
            #
            # Here we use the simplified approach of a single value per bin,
            # which is how it's done in tf.crop_and_resize()
            # Result: [batch * num_boxes, pool_height, pool_width, channels]
            pooled.append(tf.image.crop_and_resize(
                feature_maps[i], level_boxes, box_indices, self.pool_shape,
                method="bilinear"))

        # Pack pooled features into one tensor
        pooled = tf.concat(pooled, axis=0)

        # Pack box_to_level mapping into one array and add another
        # column representing the order of pooled boxes
        box_to_level = tf.concat(box_to_level, axis=0)
        box_range = tf.expand_dims(tf.range(tf.shape(box_to_level)[0]), 1)
        box_to_level = tf.concat([tf.cast(box_to_level, tf.int32), box_range],
                                 axis=1)

        # Rearrange pooled features to match the order of the original boxes
        # Sort box_to_level by batch then box index
        # TF doesn't have a way to sort by two columns, so merge them and sort.
        sorting_tensor = box_to_level[:, 0] * 100000 + box_to_level[:, 1]
G
Gyuri Im 已提交
439 440 441
        ix = tf.nn.top_k(sorting_tensor, k=tf.shape(
            box_to_level)[0]).indices[::-1]
        ix = tf.gather(box_to_level[:, 2], ix)
W
Waleed Abdulla 已提交
442 443 444
        pooled = tf.gather(pooled, ix)

        # Re-add the batch dimension
W
Waleed 已提交
445 446
        shape = tf.concat([tf.shape(boxes)[:2], tf.shape(pooled)[1:]], axis=0)
        pooled = tf.reshape(pooled, shape)
W
Waleed Abdulla 已提交
447 448 449
        return pooled

    def compute_output_shape(self, input_shape):
450
        return input_shape[0][:2] + self.pool_shape + (input_shape[2][-1], )
W
Waleed Abdulla 已提交
451 452 453 454 455 456


############################################################
#  Detection Target Layer
############################################################

457 458 459 460
def overlaps_graph(boxes1, boxes2):
    """Computes IoU overlaps between two sets of boxes.
    boxes1, boxes2: [N, (y1, x1, y2, x2)].
    """
C
Corey Hu 已提交
461
    # 1. Tile boxes2 and repeat boxes1. This allows us to compare
462
    # every boxes1 against every boxes2 without loops.
C
Corey Hu 已提交
463
    # TF doesn't have an equivalent to np.repeat() so simulate it
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
    # using tf.tile() and tf.reshape.
    b1 = tf.reshape(tf.tile(tf.expand_dims(boxes1, 1),
                            [1, 1, tf.shape(boxes2)[0]]), [-1, 4])
    b2 = tf.tile(boxes2, [tf.shape(boxes1)[0], 1])
    # 2. Compute intersections
    b1_y1, b1_x1, b1_y2, b1_x2 = tf.split(b1, 4, axis=1)
    b2_y1, b2_x1, b2_y2, b2_x2 = tf.split(b2, 4, axis=1)
    y1 = tf.maximum(b1_y1, b2_y1)
    x1 = tf.maximum(b1_x1, b2_x1)
    y2 = tf.minimum(b1_y2, b2_y2)
    x2 = tf.minimum(b1_x2, b2_x2)
    intersection = tf.maximum(x2 - x1, 0) * tf.maximum(y2 - y1, 0)
    # 3. Compute unions
    b1_area = (b1_y2 - b1_y1) * (b1_x2 - b1_x1)
    b2_area = (b2_y2 - b2_y1) * (b2_x2 - b2_x1)
    union = b1_area + b2_area - intersection
    # 4. Compute IoU and reshape to [boxes1, boxes2]
    iou = intersection / union
    overlaps = tf.reshape(iou, [tf.shape(boxes1)[0], tf.shape(boxes2)[0]])
    return overlaps


486
def detection_targets_graph(proposals, gt_class_ids, gt_boxes, gt_masks, config):
W
Waleed Abdulla 已提交
487 488 489 490 491 492
    """Generates detection targets for one image. Subsamples proposals and
    generates target class IDs, bounding box deltas, and masks for each.

    Inputs:
    proposals: [N, (y1, x1, y2, x2)] in normalized coordinates. Might
               be zero padded if there are not enough proposals.
493 494
    gt_class_ids: [MAX_GT_INSTANCES] int class IDs
    gt_boxes: [MAX_GT_INSTANCES, (y1, x1, y2, x2)] in normalized coordinates.
W
Waleed Abdulla 已提交
495 496 497 498 499 500 501
    gt_masks: [height, width, MAX_GT_INSTANCES] of boolean type.

    Returns: Target ROIs and corresponding class IDs, bounding box shifts,
    and masks.
    rois: [TRAIN_ROIS_PER_IMAGE, (y1, x1, y2, x2)] in normalized coordinates
    class_ids: [TRAIN_ROIS_PER_IMAGE]. Integer class IDs. Zero padded.
    deltas: [TRAIN_ROIS_PER_IMAGE, NUM_CLASSES, (dy, dx, log(dh), log(dw))]
W
Waleed Abdulla 已提交
502
            Class-specific bbox refinements.
W
Waleed Abdulla 已提交
503 504 505 506 507 508 509 510 511 512 513 514 515
    masks: [TRAIN_ROIS_PER_IMAGE, height, width). Masks cropped to bbox
           boundaries and resized to neural network output size.

    Note: Returned arrays might be zero padded if not enough target ROIs.
    """
    # Assertions
    asserts = [
        tf.Assert(tf.greater(tf.shape(proposals)[0], 0), [proposals],
                  name="roi_assertion"),
    ]
    with tf.control_dependencies(asserts):
        proposals = tf.identity(proposals)

W
Waleed Abdulla 已提交
516 517 518
    # Remove zero padding
    proposals, _ = trim_zeros_graph(proposals, name="trim_proposals")
    gt_boxes, non_zeros = trim_zeros_graph(gt_boxes, name="trim_gt_boxes")
519 520
    gt_class_ids = tf.boolean_mask(gt_class_ids, non_zeros,
                                   name="trim_gt_class_ids")
W
Waleed Abdulla 已提交
521 522
    gt_masks = tf.gather(gt_masks, tf.where(non_zeros)[:, 0], axis=2,
                         name="trim_gt_masks")
W
Waleed Abdulla 已提交
523

W
Waleed Abdulla 已提交
524 525 526 527 528 529 530 531 532 533 534
    # Handle COCO crowds
    # A crowd box in COCO is a bounding box around several instances. Exclude
    # them from training. A crowd box is given a negative class ID.
    crowd_ix = tf.where(gt_class_ids < 0)[:, 0]
    non_crowd_ix = tf.where(gt_class_ids > 0)[:, 0]
    crowd_boxes = tf.gather(gt_boxes, crowd_ix)
    crowd_masks = tf.gather(gt_masks, crowd_ix, axis=2)
    gt_class_ids = tf.gather(gt_class_ids, non_crowd_ix)
    gt_boxes = tf.gather(gt_boxes, non_crowd_ix)
    gt_masks = tf.gather(gt_masks, non_crowd_ix, axis=2)

W
Waleed Abdulla 已提交
535
    # Compute overlaps matrix [proposals, gt_boxes]
536
    overlaps = overlaps_graph(proposals, gt_boxes)
W
Waleed Abdulla 已提交
537

W
Waleed Abdulla 已提交
538 539 540 541 542
    # Compute overlaps with crowd boxes [anchors, crowds]
    crowd_overlaps = overlaps_graph(proposals, crowd_boxes)
    crowd_iou_max = tf.reduce_max(crowd_overlaps, axis=1)
    no_crowd_bool = (crowd_iou_max < 0.001)

C
Corey Hu 已提交
543
    # Determine positive and negative ROIs
W
Waleed Abdulla 已提交
544 545 546 547
    roi_iou_max = tf.reduce_max(overlaps, axis=1)
    # 1. Positive ROIs are those with >= 0.5 IoU with a GT box
    positive_roi_bool = (roi_iou_max >= 0.5)
    positive_indices = tf.where(positive_roi_bool)[:, 0]
W
Waleed Abdulla 已提交
548 549
    # 2. Negative ROIs are those with < 0.5 with every GT box. Skip crowds.
    negative_indices = tf.where(tf.logical_and(roi_iou_max < 0.5, no_crowd_bool))[:, 0]
W
Waleed Abdulla 已提交
550 551 552

    # Subsample ROIs. Aim for 33% positive
    # Positive ROIs
G
Gyuri Im 已提交
553 554
    positive_count = int(config.TRAIN_ROIS_PER_IMAGE *
                         config.ROI_POSITIVE_RATIO)
W
Waleed Abdulla 已提交
555
    positive_indices = tf.random_shuffle(positive_indices)[:positive_count]
W
Waleed Abdulla 已提交
556 557
    positive_count = tf.shape(positive_indices)[0]
    # Negative ROIs. Add enough to maintain positive:negative ratio.
558 559
    r = 1.0 / config.ROI_POSITIVE_RATIO
    negative_count = tf.cast(r * tf.cast(positive_count, tf.float32), tf.int32) - positive_count
W
Waleed Abdulla 已提交
560 561 562 563 564 565 566
    negative_indices = tf.random_shuffle(negative_indices)[:negative_count]
    # Gather selected ROIs
    positive_rois = tf.gather(proposals, positive_indices)
    negative_rois = tf.gather(proposals, negative_indices)

    # Assign positive ROIs to GT boxes.
    positive_overlaps = tf.gather(overlaps, positive_indices)
567 568 569 570 571
    roi_gt_box_assignment = tf.cond(
        tf.greater(tf.shape(positive_overlaps)[1], 0),
        true_fn = lambda: tf.argmax(positive_overlaps, axis=1),
        false_fn = lambda: tf.cast(tf.constant([]),tf.int64)
    )
W
Waleed Abdulla 已提交
572
    roi_gt_boxes = tf.gather(gt_boxes, roi_gt_box_assignment)
573
    roi_gt_class_ids = tf.gather(gt_class_ids, roi_gt_box_assignment)
W
Waleed Abdulla 已提交
574 575

    # Compute bbox refinement for positive ROIs
576
    deltas = utils.box_refinement_graph(positive_rois, roi_gt_boxes)
W
Waleed Abdulla 已提交
577 578 579 580 581 582 583 584 585 586 587
    deltas /= config.BBOX_STD_DEV

    # Assign positive ROIs to GT masks
    # Permute masks to [N, height, width, 1]
    transposed_masks = tf.expand_dims(tf.transpose(gt_masks, [2, 0, 1]), -1)
    # Pick the right mask for each ROI
    roi_masks = tf.gather(transposed_masks, roi_gt_box_assignment)

    # Compute mask targets
    boxes = positive_rois
    if config.USE_MINI_MASK:
C
Corey Hu 已提交
588
        # Transform ROI coordinates from normalized image space
W
Waleed Abdulla 已提交
589 590
        # to normalized mini-mask space.
        y1, x1, y2, x2 = tf.split(positive_rois, 4, axis=1)
591
        gt_y1, gt_x1, gt_y2, gt_x2 = tf.split(roi_gt_boxes, 4, axis=1)
W
Waleed Abdulla 已提交
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
        gt_h = gt_y2 - gt_y1
        gt_w = gt_x2 - gt_x1
        y1 = (y1 - gt_y1) / gt_h
        x1 = (x1 - gt_x1) / gt_w
        y2 = (y2 - gt_y1) / gt_h
        x2 = (x2 - gt_x1) / gt_w
        boxes = tf.concat([y1, x1, y2, x2], 1)
    box_ids = tf.range(0, tf.shape(roi_masks)[0])
    masks = tf.image.crop_and_resize(tf.cast(roi_masks, tf.float32), boxes,
                                     box_ids,
                                     config.MASK_SHAPE)
    # Remove the extra dimension from masks.
    masks = tf.squeeze(masks, axis=3)

    # Threshold mask pixels at 0.5 to have GT masks be 0 or 1 to use with
    # binary cross entropy loss.
    masks = tf.round(masks)

    # Append negative ROIs and pad bbox deltas and masks that
    # are not used for negative ROIs with zeros.
    rois = tf.concat([positive_rois, negative_rois], axis=0)
    N = tf.shape(negative_rois)[0]
    P = tf.maximum(config.TRAIN_ROIS_PER_IMAGE - tf.shape(rois)[0], 0)
    rois = tf.pad(rois, [(0, P), (0, 0)])
G
Gyuri Im 已提交
616 617 618 619
    roi_gt_boxes = tf.pad(roi_gt_boxes, [(0, N + P), (0, 0)])
    roi_gt_class_ids = tf.pad(roi_gt_class_ids, [(0, N + P)])
    deltas = tf.pad(deltas, [(0, N + P), (0, 0)])
    masks = tf.pad(masks, [[0, N + P], (0, 0), (0, 0)])
W
Waleed Abdulla 已提交
620

621
    return rois, roi_gt_class_ids, deltas, masks
W
Waleed Abdulla 已提交
622 623 624


class DetectionTargetLayer(KE.Layer):
W
Waleed Abdulla 已提交
625
    """Subsamples proposals and generates target box refinement, class_ids,
W
Waleed Abdulla 已提交
626 627 628 629 630
    and masks for each.

    Inputs:
    proposals: [batch, N, (y1, x1, y2, x2)] in normalized coordinates. Might
               be zero padded if there are not enough proposals.
631 632 633
    gt_class_ids: [batch, MAX_GT_INSTANCES] Integer class IDs.
    gt_boxes: [batch, MAX_GT_INSTANCES, (y1, x1, y2, x2)] in normalized
              coordinates.
W
Waleed Abdulla 已提交
634 635 636 637 638 639 640
    gt_masks: [batch, height, width, MAX_GT_INSTANCES] of boolean type

    Returns: Target ROIs and corresponding class IDs, bounding box shifts,
    and masks.
    rois: [batch, TRAIN_ROIS_PER_IMAGE, (y1, x1, y2, x2)] in normalized
          coordinates
    target_class_ids: [batch, TRAIN_ROIS_PER_IMAGE]. Integer class IDs.
G
Gyuri Im 已提交
641
    target_deltas: [batch, TRAIN_ROIS_PER_IMAGE, NUM_CLASSES,
W
Waleed Abdulla 已提交
642
                    (dy, dx, log(dh), log(dw), class_id)]
W
Waleed Abdulla 已提交
643
                   Class-specific bbox refinements.
W
Waleed Abdulla 已提交
644 645 646 647 648 649
    target_mask: [batch, TRAIN_ROIS_PER_IMAGE, height, width)
                 Masks cropped to bbox boundaries and resized to neural
                 network output size.

    Note: Returned arrays might be zero padded if not enough target ROIs.
    """
G
Gyuri Im 已提交
650

W
Waleed Abdulla 已提交
651 652 653 654 655 656
    def __init__(self, config, **kwargs):
        super(DetectionTargetLayer, self).__init__(**kwargs)
        self.config = config

    def call(self, inputs):
        proposals = inputs[0]
657 658 659
        gt_class_ids = inputs[1]
        gt_boxes = inputs[2]
        gt_masks = inputs[3]
W
Waleed Abdulla 已提交
660 661 662 663 664

        # Slice the batch and run a graph for each slice
        # TODO: Rename target_bbox to target_deltas for clarity
        names = ["rois", "target_class_ids", "target_bbox", "target_mask"]
        outputs = utils.batch_slice(
665
            [proposals, gt_class_ids, gt_boxes, gt_masks],
G
Gyuri Im 已提交
666 667
            lambda w, x, y, z: detection_targets_graph(
                w, x, y, z, self.config),
W
Waleed Abdulla 已提交
668 669 670 671 672 673
            self.config.IMAGES_PER_GPU, names=names)
        return outputs

    def compute_output_shape(self, input_shape):
        return [
            (None, self.config.TRAIN_ROIS_PER_IMAGE, 4),  # rois
674
            (None, self.config.TRAIN_ROIS_PER_IMAGE),  # class_ids
W
Waleed Abdulla 已提交
675 676 677 678 679 680 681 682 683 684 685 686 687
            (None, self.config.TRAIN_ROIS_PER_IMAGE, 4),  # deltas
            (None, self.config.TRAIN_ROIS_PER_IMAGE, self.config.MASK_SHAPE[0],
             self.config.MASK_SHAPE[1])  # masks
        ]

    def compute_mask(self, inputs, mask=None):
        return [None, None, None, None]


############################################################
#  Detection Layer
############################################################

688 689 690 691 692 693 694 695 696 697 698 699
def refine_detections_graph(rois, probs, deltas, window, config):
    """Refine classified proposals and filter overlaps and return final
    detections.

    Inputs:
        rois: [N, (y1, x1, y2, x2)] in normalized coordinates
        probs: [N, num_classes]. Class probabilities.
        deltas: [N, num_classes, (dy, dx, log(dh), log(dw))]. Class-specific
                bounding box deltas.
        window: (y1, x1, y2, x2) in image coordinates. The part of the image
            that contains the image excluding the padding.

700
    Returns detections shaped: [N, (y1, x1, y2, x2, class_id, score)] where
701
        coordinates are normalized.
702 703 704 705
    """
    # Class IDs per ROI
    class_ids = tf.argmax(probs, axis=1, output_type=tf.int32)
    # Class probability of the top class of each ROI
706 707
    indices = tf.stack([tf.range(probs.shape[0]), class_ids], axis=1)
    class_scores = tf.gather_nd(probs, indices)
708
    # Class-specific bounding box deltas
709
    deltas_specific = tf.gather_nd(deltas, indices)
710 711 712 713 714 715
    # Apply bounding box deltas
    # Shape: [boxes, (y1, x1, y2, x2)] in normalized coordinates
    refined_rois = apply_box_deltas_graph(
        rois, deltas_specific * config.BBOX_STD_DEV)
    # Clip boxes to image window
    refined_rois = clip_boxes_graph(refined_rois, window)
716

717 718 719
    # TODO: Filter out boxes with zero area

    # Filter out background boxes
720
    keep = tf.where(class_ids > 0)[:, 0]
721 722
    # Filter out low confidence boxes
    if config.DETECTION_MIN_CONFIDENCE:
723 724 725 726
        conf_keep = tf.where(class_scores >= config.DETECTION_MIN_CONFIDENCE)[:, 0]
        keep = tf.sets.set_intersection(tf.expand_dims(keep, 0),
                                        tf.expand_dims(conf_keep, 0))
        keep = tf.sparse_tensor_to_dense(keep)[0]
727 728

    # Apply per-class NMS
729
    # 1. Prepare variables
C
Cory Pruce 已提交
730 731 732
    pre_nms_class_ids = tf.gather(class_ids, keep)
    pre_nms_scores = tf.gather(class_scores, keep)
    pre_nms_rois = tf.gather(refined_rois,   keep)
733
    unique_pre_nms_class_ids = tf.unique(pre_nms_class_ids)[0]
734

735 736 737 738
    def nms_keep_map(class_id):
        """Apply Non-Maximum Suppression on ROIs of the given class."""
        # Indices of ROIs of the given class
        ixs = tf.where(tf.equal(pre_nms_class_ids, class_id))[:, 0]
739 740
        # Apply NMS
        class_keep = tf.image.non_max_suppression(
741
                tf.gather(pre_nms_rois, ixs),
742
                tf.gather(pre_nms_scores, ixs),
743
                max_output_size=config.DETECTION_MAX_INSTANCES,
744
                iou_threshold=config.DETECTION_NMS_THRESHOLD)
C
Corey Hu 已提交
745
        # Map indices
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
        class_keep = tf.gather(keep, tf.gather(ixs, class_keep))
        # Pad with -1 so returned tensors have the same shape
        gap = config.DETECTION_MAX_INSTANCES - tf.shape(class_keep)[0]
        class_keep = tf.pad(class_keep, [(0, gap)],
                            mode='CONSTANT', constant_values=-1)
        # Set shape so map_fn() can infer result shape
        class_keep.set_shape([config.DETECTION_MAX_INSTANCES])
        return class_keep

    # 2. Map over class IDs
    nms_keep = tf.map_fn(nms_keep_map, unique_pre_nms_class_ids,
                         dtype=tf.int64)
    # 3. Merge results into one list, and remove -1 padding
    nms_keep = tf.reshape(nms_keep, [-1])
    nms_keep = tf.gather(nms_keep, tf.where(nms_keep > -1)[:, 0])
    # 4. Compute intersection between keep and nms_keep
    keep = tf.sets.set_intersection(tf.expand_dims(keep, 0),
                                    tf.expand_dims(nms_keep, 0))
    keep = tf.sparse_tensor_to_dense(keep)[0]
765
    # Keep top detections
766
    roi_count = config.DETECTION_MAX_INSTANCES
767 768 769
    class_scores_keep = tf.gather(class_scores, keep)
    num_keep = tf.minimum(tf.shape(class_scores_keep)[0], roi_count)
    top_ids = tf.nn.top_k(class_scores_keep, k=num_keep, sorted=True)[1]
770
    keep = tf.gather(keep, top_ids)
S
Shenoy 已提交
771

772
    # Arrange output as [N, (y1, x1, y2, x2, class_id, score)]
773
    # Coordinates are normalized.
774
    detections = tf.concat([
775
        tf.gather(refined_rois, keep),
776 777 778
        tf.to_float(tf.gather(class_ids, keep))[..., tf.newaxis],
        tf.gather(class_scores, keep)[..., tf.newaxis]
        ], axis=1)
779 780

    # Pad with zeros if detections < DETECTION_MAX_INSTANCES
781 782 783
    gap = config.DETECTION_MAX_INSTANCES - tf.shape(detections)[0]
    detections = tf.pad(detections, [(0, gap), (0, 0)], "CONSTANT")
    return detections
784

W
Waleed Abdulla 已提交
785 786 787 788 789 790

class DetectionLayer(KE.Layer):
    """Takes classified proposal boxes and their bounding box deltas and
    returns the final detection boxes.

    Returns:
791
    [batch, num_detections, (y1, x1, y2, x2, class_id, class_score)] where
792
    coordinates are normalized.
W
Waleed Abdulla 已提交
793
    """
G
Gyuri Im 已提交
794

W
Waleed Abdulla 已提交
795 796 797 798 799
    def __init__(self, config=None, **kwargs):
        super(DetectionLayer, self).__init__(**kwargs)
        self.config = config

    def call(self, inputs):
800
        rois = inputs[0]
801
        mrcnn_class = inputs[1]
802 803
        mrcnn_bbox = inputs[2]
        image_meta = inputs[3]
804

805 806 807 808 809 810 811
        # Get windows of images in normalized coordinates. Windows are the area
        # in the image that excludes the padding.
        # Use the shape of the first image in the batch to normalize the window
        # because we know that all images get resized to the same size.
        m = parse_image_meta_graph(image_meta)
        image_shape = m['image_shape'][0]
        window = norm_boxes_graph(m['window'], image_shape[:2])
812

813
        # Run detection refinement graph on each item in the batch
814
        detections_batch = utils.batch_slice(
815 816 817
            [rois, mrcnn_class, mrcnn_bbox, window],
            lambda x, y, w, z: refine_detections_graph(x, y, w, z, self.config),
            self.config.IMAGES_PER_GPU)
818 819

        # Reshape output
820 821
        # [batch, num_detections, (y1, x1, y2, x2, class_score)] in
        # normalized coordinates
822
        return tf.reshape(
823 824
            detections_batch,
            [self.config.BATCH_SIZE, self.config.DETECTION_MAX_INSTANCES, 6])
825

W
Waleed Abdulla 已提交
826 827 828 829
    def compute_output_shape(self, input_shape):
        return (None, self.config.DETECTION_MAX_INSTANCES, 6)


W
Waleed Abdulla 已提交
830 831 832
############################################################
#  Region Proposal Network (RPN)
############################################################
W
Waleed Abdulla 已提交
833 834 835 836 837 838 839 840 841 842

def rpn_graph(feature_map, anchors_per_location, anchor_stride):
    """Builds the computation graph of Region Proposal Network.

    feature_map: backbone features [batch, height, width, depth]
    anchors_per_location: number of anchors per pixel in the feature map
    anchor_stride: Controls the density of anchors. Typically 1 (anchors for
                   every pixel in the feature map), or 2 (every other pixel).

    Returns:
843 844 845
        rpn_class_logits: [batch, H * W * anchors_per_location, 2] Anchor classifier logits (before softmax)
        rpn_probs: [batch, H * W * anchors_per_location, 2] Anchor classifier probabilities.
        rpn_bbox: [batch, H * W * anchors_per_location, (dy, dx, log(dh), log(dw))] Deltas to be
W
Waleed Abdulla 已提交
846 847
                  applied to anchors.
    """
C
Corey Hu 已提交
848 849
    # TODO: check if stride of 2 causes alignment issues if the feature map
    # is not even.
W
Waleed Abdulla 已提交
850 851 852 853 854 855 856 857 858 859 860 861 862 863
    # Shared convolutional base of the RPN
    shared = KL.Conv2D(512, (3, 3), padding='same', activation='relu',
                       strides=anchor_stride,
                       name='rpn_conv_shared')(feature_map)

    # Anchor Score. [batch, height, width, anchors per location * 2].
    x = KL.Conv2D(2 * anchors_per_location, (1, 1), padding='valid',
                  activation='linear', name='rpn_class_raw')(shared)

    # Reshape to [batch, anchors, 2]
    rpn_class_logits = KL.Lambda(
        lambda t: tf.reshape(t, [tf.shape(t)[0], -1, 2]))(x)

    # Softmax on last dimension of BG/FG.
G
Gyuri Im 已提交
864 865
    rpn_probs = KL.Activation(
        "softmax", name="rpn_class_xxx")(rpn_class_logits)
W
Waleed Abdulla 已提交
866

867
    # Bounding box refinement. [batch, H, W, anchors per location * depth]
W
Waleed Abdulla 已提交
868
    # where depth is [x, y, log(w), log(h)]
G
Gyuri Im 已提交
869
    x = KL.Conv2D(anchors_per_location * 4, (1, 1), padding="valid",
W
Waleed Abdulla 已提交
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
                  activation='linear', name='rpn_bbox_pred')(shared)

    # Reshape to [batch, anchors, 4]
    rpn_bbox = KL.Lambda(lambda t: tf.reshape(t, [tf.shape(t)[0], -1, 4]))(x)

    return [rpn_class_logits, rpn_probs, rpn_bbox]


def build_rpn_model(anchor_stride, anchors_per_location, depth):
    """Builds a Keras model of the Region Proposal Network.
    It wraps the RPN graph so it can be used multiple times with shared
    weights.

    anchors_per_location: number of anchors per pixel in the feature map
    anchor_stride: Controls the density of anchors. Typically 1 (anchors for
                   every pixel in the feature map), or 2 (every other pixel).
    depth: Depth of the backbone feature map.

    Returns a Keras Model object. The model outputs, when called, are:
889 890 891
    rpn_class_logits: [batch, H * W * anchors_per_location, 2] Anchor classifier logits (before softmax)
    rpn_probs: [batch, H * W * anchors_per_location, 2] Anchor classifier probabilities.
    rpn_bbox: [batch, H * W * anchors_per_location, (dy, dx, log(dh), log(dw))] Deltas to be
W
Waleed Abdulla 已提交
892 893 894 895 896 897 898 899 900 901 902 903
                applied to anchors.
    """
    input_feature_map = KL.Input(shape=[None, None, depth],
                                 name="input_rpn_feature_map")
    outputs = rpn_graph(input_feature_map, anchors_per_location, anchor_stride)
    return KM.Model([input_feature_map], outputs, name="rpn_model")


############################################################
#  Feature Pyramid Network Heads
############################################################

904
def fpn_classifier_graph(rois, feature_maps, image_meta,
905 906
                         pool_size, num_classes, train_bn=True,
                         fc_layers_size=1024):
W
Waleed Abdulla 已提交
907 908 909 910 911
    """Builds the computation graph of the feature pyramid network classifier
    and regressor heads.

    rois: [batch, num_rois, (y1, x1, y2, x2)] Proposal boxes in normalized
          coordinates.
C
Corey Hu 已提交
912
    feature_maps: List of feature maps from different layers of the pyramid,
W
Waleed Abdulla 已提交
913
                  [P2, P3, P4, P5]. Each has a different resolution.
914
    image_meta: [batch, (meta data)] Image details. See compose_image_meta()
W
Waleed Abdulla 已提交
915 916
    pool_size: The width of the square feature map generated from ROI Pooling.
    num_classes: number of classes, which determines the depth of the results
C
Corey Hu 已提交
917
    train_bn: Boolean. Train or freeze Batch Norm layers
918
    fc_layers_size: Size of the 2 FC layers
W
Waleed Abdulla 已提交
919 920

    Returns:
921 922 923
        logits: [batch, num_rois, NUM_CLASSES] classifier logits (before softmax)
        probs: [batch, num_rois, NUM_CLASSES] classifier probabilities
        bbox_deltas: [batch, num_rois, NUM_CLASSES, (dy, dx, log(dh), log(dw))] Deltas to apply to
W
Waleed Abdulla 已提交
924 925 926
                     proposal boxes
    """
    # ROI Pooling
927
    # Shape: [batch, num_rois, POOL_SIZE, POOL_SIZE, channels]
928 929
    x = PyramidROIAlign([pool_size, pool_size],
                        name="roi_align_classifier")([rois, image_meta] + feature_maps)
W
Waleed Abdulla 已提交
930
    # Two 1024 FC layers (implemented with Conv2D for consistency)
931
    x = KL.TimeDistributed(KL.Conv2D(fc_layers_size, (pool_size, pool_size), padding="valid"),
W
Waleed Abdulla 已提交
932
                           name="mrcnn_class_conv1")(x)
933
    x = KL.TimeDistributed(BatchNorm(), name='mrcnn_class_bn1')(x, training=train_bn)
W
Waleed Abdulla 已提交
934
    x = KL.Activation('relu')(x)
935
    x = KL.TimeDistributed(KL.Conv2D(fc_layers_size, (1, 1)),
W
Waleed Abdulla 已提交
936
                           name="mrcnn_class_conv2")(x)
937
    x = KL.TimeDistributed(BatchNorm(), name='mrcnn_class_bn2')(x, training=train_bn)
W
Waleed Abdulla 已提交
938 939 940 941 942 943 944 945 946 947 948 949
    x = KL.Activation('relu')(x)

    shared = KL.Lambda(lambda x: K.squeeze(K.squeeze(x, 3), 2),
                       name="pool_squeeze")(x)

    # Classifier head
    mrcnn_class_logits = KL.TimeDistributed(KL.Dense(num_classes),
                                            name='mrcnn_class_logits')(shared)
    mrcnn_probs = KL.TimeDistributed(KL.Activation("softmax"),
                                     name="mrcnn_class")(mrcnn_class_logits)

    # BBox head
950
    # [batch, num_rois, NUM_CLASSES * (dy, dx, log(dh), log(dw))]
G
Gyuri Im 已提交
951
    x = KL.TimeDistributed(KL.Dense(num_classes * 4, activation='linear'),
W
Waleed Abdulla 已提交
952
                           name='mrcnn_bbox_fc')(shared)
953
    # Reshape to [batch, num_rois, NUM_CLASSES, (dy, dx, log(dh), log(dw))]
W
Waleed Abdulla 已提交
954 955 956 957 958 959
    s = K.int_shape(x)
    mrcnn_bbox = KL.Reshape((s[1], num_classes, 4), name="mrcnn_bbox")(x)

    return mrcnn_class_logits, mrcnn_probs, mrcnn_bbox


960
def build_fpn_mask_graph(rois, feature_maps, image_meta,
961
                         pool_size, num_classes, train_bn=True):
W
Waleed Abdulla 已提交
962 963 964 965
    """Builds the computation graph of the mask head of Feature Pyramid Network.

    rois: [batch, num_rois, (y1, x1, y2, x2)] Proposal boxes in normalized
          coordinates.
C
Corey Hu 已提交
966
    feature_maps: List of feature maps from different layers of the pyramid,
W
Waleed Abdulla 已提交
967
                  [P2, P3, P4, P5]. Each has a different resolution.
968
    image_meta: [batch, (meta data)] Image details. See compose_image_meta()
W
Waleed Abdulla 已提交
969 970
    pool_size: The width of the square feature map generated from ROI Pooling.
    num_classes: number of classes, which determines the depth of the results
C
Corey Hu 已提交
971
    train_bn: Boolean. Train or freeze Batch Norm layers
W
Waleed Abdulla 已提交
972

973
    Returns: Masks [batch, num_rois, MASK_POOL_SIZE, MASK_POOL_SIZE, NUM_CLASSES]
W
Waleed Abdulla 已提交
974 975
    """
    # ROI Pooling
976
    # Shape: [batch, num_rois, MASK_POOL_SIZE, MASK_POOL_SIZE, channels]
977 978
    x = PyramidROIAlign([pool_size, pool_size],
                        name="roi_align_mask")([rois, image_meta] + feature_maps)
W
Waleed Abdulla 已提交
979 980 981 982

    # Conv layers
    x = KL.TimeDistributed(KL.Conv2D(256, (3, 3), padding="same"),
                           name="mrcnn_mask_conv1")(x)
983 984
    x = KL.TimeDistributed(BatchNorm(),
                           name='mrcnn_mask_bn1')(x, training=train_bn)
W
Waleed Abdulla 已提交
985 986 987 988
    x = KL.Activation('relu')(x)

    x = KL.TimeDistributed(KL.Conv2D(256, (3, 3), padding="same"),
                           name="mrcnn_mask_conv2")(x)
989 990
    x = KL.TimeDistributed(BatchNorm(),
                           name='mrcnn_mask_bn2')(x, training=train_bn)
W
Waleed Abdulla 已提交
991 992 993 994
    x = KL.Activation('relu')(x)

    x = KL.TimeDistributed(KL.Conv2D(256, (3, 3), padding="same"),
                           name="mrcnn_mask_conv3")(x)
995 996
    x = KL.TimeDistributed(BatchNorm(),
                           name='mrcnn_mask_bn3')(x, training=train_bn)
W
Waleed Abdulla 已提交
997 998 999 1000
    x = KL.Activation('relu')(x)

    x = KL.TimeDistributed(KL.Conv2D(256, (3, 3), padding="same"),
                           name="mrcnn_mask_conv4")(x)
1001 1002
    x = KL.TimeDistributed(BatchNorm(),
                           name='mrcnn_mask_bn4')(x, training=train_bn)
W
Waleed Abdulla 已提交
1003 1004
    x = KL.Activation('relu')(x)

G
Gyuri Im 已提交
1005
    x = KL.TimeDistributed(KL.Conv2DTranspose(256, (2, 2), strides=2, activation="relu"),
W
Waleed Abdulla 已提交
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
                           name="mrcnn_mask_deconv")(x)
    x = KL.TimeDistributed(KL.Conv2D(num_classes, (1, 1), strides=1, activation="sigmoid"),
                           name="mrcnn_mask")(x)
    return x


############################################################
#  Loss Functions
############################################################

def smooth_l1_loss(y_true, y_pred):
    """Implements Smooth-L1 loss.
C
Corey Hu 已提交
1018
    y_true and y_pred are typically: [N, 4], but could be any shape.
W
Waleed Abdulla 已提交
1019 1020 1021
    """
    diff = K.abs(y_true - y_pred)
    less_than_one = K.cast(K.less(diff, 1.0), "float32")
G
Gyuri Im 已提交
1022
    loss = (less_than_one * 0.5 * diff**2) + (1 - less_than_one) * (diff - 0.5)
W
Waleed Abdulla 已提交
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
    return loss


def rpn_class_loss_graph(rpn_match, rpn_class_logits):
    """RPN anchor classifier loss.

    rpn_match: [batch, anchors, 1]. Anchor match type. 1=positive,
               -1=negative, 0=neutral anchor.
    rpn_class_logits: [batch, anchors, 2]. RPN classifier logits for FG/BG.
    """
    # Squeeze last dim to simplify
    rpn_match = tf.squeeze(rpn_match, -1)
    # Get anchor classes. Convert the -1/+1 match to 0/1 values.
    anchor_class = K.cast(K.equal(rpn_match, 1), tf.int32)
    # Positive and Negative anchors contribute to the loss,
    # but neutral anchors (match value = 0) don't.
    indices = tf.where(K.not_equal(rpn_match, 0))
    # Pick rows that contribute to the loss and filter out the rest.
    rpn_class_logits = tf.gather_nd(rpn_class_logits, indices)
    anchor_class = tf.gather_nd(anchor_class, indices)
C
Corey Hu 已提交
1043
    # Cross entropy loss
G
Gyuri Im 已提交
1044 1045
    loss = K.sparse_categorical_crossentropy(target=anchor_class,
                                             output=rpn_class_logits,
W
Waleed Abdulla 已提交
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
                                             from_logits=True)
    loss = K.switch(tf.size(loss) > 0, K.mean(loss), tf.constant(0.0))
    return loss


def rpn_bbox_loss_graph(config, target_bbox, rpn_match, rpn_bbox):
    """Return the RPN bounding box loss graph.

    config: the model config object.
    target_bbox: [batch, max positive anchors, (dy, dx, log(dh), log(dw))].
        Uses 0 padding to fill in unsed bbox deltas.
    rpn_match: [batch, anchors, 1]. Anchor match type. 1=positive,
               -1=negative, 0=neutral anchor.
    rpn_bbox: [batch, anchors, (dy, dx, log(dh), log(dw))]
    """
    # Positive anchors contribute to the loss, but negative and
    # neutral anchors (match value of 0 or -1) don't.
    rpn_match = K.squeeze(rpn_match, -1)
    indices = tf.where(K.equal(rpn_match, 1))

    # Pick bbox deltas that contribute to the loss
    rpn_bbox = tf.gather_nd(rpn_bbox, indices)

    # Trim target bounding box deltas to the same length as rpn_bbox.
    batch_counts = K.sum(K.cast(K.equal(rpn_match, 1), tf.int32), axis=1)
    target_bbox = batch_pack_graph(target_bbox, batch_counts,
                                   config.IMAGES_PER_GPU)

    # TODO: use smooth_l1_loss() rather than reimplementing here
    #       to reduce code duplication
    diff = K.abs(target_bbox - rpn_bbox)
    less_than_one = K.cast(K.less(diff, 1.0), "float32")
G
Gyuri Im 已提交
1078
    loss = (less_than_one * 0.5 * diff**2) + (1 - less_than_one) * (diff - 0.5)
W
Waleed Abdulla 已提交
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094

    loss = K.switch(tf.size(loss) > 0, K.mean(loss), tf.constant(0.0))
    return loss


def mrcnn_class_loss_graph(target_class_ids, pred_class_logits,
                           active_class_ids):
    """Loss for the classifier head of Mask RCNN.

    target_class_ids: [batch, num_rois]. Integer class IDs. Uses zero
        padding to fill in the array.
    pred_class_logits: [batch, num_rois, num_classes]
    active_class_ids: [batch, num_classes]. Has a value of 1 for
        classes that are in the dataset of the image, and 0
        for classes that are not in the dataset.
    """
1095 1096 1097
    # During model building, Keras calls this function with
    # target_class_ids of type float32. Unclear why. Cast it
    # to int to get around it.
W
Waleed Abdulla 已提交
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
    target_class_ids = tf.cast(target_class_ids, 'int64')

    # Find predictions of classes that are not in the dataset.
    pred_class_ids = tf.argmax(pred_class_logits, axis=2)
    # TODO: Update this line to work with batch > 1. Right now it assumes all
    #       images in a batch have the same active_class_ids
    pred_active = tf.gather(active_class_ids[0], pred_class_ids)

    # Loss
    loss = tf.nn.sparse_softmax_cross_entropy_with_logits(
        labels=target_class_ids, logits=pred_class_logits)

    # Erase losses of predictions of classes that are not in the active
    # classes of the image.
    loss = loss * pred_active

    # Computer loss mean. Use only predictions that contribute
    # to the loss to get a correct mean.
    loss = tf.reduce_sum(loss) / tf.reduce_sum(pred_active)
    return loss


def mrcnn_bbox_loss_graph(target_bbox, target_class_ids, pred_bbox):
    """Loss for Mask R-CNN bounding box refinement.

    target_bbox: [batch, num_rois, (dy, dx, log(dh), log(dw))]
    target_class_ids: [batch, num_rois]. Integer class IDs.
    pred_bbox: [batch, num_rois, num_classes, (dy, dx, log(dh), log(dw))]
    """
    # Reshape to merge batch and roi dimensions for simplicity.
    target_class_ids = K.reshape(target_class_ids, (-1,))
    target_bbox = K.reshape(target_bbox, (-1, 4))
    pred_bbox = K.reshape(pred_bbox, (-1, K.int_shape(pred_bbox)[2], 4))

    # Only positive ROIs contribute to the loss. And only
C
Corey Hu 已提交
1133
    # the right class_id of each ROI. Get their indices.
W
Waleed Abdulla 已提交
1134
    positive_roi_ix = tf.where(target_class_ids > 0)[:, 0]
G
Gyuri Im 已提交
1135 1136
    positive_roi_class_ids = tf.cast(
        tf.gather(target_class_ids, positive_roi_ix), tf.int64)
W
Waleed Abdulla 已提交
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
    indices = tf.stack([positive_roi_ix, positive_roi_class_ids], axis=1)

    # Gather the deltas (predicted and true) that contribute to loss
    target_bbox = tf.gather(target_bbox, positive_roi_ix)
    pred_bbox = tf.gather_nd(pred_bbox, indices)

    # Smooth-L1 Loss
    loss = K.switch(tf.size(target_bbox) > 0,
                    smooth_l1_loss(y_true=target_bbox, y_pred=pred_bbox),
                    tf.constant(0.0))
    loss = K.mean(loss)
    return loss


def mrcnn_mask_loss_graph(target_masks, target_class_ids, pred_masks):
    """Mask binary cross-entropy loss for the masks head.

    target_masks: [batch, num_rois, height, width].
        A float32 tensor of values 0 or 1. Uses zero padding to fill array.
    target_class_ids: [batch, num_rois]. Integer class IDs. Zero padded.
    pred_masks: [batch, proposals, height, width, num_classes] float32 tensor
                with values from 0 to 1.
    """
    # Reshape for simplicity. Merge first two dimensions into one.
    target_class_ids = K.reshape(target_class_ids, (-1,))
    mask_shape = tf.shape(target_masks)
    target_masks = K.reshape(target_masks, (-1, mask_shape[2], mask_shape[3]))
    pred_shape = tf.shape(pred_masks)
G
Gyuri Im 已提交
1165
    pred_masks = K.reshape(pred_masks,
W
Waleed Abdulla 已提交
1166 1167 1168 1169 1170 1171 1172
                           (-1, pred_shape[2], pred_shape[3], pred_shape[4]))
    # Permute predicted masks to [N, num_classes, height, width]
    pred_masks = tf.transpose(pred_masks, [0, 3, 1, 2])

    # Only positive ROIs contribute to the loss. And only
    # the class specific mask of each ROI.
    positive_ix = tf.where(target_class_ids > 0)[:, 0]
G
Gyuri Im 已提交
1173 1174
    positive_class_ids = tf.cast(
        tf.gather(target_class_ids, positive_ix), tf.int64)
W
Waleed Abdulla 已提交
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
    indices = tf.stack([positive_ix, positive_class_ids], axis=1)

    # Gather the masks (predicted and true) that contribute to loss
    y_true = tf.gather(target_masks, positive_ix)
    y_pred = tf.gather_nd(pred_masks, indices)

    # Compute binary cross entropy. If no positive ROIs, then return 0.
    # shape: [batch, roi, num_classes]
    loss = K.switch(tf.size(y_true) > 0,
                    K.binary_crossentropy(target=y_true, output=y_pred),
                    tf.constant(0.0))
    loss = K.mean(loss)
    return loss


############################################################
#  Data Generator
############################################################

W
Waleed Abdulla 已提交
1194
def load_image_gt(dataset, config, image_id, augment=False, augmentation=None,
W
Waleed Abdulla 已提交
1195 1196 1197
                  use_mini_mask=False):
    """Load and return ground truth data for an image (image, mask, bounding boxes).

C
Corey Hu 已提交
1198
    augment: (deprecated. Use augmentation instead). If true, apply random
W
Waleed Abdulla 已提交
1199 1200 1201 1202
        image augmentation. Currently, only horizontal flipping is offered.
    augmentation: Optional. An imgaug (https://github.com/aleju/imgaug) augmentation.
        For example, passing imgaug.augmenters.Fliplr(0.5) flips images
        right/left 50% of the time.
W
Waleed Abdulla 已提交
1203 1204 1205 1206 1207 1208 1209 1210 1211
    use_mini_mask: If False, returns full-size masks that are the same height
        and width as the original image. These can be big, for example
        1024x1024x100 (for 100 instances). Mini masks are smaller, typically,
        224x224 and are generated by extracting the bounding box of the
        object and resizing it to MINI_MASK_SHAPE.

    Returns:
    image: [height, width, 3]
    shape: the original shape of the image before resizing and cropping.
1212 1213
    class_ids: [instance_count] Integer class IDs
    bbox: [instance_count, (y1, x1, y2, x2)]
W
Waleed Abdulla 已提交
1214 1215 1216 1217 1218 1219 1220
    mask: [height, width, instance_count]. The height and width are those
        of the image unless use_mini_mask is True, in which case they are
        defined in MINI_MASK_SHAPE.
    """
    # Load image and mask
    image = dataset.load_image(image_id)
    mask, class_ids = dataset.load_mask(image_id)
1221
    original_shape = image.shape
1222
    image, window, scale, padding, crop = utils.resize_image(
G
Gyuri Im 已提交
1223 1224
        image,
        min_dim=config.IMAGE_MIN_DIM,
1225
        min_scale=config.IMAGE_MIN_SCALE,
W
Waleed Abdulla 已提交
1226
        max_dim=config.IMAGE_MAX_DIM,
W
Waleed Abdulla 已提交
1227
        mode=config.IMAGE_RESIZE_MODE)
1228
    mask = utils.resize_mask(mask, scale, padding, crop)
W
Waleed Abdulla 已提交
1229 1230

    # Random horizontal flips.
W
Waleed Abdulla 已提交
1231
    # TODO: will be removed in a future update in favor of augmentation
W
Waleed Abdulla 已提交
1232
    if augment:
C
Corey Hu 已提交
1233
        logging.warning("'augment' is deprecated. Use 'augmentation' instead.")
W
Waleed Abdulla 已提交
1234 1235 1236 1237
        if random.randint(0, 1):
            image = np.fliplr(image)
            mask = np.fliplr(mask)

W
Waleed Abdulla 已提交
1238 1239 1240 1241 1242
    # Augmentation
    # This requires the imgaug lib (https://github.com/aleju/imgaug)
    if augmentation:
        import imgaug

C
Corey Hu 已提交
1243
        # Augmenters that are safe to apply to masks
W
Waleed Abdulla 已提交
1244 1245 1246 1247 1248 1249 1250 1251
        # Some, such as Affine, have settings that make them unsafe, so always
        # test your augmentation on masks
        MASK_AUGMENTERS = ["Sequential", "SomeOf", "OneOf", "Sometimes",
                           "Fliplr", "Flipud", "CropAndPad",
                           "Affine", "PiecewiseAffine"]

        def hook(images, augmenter, parents, default):
            """Determines which augmenters to apply to masks."""
C
Corey Hu 已提交
1252
            return augmenter.__class__.__name__ in MASK_AUGMENTERS
W
Waleed Abdulla 已提交
1253

W
Waleed Abdulla 已提交
1254
        # Store shapes before augmentation to compare
W
Waleed Abdulla 已提交
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
        image_shape = image.shape
        mask_shape = mask.shape
        # Make augmenters deterministic to apply similarly to images and masks
        det = augmentation.to_deterministic()
        image = det.augment_image(image)
        # Change mask to np.uint8 because imgaug doesn't support np.bool
        mask = det.augment_image(mask.astype(np.uint8),
                                 hooks=imgaug.HooksImages(activator=hook))
        # Verify that shapes didn't change
        assert image.shape == image_shape, "Augmentation shouldn't change image size"
        assert mask.shape == mask_shape, "Augmentation shouldn't change mask size"
        # Change mask back to bool
        mask = mask.astype(np.bool)

L
Leo Han 已提交
1269 1270
    # Note that some boxes might be all zeros if the corresponding mask got cropped out.
    # and here is to filter them out
1271
    _idx = np.sum(mask, axis=(0, 1)) > 0
L
Leo Han 已提交
1272
    mask = mask[:, :, _idx]
1273
    class_ids = class_ids[_idx]
W
Waleed Abdulla 已提交
1274 1275 1276 1277 1278 1279 1280 1281 1282
    # Bounding boxes. Note that some boxes might be all zeros
    # if the corresponding mask got cropped out.
    # bbox: [num_instances, (y1, x1, y2, x2)]
    bbox = utils.extract_bboxes(mask)

    # Active classes
    # Different datasets have different classes, so track the
    # classes supported in the dataset of this image.
    active_class_ids = np.zeros([dataset.num_classes], dtype=np.int32)
1283 1284
    source_class_ids = dataset.source_class_ids[dataset.image_info[image_id]["source"]]
    active_class_ids[source_class_ids] = 1
W
Waleed Abdulla 已提交
1285 1286 1287 1288 1289 1290

    # Resize masks to smaller size to reduce memory usage
    if use_mini_mask:
        mask = utils.minimize_mask(bbox, mask, config.MINI_MASK_SHAPE)

    # Image meta data
1291 1292
    image_meta = compose_image_meta(image_id, original_shape, image.shape,
                                    window, scale, active_class_ids)
W
Waleed Abdulla 已提交
1293

1294
    return image, image_meta, class_ids, bbox, mask
W
Waleed Abdulla 已提交
1295 1296


1297
def build_detection_targets(rpn_rois, gt_class_ids, gt_boxes, gt_masks, config):
W
Waleed Abdulla 已提交
1298
    """Generate targets for training Stage 2 classifier and mask heads.
1299 1300
    This is not used in normal training. It's useful for debugging or to train
    the Mask RCNN heads without using the RPN head.
W
Waleed Abdulla 已提交
1301 1302 1303

    Inputs:
    rpn_rois: [N, (y1, x1, y2, x2)] proposal boxes.
1304 1305
    gt_class_ids: [instance count] Integer class IDs
    gt_boxes: [instance count, (y1, x1, y2, x2)]
C
Corey Hu 已提交
1306
    gt_masks: [height, width, instance count] Ground truth masks. Can be full
W
Waleed Abdulla 已提交
1307 1308 1309 1310
              size or mini-masks.

    Returns:
    rois: [TRAIN_ROIS_PER_IMAGE, (y1, x1, y2, x2)]
1311 1312
    class_ids: [TRAIN_ROIS_PER_IMAGE]. Integer class IDs.
    bboxes: [TRAIN_ROIS_PER_IMAGE, NUM_CLASSES, (y, x, log(h), log(w))]. Class-specific
W
Waleed Abdulla 已提交
1313
            bbox refinements.
W
Waleed Abdulla 已提交
1314 1315 1316 1317
    masks: [TRAIN_ROIS_PER_IMAGE, height, width, NUM_CLASSES). Class specific masks cropped
           to bbox boundaries and resized to neural network output size.
    """
    assert rpn_rois.shape[0] > 0
G
Gyuri Im 已提交
1318 1319 1320 1321 1322 1323
    assert gt_class_ids.dtype == np.int32, "Expected int but got {}".format(
        gt_class_ids.dtype)
    assert gt_boxes.dtype == np.int32, "Expected int but got {}".format(
        gt_boxes.dtype)
    assert gt_masks.dtype == np.bool_, "Expected bool but got {}".format(
        gt_masks.dtype)
W
Waleed Abdulla 已提交
1324 1325 1326 1327 1328

    # It's common to add GT Boxes to ROIs but we don't do that here because
    # according to XinLei Chen's paper, it doesn't help.

    # Trim empty padding in gt_boxes and gt_masks parts
1329
    instance_ids = np.where(gt_class_ids > 0)[0]
W
Waleed Abdulla 已提交
1330
    assert instance_ids.shape[0] > 0, "Image must contain instances."
1331
    gt_class_ids = gt_class_ids[instance_ids]
W
Waleed Abdulla 已提交
1332 1333 1334 1335
    gt_boxes = gt_boxes[instance_ids]
    gt_masks = gt_masks[:, :, instance_ids]

    # Compute areas of ROIs and ground truth boxes.
G
Gyuri Im 已提交
1336 1337 1338 1339
    rpn_roi_area = (rpn_rois[:, 2] - rpn_rois[:, 0]) * \
        (rpn_rois[:, 3] - rpn_rois[:, 1])
    gt_box_area = (gt_boxes[:, 2] - gt_boxes[:, 0]) * \
        (gt_boxes[:, 3] - gt_boxes[:, 1])
W
Waleed Abdulla 已提交
1340 1341 1342 1343

    # Compute overlaps [rpn_rois, gt_boxes]
    overlaps = np.zeros((rpn_rois.shape[0], gt_boxes.shape[0]))
    for i in range(overlaps.shape[1]):
1344
        gt = gt_boxes[i]
G
Gyuri Im 已提交
1345 1346
        overlaps[:, i] = utils.compute_iou(
            gt, rpn_rois, gt_box_area[i], rpn_roi_area)
W
Waleed Abdulla 已提交
1347 1348 1349

    # Assign ROIs to GT boxes
    rpn_roi_iou_argmax = np.argmax(overlaps, axis=1)
G
Gyuri Im 已提交
1350 1351 1352 1353
    rpn_roi_iou_max = overlaps[np.arange(
        overlaps.shape[0]), rpn_roi_iou_argmax]
    # GT box assigned to each ROI
    rpn_roi_gt_boxes = gt_boxes[rpn_roi_iou_argmax]
1354
    rpn_roi_gt_class_ids = gt_class_ids[rpn_roi_iou_argmax]
W
Waleed Abdulla 已提交
1355

1356
    # Positive ROIs are those with >= 0.5 IoU with a GT box.
W
Waleed Abdulla 已提交
1357 1358 1359 1360
    fg_ids = np.where(rpn_roi_iou_max > 0.5)[0]

    # Negative ROIs are those with max IoU 0.1-0.5 (hard example mining)
    # TODO: To hard example mine or not to hard example mine, that's the question
C
Corey Hu 已提交
1361
    # bg_ids = np.where((rpn_roi_iou_max >= 0.1) & (rpn_roi_iou_max < 0.5))[0]
W
Waleed Abdulla 已提交
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
    bg_ids = np.where(rpn_roi_iou_max < 0.5)[0]

    # Subsample ROIs. Aim for 33% foreground.
    # FG
    fg_roi_count = int(config.TRAIN_ROIS_PER_IMAGE * config.ROI_POSITIVE_RATIO)
    if fg_ids.shape[0] > fg_roi_count:
        keep_fg_ids = np.random.choice(fg_ids, fg_roi_count, replace=False)
    else:
        keep_fg_ids = fg_ids
    # BG
    remaining = config.TRAIN_ROIS_PER_IMAGE - keep_fg_ids.shape[0]
    if bg_ids.shape[0] > remaining:
        keep_bg_ids = np.random.choice(bg_ids, remaining, replace=False)
    else:
        keep_bg_ids = bg_ids
C
Corey Hu 已提交
1377
    # Combine indices of ROIs to keep
W
Waleed Abdulla 已提交
1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
    keep = np.concatenate([keep_fg_ids, keep_bg_ids])
    # Need more?
    remaining = config.TRAIN_ROIS_PER_IMAGE - keep.shape[0]
    if remaining > 0:
        # Looks like we don't have enough samples to maintain the desired
        # balance. Reduce requirements and fill in the rest. This is
        # likely different from the Mask RCNN paper.

        # There is a small chance we have neither fg nor bg samples.
        if keep.shape[0] == 0:
            # Pick bg regions with easier IoU threshold
            bg_ids = np.where(rpn_roi_iou_max < 0.5)[0]
            assert bg_ids.shape[0] >= remaining
            keep_bg_ids = np.random.choice(bg_ids, remaining, replace=False)
            assert keep_bg_ids.shape[0] == remaining
            keep = np.concatenate([keep, keep_bg_ids])
        else:
            # Fill the rest with repeated bg rois.
G
Gyuri Im 已提交
1396 1397
            keep_extra_ids = np.random.choice(
                keep_bg_ids, remaining, replace=True)
W
Waleed Abdulla 已提交
1398 1399 1400 1401 1402 1403 1404
            keep = np.concatenate([keep, keep_extra_ids])
    assert keep.shape[0] == config.TRAIN_ROIS_PER_IMAGE, \
        "keep doesn't match ROI batch size {}, {}".format(
            keep.shape[0], config.TRAIN_ROIS_PER_IMAGE)

    # Reset the gt boxes assigned to BG ROIs.
    rpn_roi_gt_boxes[keep_bg_ids, :] = 0
1405
    rpn_roi_gt_class_ids[keep_bg_ids] = 0
W
Waleed Abdulla 已提交
1406 1407

    # For each kept ROI, assign a class_id, and for FG ROIs also add bbox refinement.
1408
    rois = rpn_rois[keep]
W
Waleed Abdulla 已提交
1409
    roi_gt_boxes = rpn_roi_gt_boxes[keep]
1410
    roi_gt_class_ids = rpn_roi_gt_class_ids[keep]
W
Waleed Abdulla 已提交
1411 1412
    roi_gt_assignment = rpn_roi_iou_argmax[keep]

1413
    # Class-aware bbox deltas. [y, x, log(h), log(w)]
G
Gyuri Im 已提交
1414 1415
    bboxes = np.zeros((config.TRAIN_ROIS_PER_IMAGE,
                       config.NUM_CLASSES, 4), dtype=np.float32)
1416
    pos_ids = np.where(roi_gt_class_ids > 0)[0]
G
Gyuri Im 已提交
1417 1418
    bboxes[pos_ids, roi_gt_class_ids[pos_ids]] = utils.box_refinement(
        rois[pos_ids], roi_gt_boxes[pos_ids, :4])
W
Waleed Abdulla 已提交
1419
    # Normalize bbox refinements
1420
    bboxes /= config.BBOX_STD_DEV
W
Waleed Abdulla 已提交
1421

W
Waleed Abdulla 已提交
1422
    # Generate class-specific target masks
G
Gyuri Im 已提交
1423
    masks = np.zeros((config.TRAIN_ROIS_PER_IMAGE, config.MASK_SHAPE[0], config.MASK_SHAPE[1], config.NUM_CLASSES),
W
Waleed Abdulla 已提交
1424 1425
                     dtype=np.float32)
    for i in pos_ids:
1426
        class_id = roi_gt_class_ids[i]
W
Waleed Abdulla 已提交
1427 1428 1429
        assert class_id > 0, "class id must be greater than 0"
        gt_id = roi_gt_assignment[i]
        class_mask = gt_masks[:, :, gt_id]
1430

W
Waleed Abdulla 已提交
1431 1432 1433 1434
        if config.USE_MINI_MASK:
            # Create a mask placeholder, the size of the image
            placeholder = np.zeros(config.IMAGE_SHAPE[:2], dtype=bool)
            # GT box
1435
            gt_y1, gt_x1, gt_y2, gt_x2 = gt_boxes[gt_id]
W
Waleed Abdulla 已提交
1436 1437 1438 1439
            gt_w = gt_x2 - gt_x1
            gt_h = gt_y2 - gt_y1
            # Resize mini mask to size of GT box
            placeholder[gt_y1:gt_y2, gt_x1:gt_x2] = \
1440
                np.round(skimage.transform.resize(
1441
                    class_mask, (gt_h, gt_w), order=1, mode="constant")).astype(bool)
W
Waleed Abdulla 已提交
1442 1443
            # Place the mini batch in the placeholder
            class_mask = placeholder
1444

W
Waleed Abdulla 已提交
1445
        # Pick part of the mask and resize it
1446
        y1, x1, y2, x2 = rois[i].astype(np.int32)
W
Waleed Abdulla 已提交
1447
        m = class_mask[y1:y2, x1:x2]
1448
        mask = skimage.transform.resize(m, config.MASK_SHAPE, order=1, mode="constant")
1449
        masks[i, :, :, class_id] = mask
W
Waleed Abdulla 已提交
1450

1451
    return rois, roi_gt_class_ids, bboxes, masks
W
Waleed Abdulla 已提交
1452

1453 1454

def build_rpn_targets(image_shape, anchors, gt_class_ids, gt_boxes, config):
W
Waleed Abdulla 已提交
1455 1456 1457 1458
    """Given the anchors and GT boxes, compute overlaps and identify positive
    anchors and deltas to refine them to match their corresponding GT boxes.

    anchors: [num_anchors, (y1, x1, y2, x2)]
1459 1460
    gt_class_ids: [num_gt_boxes] Integer class IDs.
    gt_boxes: [num_gt_boxes, (y1, x1, y2, x2)]
W
Waleed Abdulla 已提交
1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471

    Returns:
    rpn_match: [N] (int32) matches between anchors and GT boxes.
               1 = positive anchor, -1 = negative anchor, 0 = neutral
    rpn_bbox: [N, (dy, dx, log(dh), log(dw))] Anchor bbox deltas.
    """
    # RPN Match: 1 = positive anchor, -1 = negative anchor, 0 = neutral
    rpn_match = np.zeros([anchors.shape[0]], dtype=np.int32)
    # RPN bounding boxes: [max anchors per image, (dy, dx, log(dh), log(dw))]
    rpn_bbox = np.zeros((config.RPN_TRAIN_ANCHORS_PER_IMAGE, 4))

W
Waleed Abdulla 已提交
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
    # Handle COCO crowds
    # A crowd box in COCO is a bounding box around several instances. Exclude
    # them from training. A crowd box is given a negative class ID.
    crowd_ix = np.where(gt_class_ids < 0)[0]
    if crowd_ix.shape[0] > 0:
        # Filter out crowds from ground truth class IDs and boxes
        non_crowd_ix = np.where(gt_class_ids > 0)[0]
        crowd_boxes = gt_boxes[crowd_ix]
        gt_class_ids = gt_class_ids[non_crowd_ix]
        gt_boxes = gt_boxes[non_crowd_ix]
        # Compute overlaps with crowd boxes [anchors, crowds]
        crowd_overlaps = utils.compute_overlaps(anchors, crowd_boxes)
        crowd_iou_max = np.amax(crowd_overlaps, axis=1)
        no_crowd_bool = (crowd_iou_max < 0.001)
    else:
        # All anchors don't intersect a crowd
        no_crowd_bool = np.ones([anchors.shape[0]], dtype=bool)
W
Waleed Abdulla 已提交
1489 1490

    # Compute overlaps [num_anchors, num_gt_boxes]
W
Waleed Abdulla 已提交
1491
    overlaps = utils.compute_overlaps(anchors, gt_boxes)
W
Waleed Abdulla 已提交
1492 1493 1494 1495

    # Match anchors to GT Boxes
    # If an anchor overlaps a GT box with IoU >= 0.7 then it's positive.
    # If an anchor overlaps a GT box with IoU < 0.3 then it's negative.
G
Gyuri Im 已提交
1496
    # Neutral anchors are those that don't match the conditions above,
W
Waleed Abdulla 已提交
1497 1498 1499 1500
    # and they don't influence the loss function.
    # However, don't keep any GT box unmatched (rare, but happens). Instead,
    # match it to the closest anchor (even if its max IoU is < 0.3).
    #
W
Waleed Abdulla 已提交
1501 1502
    # 1. Set negative anchors first. They get overwritten below if a GT box is
    # matched to them. Skip boxes in crowd areas.
W
Waleed Abdulla 已提交
1503 1504
    anchor_iou_argmax = np.argmax(overlaps, axis=1)
    anchor_iou_max = overlaps[np.arange(overlaps.shape[0]), anchor_iou_argmax]
W
Waleed Abdulla 已提交
1505
    rpn_match[(anchor_iou_max < 0.3) & (no_crowd_bool)] = -1
W
Waleed Abdulla 已提交
1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
    # 2. Set an anchor for each GT box (regardless of IoU value).
    # TODO: If multiple anchors have the same IoU match all of them
    gt_iou_argmax = np.argmax(overlaps, axis=0)
    rpn_match[gt_iou_argmax] = 1
    # 3. Set anchors with high overlap as positive.
    rpn_match[anchor_iou_max >= 0.7] = 1

    # Subsample to balance positive and negative anchors
    # Don't let positives be more than half the anchors
    ids = np.where(rpn_match == 1)[0]
    extra = len(ids) - (config.RPN_TRAIN_ANCHORS_PER_IMAGE // 2)
    if extra > 0:
        # Reset the extra ones to neutral
        ids = np.random.choice(ids, extra, replace=False)
        rpn_match[ids] = 0
    # Same for negative proposals
    ids = np.where(rpn_match == -1)[0]
G
Gyuri Im 已提交
1523 1524
    extra = len(ids) - (config.RPN_TRAIN_ANCHORS_PER_IMAGE -
                        np.sum(rpn_match == 1))
W
Waleed Abdulla 已提交
1525 1526 1527 1528 1529 1530 1531 1532 1533
    if extra > 0:
        # Rest the extra ones to neutral
        ids = np.random.choice(ids, extra, replace=False)
        rpn_match[ids] = 0

    # For positive anchors, compute shift and scale needed to transform them
    # to match the corresponding GT boxes.
    ids = np.where(rpn_match == 1)[0]
    ix = 0  # index into rpn_bbox
W
Waleed Abdulla 已提交
1534
    # TODO: use box_refinement() rather than duplicating the code here
W
Waleed Abdulla 已提交
1535 1536
    for i, a in zip(ids, anchors[ids]):
        # Closest gt box (it might have IoU < 0.7)
1537
        gt = gt_boxes[anchor_iou_argmax[i]]
W
Waleed Abdulla 已提交
1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564

        # Convert coordinates to center plus width/height.
        # GT Box
        gt_h = gt[2] - gt[0]
        gt_w = gt[3] - gt[1]
        gt_center_y = gt[0] + 0.5 * gt_h
        gt_center_x = gt[1] + 0.5 * gt_w
        # Anchor
        a_h = a[2] - a[0]
        a_w = a[3] - a[1]
        a_center_y = a[0] + 0.5 * a_h
        a_center_x = a[1] + 0.5 * a_w

        # Compute the bbox refinement that the RPN should predict.
        rpn_bbox[ix] = [
            (gt_center_y - a_center_y) / a_h,
            (gt_center_x - a_center_x) / a_w,
            np.log(gt_h / a_h),
            np.log(gt_w / a_w),
        ]
        # Normalize
        rpn_bbox[ix] /= config.RPN_BBOX_STD_DEV
        ix += 1

    return rpn_match, rpn_bbox


1565
def generate_random_rois(image_shape, count, gt_class_ids, gt_boxes):
W
Waleed Abdulla 已提交
1566 1567 1568 1569 1570
    """Generates ROI proposals similar to what a region proposal network
    would generate.

    image_shape: [Height, Width, Depth]
    count: Number of ROIs to generate
1571 1572
    gt_class_ids: [N] Integer ground truth class IDs
    gt_boxes: [N, (y1, x1, y2, x2)] Ground truth boxes in pixels.
W
Waleed Abdulla 已提交
1573 1574 1575 1576 1577

    Returns: [count, (y1, x1, y2, x2)] ROI boxes in pixels.
    """
    # placeholder
    rois = np.zeros((count, 4), dtype=np.int32)
1578

W
Waleed Abdulla 已提交
1579 1580 1581
    # Generate random ROIs around GT boxes (90% of count)
    rois_per_box = int(0.9 * count / gt_boxes.shape[0])
    for i in range(gt_boxes.shape[0]):
1582
        gt_y1, gt_x1, gt_y2, gt_x2 = gt_boxes[i]
W
Waleed Abdulla 已提交
1583 1584 1585
        h = gt_y2 - gt_y1
        w = gt_x2 - gt_x1
        # random boundaries
G
Gyuri Im 已提交
1586 1587 1588 1589
        r_y1 = max(gt_y1 - h, 0)
        r_y2 = min(gt_y2 + h, image_shape[0])
        r_x1 = max(gt_x1 - w, 0)
        r_x2 = min(gt_x2 + w, image_shape[1])
1590

W
Waleed Abdulla 已提交
1591
        # To avoid generating boxes with zero area, we generate double what
G
Gyuri Im 已提交
1592
        # we need and filter out the extra. If we get fewer valid boxes
W
Waleed Abdulla 已提交
1593 1594
        # than we need, we loop and try again.
        while True:
G
Gyuri Im 已提交
1595 1596
            y1y2 = np.random.randint(r_y1, r_y2, (rois_per_box * 2, 2))
            x1x2 = np.random.randint(r_x1, r_x2, (rois_per_box * 2, 2))
W
Waleed Abdulla 已提交
1597 1598
            # Filter out zero area boxes
            threshold = 1
G
Gyuri Im 已提交
1599 1600 1601 1602
            y1y2 = y1y2[np.abs(y1y2[:, 0] - y1y2[:, 1]) >=
                        threshold][:rois_per_box]
            x1x2 = x1x2[np.abs(x1x2[:, 0] - x1x2[:, 1]) >=
                        threshold][:rois_per_box]
W
Waleed Abdulla 已提交
1603 1604
            if y1y2.shape[0] == rois_per_box and x1x2.shape[0] == rois_per_box:
                break
1605

W
Waleed Abdulla 已提交
1606 1607 1608 1609 1610
        # Sort on axis 1 to ensure x1 <= x2 and y1 <= y2 and then reshape
        # into x1, y1, x2, y2 order
        x1, x2 = np.split(np.sort(x1x2, axis=1), 2, axis=1)
        y1, y2 = np.split(np.sort(y1y2, axis=1), 2, axis=1)
        box_rois = np.hstack([y1, x1, y2, x2])
G
Gyuri Im 已提交
1611
        rois[rois_per_box * i:rois_per_box * (i + 1)] = box_rois
1612

W
Waleed Abdulla 已提交
1613 1614 1615
    # Generate random ROIs anywhere in the image (10% of count)
    remaining_count = count - (rois_per_box * gt_boxes.shape[0])
    # To avoid generating boxes with zero area, we generate double what
G
Gyuri Im 已提交
1616
    # we need and filter out the extra. If we get fewer valid boxes
W
Waleed Abdulla 已提交
1617 1618 1619 1620 1621 1622
    # than we need, we loop and try again.
    while True:
        y1y2 = np.random.randint(0, image_shape[0], (remaining_count * 2, 2))
        x1x2 = np.random.randint(0, image_shape[1], (remaining_count * 2, 2))
        # Filter out zero area boxes
        threshold = 1
G
Gyuri Im 已提交
1623 1624 1625 1626
        y1y2 = y1y2[np.abs(y1y2[:, 0] - y1y2[:, 1]) >=
                    threshold][:remaining_count]
        x1x2 = x1x2[np.abs(x1x2[:, 0] - x1x2[:, 1]) >=
                    threshold][:remaining_count]
W
Waleed Abdulla 已提交
1627 1628
        if y1y2.shape[0] == remaining_count and x1x2.shape[0] == remaining_count:
            break
1629

W
Waleed Abdulla 已提交
1630 1631 1632 1633 1634 1635 1636 1637 1638
    # Sort on axis 1 to ensure x1 <= x2 and y1 <= y2 and then reshape
    # into x1, y1, x2, y2 order
    x1, x2 = np.split(np.sort(x1x2, axis=1), 2, axis=1)
    y1, y2 = np.split(np.sort(y1y2, axis=1), 2, axis=1)
    global_rois = np.hstack([y1, x1, y2, x2])
    rois[-remaining_count:] = global_rois
    return rois


W
Waleed Abdulla 已提交
1639
def data_generator(dataset, config, shuffle=True, augment=False, augmentation=None,
N
Nick 已提交
1640
                   random_rois=0, batch_size=1, detection_targets=False,
1641
                   no_augmentation_sources=None):
G
Gyuri Im 已提交
1642
    """A generator that returns images and corresponding target class ids,
W
Waleed Abdulla 已提交
1643 1644 1645 1646 1647
    bounding box deltas, and masks.

    dataset: The Dataset object to pick data from
    config: The model config object
    shuffle: If True, shuffles the samples before every epoch
C
Corey Hu 已提交
1648
    augment: (deprecated. Use augmentation instead). If true, apply random
W
Waleed Abdulla 已提交
1649 1650 1651 1652
        image augmentation. Currently, only horizontal flipping is offered.
    augmentation: Optional. An imgaug (https://github.com/aleju/imgaug) augmentation.
        For example, passing imgaug.augmenters.Fliplr(0.5) flips images
        right/left 50% of the time.
W
Waleed Abdulla 已提交
1653 1654 1655 1656 1657 1658 1659
    random_rois: If > 0 then generate proposals to be used to train the
                 network classifier and mask heads. Useful if training
                 the Mask RCNN part without the RPN.
    batch_size: How many images to return in each call
    detection_targets: If True, generate detection targets (class IDs, bbox
        deltas, and masks). Typically for debugging or visualizations because
        in trainig detection targets are generated by DetectionTargetLayer.
1660 1661 1662
    no_augmentation_sources: Optional. List of sources to exclude for
        augmentation. A source is string that identifies a dataset and is
        defined in the Dataset class.
W
Waleed Abdulla 已提交
1663

G
Gyuri Im 已提交
1664
    Returns a Python generator. Upon calling next() on it, the
C
Corey Hu 已提交
1665
    generator returns two lists, inputs and outputs. The contents
W
Waleed Abdulla 已提交
1666 1667 1668
    of the lists differs depending on the received arguments:
    inputs list:
    - images: [batch, H, W, C]
1669
    - image_meta: [batch, (meta data)] Image details. See compose_image_meta()
W
Waleed Abdulla 已提交
1670 1671
    - rpn_match: [batch, N] Integer (1=positive anchor, -1=negative, 0=neutral)
    - rpn_bbox: [batch, N, (dy, dx, log(dh), log(dw))] Anchor bbox deltas.
1672 1673
    - gt_class_ids: [batch, MAX_GT_INSTANCES] Integer class IDs
    - gt_boxes: [batch, MAX_GT_INSTANCES, (y1, x1, y2, x2)]
W
Waleed Abdulla 已提交
1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685
    - gt_masks: [batch, height, width, MAX_GT_INSTANCES]. The height and width
                are those of the image unless use_mini_mask is True, in which
                case they are defined in MINI_MASK_SHAPE.

    outputs list: Usually empty in regular training. But if detection_targets
        is True then the outputs list contains target class_ids, bbox deltas,
        and masks.
    """
    b = 0  # batch item index
    image_index = -1
    image_ids = np.copy(dataset.image_ids)
    error_count = 0
1686
    no_augmentation_sources = no_augmentation_sources or []
W
Waleed Abdulla 已提交
1687 1688 1689

    # Anchors
    # [anchor_count, (y1, x1, y2, x2)]
1690
    backbone_shapes = compute_backbone_shapes(config, config.IMAGE_SHAPE)
G
Gyuri Im 已提交
1691 1692
    anchors = utils.generate_pyramid_anchors(config.RPN_ANCHOR_SCALES,
                                             config.RPN_ANCHOR_RATIOS,
1693
                                             backbone_shapes,
G
Gyuri Im 已提交
1694 1695
                                             config.BACKBONE_STRIDES,
                                             config.RPN_ANCHOR_STRIDE)
W
Waleed Abdulla 已提交
1696

C
Corey Hu 已提交
1697
    # Keras requires a generator to run indefinitely.
W
Waleed Abdulla 已提交
1698 1699 1700 1701 1702 1703 1704 1705 1706
    while True:
        try:
            # Increment index to pick next image. Shuffle if at the start of an epoch.
            image_index = (image_index + 1) % len(image_ids)
            if shuffle and image_index == 0:
                np.random.shuffle(image_ids)

            # Get GT bounding boxes and masks for image.
            image_id = image_ids[image_index]
N
Nick 已提交
1707 1708 1709 1710

            # If the image source is not to be augmented pass None as augmentation
            if dataset.image_info[image_id]['source'] in no_augmentation_sources:
                image, image_meta, gt_class_ids, gt_boxes, gt_masks = \
W
Waleed Abdulla 已提交
1711
                load_image_gt(dataset, config, image_id, augment=augment,
N
Nick 已提交
1712
                              augmentation=None,
W
Waleed Abdulla 已提交
1713
                              use_mini_mask=config.USE_MINI_MASK)
N
Nick 已提交
1714 1715 1716 1717 1718
            else:
                image, image_meta, gt_class_ids, gt_boxes, gt_masks = \
                    load_image_gt(dataset, config, image_id, augment=augment,
                                augmentation=augmentation,
                                use_mini_mask=config.USE_MINI_MASK)
G
Gyuri Im 已提交
1719

1720
            # Skip images that have no instances. This can happen in cases
W
Waleed Abdulla 已提交
1721 1722
            # where we train on a subset of classes and the image doesn't
            # have any of the classes we care about.
W
Waleed Abdulla 已提交
1723
            if not np.any(gt_class_ids > 0):
W
Waleed Abdulla 已提交
1724 1725 1726
                continue

            # RPN Targets
1727 1728
            rpn_match, rpn_bbox = build_rpn_targets(image.shape, anchors,
                                                    gt_class_ids, gt_boxes, config)
W
Waleed Abdulla 已提交
1729 1730 1731

            # Mask R-CNN Targets
            if random_rois:
G
Gyuri Im 已提交
1732 1733
                rpn_rois = generate_random_rois(
                    image.shape, random_rois, gt_class_ids, gt_boxes)
W
Waleed Abdulla 已提交
1734 1735
                if detection_targets:
                    rois, mrcnn_class_ids, mrcnn_bbox, mrcnn_mask =\
G
Gyuri Im 已提交
1736 1737
                        build_detection_targets(
                            rpn_rois, gt_class_ids, gt_boxes, gt_masks, config)
W
Waleed Abdulla 已提交
1738 1739 1740

            # Init batch arrays
            if b == 0:
G
Gyuri Im 已提交
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752
                batch_image_meta = np.zeros(
                    (batch_size,) + image_meta.shape, dtype=image_meta.dtype)
                batch_rpn_match = np.zeros(
                    [batch_size, anchors.shape[0], 1], dtype=rpn_match.dtype)
                batch_rpn_bbox = np.zeros(
                    [batch_size, config.RPN_TRAIN_ANCHORS_PER_IMAGE, 4], dtype=rpn_bbox.dtype)
                batch_images = np.zeros(
                    (batch_size,) + image.shape, dtype=np.float32)
                batch_gt_class_ids = np.zeros(
                    (batch_size, config.MAX_GT_INSTANCES), dtype=np.int32)
                batch_gt_boxes = np.zeros(
                    (batch_size, config.MAX_GT_INSTANCES, 4), dtype=np.int32)
1753
                batch_gt_masks = np.zeros(
1754
                    (batch_size, gt_masks.shape[0], gt_masks.shape[1],
1755
                     config.MAX_GT_INSTANCES), dtype=gt_masks.dtype)
W
Waleed Abdulla 已提交
1756
                if random_rois:
G
Gyuri Im 已提交
1757 1758
                    batch_rpn_rois = np.zeros(
                        (batch_size, rpn_rois.shape[0], 4), dtype=rpn_rois.dtype)
W
Waleed Abdulla 已提交
1759
                    if detection_targets:
G
Gyuri Im 已提交
1760 1761 1762 1763 1764 1765 1766 1767
                        batch_rois = np.zeros(
                            (batch_size,) + rois.shape, dtype=rois.dtype)
                        batch_mrcnn_class_ids = np.zeros(
                            (batch_size,) + mrcnn_class_ids.shape, dtype=mrcnn_class_ids.dtype)
                        batch_mrcnn_bbox = np.zeros(
                            (batch_size,) + mrcnn_bbox.shape, dtype=mrcnn_bbox.dtype)
                        batch_mrcnn_mask = np.zeros(
                            (batch_size,) + mrcnn_mask.shape, dtype=mrcnn_mask.dtype)
W
Waleed Abdulla 已提交
1768 1769 1770

            # If more instances than fits in the array, sub-sample from them.
            if gt_boxes.shape[0] > config.MAX_GT_INSTANCES:
G
Gyuri Im 已提交
1771 1772
                ids = np.random.choice(
                    np.arange(gt_boxes.shape[0]), config.MAX_GT_INSTANCES, replace=False)
1773
                gt_class_ids = gt_class_ids[ids]
W
Waleed Abdulla 已提交
1774
                gt_boxes = gt_boxes[ids]
G
Gyuri Im 已提交
1775
                gt_masks = gt_masks[:, :, ids]
W
Waleed Abdulla 已提交
1776 1777 1778 1779 1780 1781

            # Add to batch
            batch_image_meta[b] = image_meta
            batch_rpn_match[b] = rpn_match[:, np.newaxis]
            batch_rpn_bbox[b] = rpn_bbox
            batch_images[b] = mold_image(image.astype(np.float32), config)
G
Gyuri Im 已提交
1782 1783 1784
            batch_gt_class_ids[b, :gt_class_ids.shape[0]] = gt_class_ids
            batch_gt_boxes[b, :gt_boxes.shape[0]] = gt_boxes
            batch_gt_masks[b, :, :, :gt_masks.shape[-1]] = gt_masks
W
Waleed Abdulla 已提交
1785
            if random_rois:
1786
                batch_rpn_rois[b] = rpn_rois
W
Waleed Abdulla 已提交
1787 1788 1789 1790 1791 1792 1793 1794 1795 1796
                if detection_targets:
                    batch_rois[b] = rois
                    batch_mrcnn_class_ids[b] = mrcnn_class_ids
                    batch_mrcnn_bbox[b] = mrcnn_bbox
                    batch_mrcnn_mask[b] = mrcnn_mask
            b += 1

            # Batch full?
            if b >= batch_size:
                inputs = [batch_images, batch_image_meta, batch_rpn_match, batch_rpn_bbox,
1797
                          batch_gt_class_ids, batch_gt_boxes, batch_gt_masks]
W
Waleed Abdulla 已提交
1798 1799 1800 1801 1802 1803 1804
                outputs = []

                if random_rois:
                    inputs.extend([batch_rpn_rois])
                    if detection_targets:
                        inputs.extend([batch_rois])
                        # Keras requires that output and targets have the same number of dimensions
G
Gyuri Im 已提交
1805 1806 1807 1808
                        batch_mrcnn_class_ids = np.expand_dims(
                            batch_mrcnn_class_ids, -1)
                        outputs.extend(
                            [batch_mrcnn_class_ids, batch_mrcnn_bbox, batch_mrcnn_mask])
W
Waleed Abdulla 已提交
1809 1810 1811 1812 1813 1814 1815 1816 1817

                yield inputs, outputs

                # start a new batch
                b = 0
        except (GeneratorExit, KeyboardInterrupt):
            raise
        except:
            # Log it and skip the image
G
Gyuri Im 已提交
1818 1819
            logging.exception("Error processing image {}".format(
                dataset.image_info[image_id]))
W
Waleed Abdulla 已提交
1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833
            error_count += 1
            if error_count > 5:
                raise


############################################################
#  MaskRCNN Class
############################################################

class MaskRCNN():
    """Encapsulates the Mask RCNN model functionality.

    The actual Keras model is in the keras_model property.
    """
G
Gyuri Im 已提交
1834

W
Waleed Abdulla 已提交
1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850
    def __init__(self, mode, config, model_dir):
        """
        mode: Either "training" or "inference"
        config: A Sub-class of the Config class
        model_dir: Directory to save training logs and trained weights
        """
        assert mode in ['training', 'inference']
        self.mode = mode
        self.config = config
        self.model_dir = model_dir
        self.set_log_dir()
        self.keras_model = self.build(mode=mode, config=config)

    def build(self, mode, config):
        """Build Mask R-CNN architecture.
            input_shape: The shape of the input image.
G
Gyuri Im 已提交
1851
            mode: Either "training" or "inference". The inputs and
W
Waleed Abdulla 已提交
1852 1853 1854
                outputs of the model differ accordingly.
        """
        assert mode in ['training', 'inference']
G
Gyuri Im 已提交
1855

W
Waleed Abdulla 已提交
1856 1857
        # Image size must be dividable by 2 multiple times
        h, w = config.IMAGE_SHAPE[:2]
G
Gyuri Im 已提交
1858
        if h / 2**6 != int(h / 2**6) or w / 2**6 != int(w / 2**6):
W
Waleed Abdulla 已提交
1859 1860 1861
            raise Exception("Image size must be dividable by 2 at least 6 times "
                            "to avoid fractions when downscaling and upscaling."
                            "For example, use 256, 320, 384, 448, 512, ... etc. ")
G
Gyuri Im 已提交
1862

W
Waleed Abdulla 已提交
1863
        # Inputs
G
Gyuri Im 已提交
1864
        input_image = KL.Input(
1865
            shape=[None, None, config.IMAGE_SHAPE[2]], name="input_image")
1866 1867
        input_image_meta = KL.Input(shape=[config.IMAGE_META_SIZE],
                                    name="input_image_meta")
W
Waleed Abdulla 已提交
1868 1869
        if mode == "training":
            # RPN GT
G
Gyuri Im 已提交
1870 1871 1872 1873
            input_rpn_match = KL.Input(
                shape=[None, 1], name="input_rpn_match", dtype=tf.int32)
            input_rpn_bbox = KL.Input(
                shape=[None, 4], name="input_rpn_bbox", dtype=tf.float32)
1874 1875 1876

            # Detection GT (class IDs, bounding boxes, and masks)
            # 1. GT Class IDs (zero padded)
G
Gyuri Im 已提交
1877 1878
            input_gt_class_ids = KL.Input(
                shape=[None], name="input_gt_class_ids", dtype=tf.int32)
1879 1880
            # 2. GT Boxes in pixels (zero padded)
            # [batch, MAX_GT_INSTANCES, (y1, x1, y2, x2)] in image coordinates
G
Gyuri Im 已提交
1881 1882
            input_gt_boxes = KL.Input(
                shape=[None, 4], name="input_gt_boxes", dtype=tf.float32)
W
Waleed Abdulla 已提交
1883
            # Normalize coordinates
1884 1885
            gt_boxes = KL.Lambda(lambda x: norm_boxes_graph(
                x, K.shape(input_image)[1:3]))(input_gt_boxes)
1886
            # 3. GT Masks (zero padded)
W
Waleed Abdulla 已提交
1887 1888 1889
            # [batch, height, width, MAX_GT_INSTANCES]
            if config.USE_MINI_MASK:
                input_gt_masks = KL.Input(
G
Gyuri Im 已提交
1890 1891
                    shape=[config.MINI_MASK_SHAPE[0],
                           config.MINI_MASK_SHAPE[1], None],
W
Waleed Abdulla 已提交
1892 1893 1894 1895 1896
                    name="input_gt_masks", dtype=bool)
            else:
                input_gt_masks = KL.Input(
                    shape=[config.IMAGE_SHAPE[0], config.IMAGE_SHAPE[1], None],
                    name="input_gt_masks", dtype=bool)
1897 1898 1899
        elif mode == "inference":
            # Anchors in normalized coordinates
            input_anchors = KL.Input(shape=[None, 4], name="input_anchors")
G
Gyuri Im 已提交
1900

W
Waleed Abdulla 已提交
1901 1902 1903 1904
        # Build the shared convolutional layers.
        # Bottom-up Layers
        # Returns a list of the last layers of each stage, 5 in total.
        # Don't create the thead (stage 5), so we pick the 4th item in the list.
1905 1906 1907 1908 1909 1910
        if callable(config.BACKBONE):
            _, C2, C3, C4, C5 = config.BACKBONE(input_image, stage5=True,
                                                train_bn=config.TRAIN_BN)
        else:
            _, C2, C3, C4, C5 = resnet_graph(input_image, config.BACKBONE,
                                             stage5=True, train_bn=config.TRAIN_BN)
W
Waleed Abdulla 已提交
1911 1912
        # Top-down Layers
        # TODO: add assert to varify feature map sizes match what's in config
1913
        P5 = KL.Conv2D(config.TOP_DOWN_PYRAMID_SIZE, (1, 1), name='fpn_c5p5')(C5)
W
Waleed Abdulla 已提交
1914 1915
        P4 = KL.Add(name="fpn_p4add")([
            KL.UpSampling2D(size=(2, 2), name="fpn_p5upsampled")(P5),
1916
            KL.Conv2D(config.TOP_DOWN_PYRAMID_SIZE, (1, 1), name='fpn_c4p4')(C4)])
W
Waleed Abdulla 已提交
1917 1918
        P3 = KL.Add(name="fpn_p3add")([
            KL.UpSampling2D(size=(2, 2), name="fpn_p4upsampled")(P4),
1919
            KL.Conv2D(config.TOP_DOWN_PYRAMID_SIZE, (1, 1), name='fpn_c3p3')(C3)])
W
Waleed Abdulla 已提交
1920 1921
        P2 = KL.Add(name="fpn_p2add")([
            KL.UpSampling2D(size=(2, 2), name="fpn_p3upsampled")(P3),
1922
            KL.Conv2D(config.TOP_DOWN_PYRAMID_SIZE, (1, 1), name='fpn_c2p2')(C2)])
W
Waleed Abdulla 已提交
1923
        # Attach 3x3 conv to all P layers to get the final feature maps.
1924 1925 1926 1927
        P2 = KL.Conv2D(config.TOP_DOWN_PYRAMID_SIZE, (3, 3), padding="SAME", name="fpn_p2")(P2)
        P3 = KL.Conv2D(config.TOP_DOWN_PYRAMID_SIZE, (3, 3), padding="SAME", name="fpn_p3")(P3)
        P4 = KL.Conv2D(config.TOP_DOWN_PYRAMID_SIZE, (3, 3), padding="SAME", name="fpn_p4")(P4)
        P5 = KL.Conv2D(config.TOP_DOWN_PYRAMID_SIZE, (3, 3), padding="SAME", name="fpn_p5")(P5)
W
Waleed Abdulla 已提交
1928 1929 1930
        # P6 is used for the 5th anchor scale in RPN. Generated by
        # subsampling from P5 with stride of 2.
        P6 = KL.MaxPooling2D(pool_size=(1, 1), strides=2, name="fpn_p6")(P5)
G
Gyuri Im 已提交
1931

W
Waleed Abdulla 已提交
1932 1933 1934
        # Note that P6 is used in RPN, but not in the classifier heads.
        rpn_feature_maps = [P2, P3, P4, P5, P6]
        mrcnn_feature_maps = [P2, P3, P4, P5]
G
Gyuri Im 已提交
1935

1936 1937 1938 1939 1940 1941 1942
        # Anchors
        if mode == "training":
            anchors = self.get_anchors(config.IMAGE_SHAPE)
            # Duplicate across the batch dimension because Keras requires it
            # TODO: can this be optimized to avoid duplicating the anchors?
            anchors = np.broadcast_to(anchors, (config.BATCH_SIZE,) + anchors.shape)
            # A hack to get around Keras's bad support for constants
W
Waleed Abdulla 已提交
1943
            anchors = KL.Lambda(lambda x: tf.Variable(anchors), name="anchors")(input_image)
1944 1945
        else:
            anchors = input_anchors
G
Gyuri Im 已提交
1946

W
Waleed Abdulla 已提交
1947
        # RPN Model
G
Gyuri Im 已提交
1948
        rpn = build_rpn_model(config.RPN_ANCHOR_STRIDE,
1949
                              len(config.RPN_ANCHOR_RATIOS), config.TOP_DOWN_PYRAMID_SIZE)
W
Waleed Abdulla 已提交
1950 1951 1952 1953 1954
        # Loop through pyramid layers
        layer_outputs = []  # list of lists
        for p in rpn_feature_maps:
            layer_outputs.append(rpn([p]))
        # Concatenate layer outputs
G
Gyuri Im 已提交
1955 1956
        # Convert from list of lists of level outputs to list of lists
        # of outputs across levels.
W
Waleed Abdulla 已提交
1957 1958 1959
        # e.g. [[a1, b1, c1], [a2, b2, c2]] => [[a1, a2], [b1, b2], [c1, c2]]
        output_names = ["rpn_class_logits", "rpn_class", "rpn_bbox"]
        outputs = list(zip(*layer_outputs))
G
Gyuri Im 已提交
1960 1961 1962
        outputs = [KL.Concatenate(axis=1, name=n)(list(o))
                   for o, n in zip(outputs, output_names)]

W
Waleed Abdulla 已提交
1963 1964 1965
        rpn_class_logits, rpn_class, rpn_bbox = outputs

        # Generate proposals
W
Waleed Abdulla 已提交
1966 1967
        # Proposals are [batch, N, (y1, x1, y2, x2)] in normalized coordinates
        # and zero padded.
W
Waleed Abdulla 已提交
1968
        proposal_count = config.POST_NMS_ROIS_TRAINING if mode == "training"\
G
Gyuri Im 已提交
1969
            else config.POST_NMS_ROIS_INFERENCE
1970 1971 1972 1973 1974
        rpn_rois = ProposalLayer(
            proposal_count=proposal_count,
            nms_threshold=config.RPN_NMS_THRESHOLD,
            name="ROI",
            config=config)([rpn_class, rpn_bbox, anchors])
W
Waleed Abdulla 已提交
1975 1976 1977 1978

        if mode == "training":
            # Class ID mask to mark class IDs supported by the dataset the image
            # came from.
1979 1980 1981
            active_class_ids = KL.Lambda(
                lambda x: parse_image_meta_graph(x)["active_class_ids"]
                )(input_image_meta)
W
Waleed Abdulla 已提交
1982 1983 1984 1985

            if not config.USE_RPN_ROIS:
                # Ignore predicted ROIs and use ROIs provided as an input.
                input_rois = KL.Input(shape=[config.POST_NMS_ROIS_TRAINING, 4],
G
Gyuri Im 已提交
1986
                                      name="input_roi", dtype=np.int32)
1987 1988 1989
                # Normalize coordinates
                target_rois = KL.Lambda(lambda x: norm_boxes_graph(
                    x, K.shape(input_image)[1:3]))(input_rois)
W
Waleed Abdulla 已提交
1990 1991 1992 1993 1994
            else:
                target_rois = rpn_rois

            # Generate detection targets
            # Subsamples proposals and generates target outputs for training
1995 1996
            # Note that proposal class IDs, gt_boxes, and gt_masks are zero
            # padded. Equally, returned rois and targets are zero padded.
W
Waleed Abdulla 已提交
1997 1998
            rois, target_class_ids, target_bbox, target_mask =\
                DetectionTargetLayer(config, name="proposal_targets")([
1999
                    target_rois, input_gt_class_ids, gt_boxes, input_gt_masks])
W
Waleed Abdulla 已提交
2000 2001 2002 2003

            # Network Heads
            # TODO: verify that this handles zero padded ROIs
            mrcnn_class_logits, mrcnn_class, mrcnn_bbox =\
2004
                fpn_classifier_graph(rois, mrcnn_feature_maps, input_image_meta,
2005
                                     config.POOL_SIZE, config.NUM_CLASSES,
2006 2007
                                     train_bn=config.TRAIN_BN,
                                     fc_layers_size=config.FPN_CLASSIF_FC_LAYERS_SIZE)
G
Gyuri Im 已提交
2008

W
Waleed Abdulla 已提交
2009
            mrcnn_mask = build_fpn_mask_graph(rois, mrcnn_feature_maps,
2010
                                              input_image_meta,
W
Waleed Abdulla 已提交
2011
                                              config.MASK_POOL_SIZE,
2012 2013
                                              config.NUM_CLASSES,
                                              train_bn=config.TRAIN_BN)
W
Waleed Abdulla 已提交
2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030

            # TODO: clean up (use tf.identify if necessary)
            output_rois = KL.Lambda(lambda x: x * 1, name="output_rois")(rois)

            # Losses
            rpn_class_loss = KL.Lambda(lambda x: rpn_class_loss_graph(*x), name="rpn_class_loss")(
                [input_rpn_match, rpn_class_logits])
            rpn_bbox_loss = KL.Lambda(lambda x: rpn_bbox_loss_graph(config, *x), name="rpn_bbox_loss")(
                [input_rpn_bbox, input_rpn_match, rpn_bbox])
            class_loss = KL.Lambda(lambda x: mrcnn_class_loss_graph(*x), name="mrcnn_class_loss")(
                [target_class_ids, mrcnn_class_logits, active_class_ids])
            bbox_loss = KL.Lambda(lambda x: mrcnn_bbox_loss_graph(*x), name="mrcnn_bbox_loss")(
                [target_bbox, target_class_ids, mrcnn_bbox])
            mask_loss = KL.Lambda(lambda x: mrcnn_mask_loss_graph(*x), name="mrcnn_mask_loss")(
                [target_mask, target_class_ids, mrcnn_mask])

            # Model
G
Gyuri Im 已提交
2031 2032
            inputs = [input_image, input_image_meta,
                      input_rpn_match, input_rpn_bbox, input_gt_class_ids, input_gt_boxes, input_gt_masks]
W
Waleed Abdulla 已提交
2033 2034 2035
            if not config.USE_RPN_ROIS:
                inputs.append(input_rois)
            outputs = [rpn_class_logits, rpn_class, rpn_bbox,
G
Gyuri Im 已提交
2036 2037 2038
                       mrcnn_class_logits, mrcnn_class, mrcnn_bbox, mrcnn_mask,
                       rpn_rois, output_rois,
                       rpn_class_loss, rpn_bbox_loss, class_loss, bbox_loss, mask_loss]
W
Waleed Abdulla 已提交
2039 2040 2041 2042 2043
            model = KM.Model(inputs, outputs, name='mask_rcnn')
        else:
            # Network Heads
            # Proposal classifier and BBox regressor heads
            mrcnn_class_logits, mrcnn_class, mrcnn_bbox =\
2044
                fpn_classifier_graph(rpn_rois, mrcnn_feature_maps, input_image_meta,
2045
                                     config.POOL_SIZE, config.NUM_CLASSES,
2046 2047
                                     train_bn=config.TRAIN_BN,
                                     fc_layers_size=config.FPN_CLASSIF_FC_LAYERS_SIZE)
W
Waleed Abdulla 已提交
2048 2049

            # Detections
2050
            # output is [batch, num_detections, (y1, x1, y2, x2, class_id, score)] in
2051
            # normalized coordinates
W
Waleed Abdulla 已提交
2052 2053 2054 2055
            detections = DetectionLayer(config, name="mrcnn_detection")(
                [rpn_rois, mrcnn_class, mrcnn_bbox, input_image_meta])

            # Create masks for detections
2056
            detection_boxes = KL.Lambda(lambda x: x[..., :4])(detections)
W
Waleed Abdulla 已提交
2057
            mrcnn_mask = build_fpn_mask_graph(detection_boxes, mrcnn_feature_maps,
2058
                                              input_image_meta,
W
Waleed Abdulla 已提交
2059
                                              config.MASK_POOL_SIZE,
2060 2061
                                              config.NUM_CLASSES,
                                              train_bn=config.TRAIN_BN)
W
Waleed Abdulla 已提交
2062

2063
            model = KM.Model([input_image, input_image_meta, input_anchors],
G
Gyuri Im 已提交
2064 2065 2066 2067
                             [detections, mrcnn_class, mrcnn_bbox,
                                 mrcnn_mask, rpn_rois, rpn_class, rpn_bbox],
                             name='mask_rcnn')

W
Waleed Abdulla 已提交
2068 2069
        # Add multi-GPU support.
        if config.GPU_COUNT > 1:
J
jirka 已提交
2070
            from mrcnn.parallel_model import ParallelModel
W
Waleed Abdulla 已提交
2071
            model = ParallelModel(model, config.GPU_COUNT)
G
Gyuri Im 已提交
2072

W
Waleed Abdulla 已提交
2073 2074 2075 2076 2077 2078
        return model

    def find_last(self):
        """Finds the last checkpoint file of the last trained model in the
        model directory.
        Returns:
2079
            The path of the last checkpoint file
W
Waleed Abdulla 已提交
2080 2081 2082 2083 2084 2085 2086
        """
        # Get directory names. Each directory corresponds to a model
        dir_names = next(os.walk(self.model_dir))[1]
        key = self.config.NAME.lower()
        dir_names = filter(lambda f: f.startswith(key), dir_names)
        dir_names = sorted(dir_names)
        if not dir_names:
2087 2088 2089 2090
            import errno
            raise FileNotFoundError(
                errno.ENOENT,
                "Could not find model directory under {}".format(self.model_dir))
W
Waleed Abdulla 已提交
2091 2092 2093 2094 2095 2096 2097
        # Pick last directory
        dir_name = os.path.join(self.model_dir, dir_names[-1])
        # Find the last checkpoint
        checkpoints = next(os.walk(dir_name))[2]
        checkpoints = filter(lambda f: f.startswith("mask_rcnn"), checkpoints)
        checkpoints = sorted(checkpoints)
        if not checkpoints:
2098 2099 2100
            import errno
            raise FileNotFoundError(
                errno.ENOENT, "Could not find weight files in {}".format(dir_name))
W
Waleed Abdulla 已提交
2101
        checkpoint = os.path.join(dir_name, checkpoints[-1])
2102
        return checkpoint
W
Waleed Abdulla 已提交
2103 2104

    def load_weights(self, filepath, by_name=False, exclude=None):
C
Corey Hu 已提交
2105
        """Modified version of the corresponding Keras function with
W
Waleed Abdulla 已提交
2106 2107
        the addition of multi-GPU support and the ability to exclude
        some layers from loading.
C
Corey Hu 已提交
2108
        exclude: list of layer names to exclude
W
Waleed Abdulla 已提交
2109 2110
        """
        import h5py
2111 2112 2113 2114 2115 2116 2117
        # Conditional import to support versions of Keras before 2.2
        # TODO: remove in about 6 months (end of 2018)
        try:
            from keras.engine import saving
        except ImportError:
            # Keras before 2.2 used the 'topology' namespace.
            from keras.engine import topology as saving
W
Waleed Abdulla 已提交
2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136

        if exclude:
            by_name = True

        if h5py is None:
            raise ImportError('`load_weights` requires h5py.')
        f = h5py.File(filepath, mode='r')
        if 'layer_names' not in f.attrs and 'model_weights' in f:
            f = f['model_weights']

        # In multi-GPU training, we wrap the model. Get layers
        # of the inner model because they have the weights.
        keras_model = self.keras_model
        layers = keras_model.inner_model.layers if hasattr(keras_model, "inner_model")\
            else keras_model.layers

        # Exclude some layers
        if exclude:
            layers = filter(lambda l: l.name not in exclude, layers)
G
Gyuri Im 已提交
2137

W
Waleed Abdulla 已提交
2138
        if by_name:
G
gtgalone 已提交
2139
            saving.load_weights_from_hdf5_group_by_name(f, layers)
W
Waleed Abdulla 已提交
2140
        else:
G
gtgalone 已提交
2141
            saving.load_weights_from_hdf5_group(f, layers)
W
Waleed Abdulla 已提交
2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160
        if hasattr(f, 'close'):
            f.close()

        # Update the log directory
        self.set_log_dir(filepath)

    def get_imagenet_weights(self):
        """Downloads ImageNet trained weights from Keras.
        Returns path to weights file.
        """
        from keras.utils.data_utils import get_file
        TF_WEIGHTS_PATH_NO_TOP = 'https://github.com/fchollet/deep-learning-models/'\
                                 'releases/download/v0.2/'\
                                 'resnet50_weights_tf_dim_ordering_tf_kernels_notop.h5'
        weights_path = get_file('resnet50_weights_tf_dim_ordering_tf_kernels_notop.h5',
                                TF_WEIGHTS_PATH_NO_TOP,
                                cache_subdir='models',
                                md5_hash='a268eb855778b3df3c7506639542a6af')
        return weights_path
G
Gyuri Im 已提交
2161

W
Waleed Abdulla 已提交
2162 2163 2164 2165 2166
    def compile(self, learning_rate, momentum):
        """Gets the model ready for training. Adds losses, regularization, and
        metrics. Then calls the Keras compile() function.
        """
        # Optimizer object
K
Kolesnikov Sergey 已提交
2167 2168 2169
        optimizer = keras.optimizers.SGD(
            lr=learning_rate, momentum=momentum,
            clipnorm=self.config.GRADIENT_CLIP_NORM)
W
Waleed Abdulla 已提交
2170 2171 2172 2173
        # Add Losses
        # First, clear previously set losses to avoid duplication
        self.keras_model._losses = []
        self.keras_model._per_input_losses = {}
K
Kolesnikov Sergey 已提交
2174 2175 2176
        loss_names = [
            "rpn_class_loss",  "rpn_bbox_loss",
            "mrcnn_class_loss", "mrcnn_bbox_loss", "mrcnn_mask_loss"]
W
Waleed Abdulla 已提交
2177 2178 2179 2180
        for name in loss_names:
            layer = self.keras_model.get_layer(name)
            if layer.output in self.keras_model.losses:
                continue
K
Kolesnikov Sergey 已提交
2181
            loss = (
2182
                tf.reduce_mean(layer.output, keepdims=True)
K
Kolesnikov Sergey 已提交
2183 2184
                * self.config.LOSS_WEIGHTS.get(name, 1.))
            self.keras_model.add_loss(loss)
W
Waleed Abdulla 已提交
2185 2186

        # Add L2 Regularization
2187
        # Skip gamma and beta weights of batch normalization layers.
K
Kolesnikov Sergey 已提交
2188 2189 2190 2191
        reg_losses = [
            keras.regularizers.l2(self.config.WEIGHT_DECAY)(w) / tf.cast(tf.size(w), tf.float32)
            for w in self.keras_model.trainable_weights
            if 'gamma' not in w.name and 'beta' not in w.name]
W
Waleed Abdulla 已提交
2192
        self.keras_model.add_loss(tf.add_n(reg_losses))
2193

W
Waleed Abdulla 已提交
2194
        # Compile
K
Kolesnikov Sergey 已提交
2195 2196 2197
        self.keras_model.compile(
            optimizer=optimizer,
            loss=[None] * len(self.keras_model.outputs))
W
Waleed Abdulla 已提交
2198

W
Cleanup  
Waleed Abdulla 已提交
2199
        # Add metrics for losses
W
Waleed Abdulla 已提交
2200 2201 2202 2203 2204
        for name in loss_names:
            if name in self.keras_model.metrics_names:
                continue
            layer = self.keras_model.get_layer(name)
            self.keras_model.metrics_names.append(name)
K
Kolesnikov Sergey 已提交
2205
            loss = (
2206
                tf.reduce_mean(layer.output, keepdims=True)
K
Kolesnikov Sergey 已提交
2207 2208
                * self.config.LOSS_WEIGHTS.get(name, 1.))
            self.keras_model.metrics_tensors.append(loss)
W
Waleed Abdulla 已提交
2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228

    def set_trainable(self, layer_regex, keras_model=None, indent=0, verbose=1):
        """Sets model layers as trainable if their names match
        the given regular expression.
        """
        # Print message on the first call (but not on recursive calls)
        if verbose > 0 and keras_model is None:
            log("Selecting layers to train")

        keras_model = keras_model or self.keras_model

        # In multi-GPU training, we wrap the model. Get layers
        # of the inner model because they have the weights.
        layers = keras_model.inner_model.layers if hasattr(keras_model, "inner_model")\
            else keras_model.layers

        for layer in layers:
            # Is the layer a model?
            if layer.__class__.__name__ == 'Model':
                print("In model: ", layer.name)
G
Gyuri Im 已提交
2229 2230
                self.set_trainable(
                    layer_regex, keras_model=layer, indent=indent + 4)
W
Waleed Abdulla 已提交
2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241
                continue

            if not layer.weights:
                continue
            # Is it trainable?
            trainable = bool(re.fullmatch(layer_regex, layer.name))
            # Update layer. If layer is a container, update inner layer.
            if layer.__class__.__name__ == 'TimeDistributed':
                layer.layer.trainable = trainable
            else:
                layer.trainable = trainable
C
Corey Hu 已提交
2242
            # Print trainable layer names
W
Waleed Abdulla 已提交
2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262
            if trainable and verbose > 0:
                log("{}{:20}   ({})".format(" " * indent, layer.name,
                                            layer.__class__.__name__))

    def set_log_dir(self, model_path=None):
        """Sets the model log directory and epoch counter.

        model_path: If None, or a format different from what this code uses
            then set a new log directory and start epochs from 0. Otherwise,
            extract the log directory and the epoch counter from the file
            name.
        """
        # Set date and epoch counter as if starting a new model
        self.epoch = 0
        now = datetime.datetime.now()

        # If we have a model path with date and epochs use them
        if model_path:
            # Continue from we left of. Get epoch and date from the file name
            # A sample model path might look like:
W
Waleed 已提交
2263 2264 2265
            # \path\to\logs\coco20171029T2315\mask_rcnn_coco_0001.h5 (Windows)
            # /path/to/logs/coco20171029T2315/mask_rcnn_coco_0001.h5 (Linux)
            regex = r".*[/\\][\w-]+(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})[/\\]mask\_rcnn\_[\w-]+(\d{4})\.h5"
W
Waleed Abdulla 已提交
2266 2267 2268 2269
            m = re.match(regex, model_path)
            if m:
                now = datetime.datetime(int(m.group(1)), int(m.group(2)), int(m.group(3)),
                                        int(m.group(4)), int(m.group(5)))
2270 2271 2272
                # Epoch number in file is 1-based, and in Keras code it's 0-based.
                # So, adjust for that then increment by one to start from the next epoch
                self.epoch = int(m.group(6)) - 1 + 1
J
Julien Rebetez 已提交
2273
                print('Re-starting from epoch %d' % self.epoch)
W
Waleed Abdulla 已提交
2274 2275 2276 2277 2278 2279 2280 2281

        # Directory for training logs
        self.log_dir = os.path.join(self.model_dir, "{}{:%Y%m%dT%H%M}".format(
            self.config.NAME.lower(), now))

        # Path to save after each epoch. Include placeholders that get filled by Keras.
        self.checkpoint_path = os.path.join(self.log_dir, "mask_rcnn_{}_*epoch*.h5".format(
            self.config.NAME.lower()))
G
Gyuri Im 已提交
2282 2283
        self.checkpoint_path = self.checkpoint_path.replace(
            "*epoch*", "{epoch:04d}")
W
Waleed Abdulla 已提交
2284

W
Waleed Abdulla 已提交
2285
    def train(self, train_dataset, val_dataset, learning_rate, epochs, layers,
2286
              augmentation=None, custom_callbacks=None, no_augmentation_sources=None):
W
Waleed Abdulla 已提交
2287 2288 2289 2290 2291 2292 2293 2294 2295 2296
        """Train the model.
        train_dataset, val_dataset: Training and validation Dataset objects.
        learning_rate: The learning rate to train with
        epochs: Number of training epochs. Note that previous training epochs
                are considered to be done alreay, so this actually determines
                the epochs to train in total rather than in this particaular
                call.
        layers: Allows selecting wich layers to train. It can be:
            - A regular expression to match layer names to train
            - One of these predefined values:
J
Ji Hou 已提交
2297
              heads: The RPN, classifier and mask heads of the network
W
Waleed Abdulla 已提交
2298 2299 2300 2301
              all: All the layers
              3+: Train Resnet stage 3 and up
              4+: Train Resnet stage 4 and up
              5+: Train Resnet stage 5 and up
W
Waleed Abdulla 已提交
2302 2303 2304 2305 2306
        augmentation: Optional. An imgaug (https://github.com/aleju/imgaug)
            augmentation. For example, passing imgaug.augmenters.Fliplr(0.5)
            flips images right/left 50% of the time. You can pass complex
            augmentations as well. This augmentation applies 50% of the
            time, and when it does it flips images right/left half the time
C
Corey Hu 已提交
2307
            and adds a Gaussian blur with a random sigma in range 0 to 5.
W
Waleed Abdulla 已提交
2308 2309 2310 2311 2312

                augmentation = imgaug.augmenters.Sometimes(0.5, [
                    imgaug.augmenters.Fliplr(0.5),
                    imgaug.augmenters.GaussianBlur(sigma=(0.0, 5.0))
                ])
2313
	    custom_callbacks: Optional. Add custom callbacks to be called
2314
	        with the keras fit_generator method. Must be list of type keras.callbacks.
2315 2316 2317
        no_augmentation_sources: Optional. List of sources to exclude for
            augmentation. A source is string that identifies a dataset and is
            defined in the Dataset class.
W
Waleed Abdulla 已提交
2318 2319 2320 2321 2322 2323 2324
        """
        assert self.mode == "training", "Create model in training mode."

        # Pre-defined layer regular expressions
        layer_regex = {
            # all layers but the backbone
            "heads": r"(mrcnn\_.*)|(rpn\_.*)|(fpn\_.*)",
W
Waleed Abdulla 已提交
2325
            # From a specific Resnet stage and up
W
Waleed Abdulla 已提交
2326 2327 2328 2329 2330 2331 2332 2333 2334 2335
            "3+": r"(res3.*)|(bn3.*)|(res4.*)|(bn4.*)|(res5.*)|(bn5.*)|(mrcnn\_.*)|(rpn\_.*)|(fpn\_.*)",
            "4+": r"(res4.*)|(bn4.*)|(res5.*)|(bn5.*)|(mrcnn\_.*)|(rpn\_.*)|(fpn\_.*)",
            "5+": r"(res5.*)|(bn5.*)|(mrcnn\_.*)|(rpn\_.*)|(fpn\_.*)",
            # All layers
            "all": ".*",
        }
        if layers in layer_regex.keys():
            layers = layer_regex[layers]

        # Data generators
G
Gyuri Im 已提交
2336
        train_generator = data_generator(train_dataset, self.config, shuffle=True,
W
Waleed Abdulla 已提交
2337
                                         augmentation=augmentation,
N
Nick 已提交
2338 2339
                                         batch_size=self.config.BATCH_SIZE,
                                         no_augmentation_sources=no_augmentation_sources)
G
Gyuri Im 已提交
2340
        val_generator = data_generator(val_dataset, self.config, shuffle=True,
2341
                                       batch_size=self.config.BATCH_SIZE)
W
Waleed Abdulla 已提交
2342

2343 2344 2345 2346
        # Create log_dir if it does not exist
        if not os.path.exists(self.log_dir):
            os.makedirs(self.log_dir)

W
Waleed Abdulla 已提交
2347 2348 2349 2350 2351 2352 2353
        # Callbacks
        callbacks = [
            keras.callbacks.TensorBoard(log_dir=self.log_dir,
                                        histogram_freq=0, write_graph=True, write_images=False),
            keras.callbacks.ModelCheckpoint(self.checkpoint_path,
                                            verbose=0, save_weights_only=True),
        ]
2354

N
Nick 已提交
2355
        # Add custom callbacks to the list
2356 2357
        if custom_callbacks:
            callbacks += custom_callbacks
G
Gyuri Im 已提交
2358

W
Waleed Abdulla 已提交
2359 2360 2361 2362 2363 2364
        # Train
        log("\nStarting at epoch {}. LR={}\n".format(self.epoch, learning_rate))
        log("Checkpoint Path: {}".format(self.checkpoint_path))
        self.set_trainable(layers)
        self.compile(learning_rate, self.config.LEARNING_MOMENTUM)

2365 2366 2367
        # Work-around for Windows: Keras fails on Windows when using
        # multiprocessing workers. See discussion here:
        # https://github.com/matterport/Mask_RCNN/issues/13#issuecomment-353124009
2368 2369 2370
        if os.name is 'nt':
            workers = 0
        else:
W
Waleed Abdulla 已提交
2371
            workers = multiprocessing.cpu_count()
2372

W
Waleed Abdulla 已提交
2373 2374 2375 2376
        self.keras_model.fit_generator(
            train_generator,
            initial_epoch=self.epoch,
            epochs=epochs,
W
Waleed Abdulla 已提交
2377 2378
            steps_per_epoch=self.config.STEPS_PER_EPOCH,
            callbacks=callbacks,
2379
            validation_data=val_generator,
W
Waleed Abdulla 已提交
2380 2381
            validation_steps=self.config.VALIDATION_STEPS,
            max_queue_size=100,
2382
            workers=workers,
W
Waleed Abdulla 已提交
2383
            use_multiprocessing=True,
G
Gyuri Im 已提交
2384
        )
W
Waleed Abdulla 已提交
2385
        self.epoch = max(self.epoch, epochs)
G
Gyuri Im 已提交
2386

W
Waleed Abdulla 已提交
2387 2388 2389
    def mold_inputs(self, images):
        """Takes a list of images and modifies them to the format expected
        as an input to the neural network.
C
Corey Hu 已提交
2390
        images: List of image matrices [height,width,depth]. Images can have
W
Waleed Abdulla 已提交
2391
            different sizes.
G
Gyuri Im 已提交
2392

C
Corey Hu 已提交
2393
        Returns 3 Numpy matrices:
W
Waleed Abdulla 已提交
2394 2395 2396 2397 2398 2399 2400 2401 2402
        molded_images: [N, h, w, 3]. Images resized and normalized.
        image_metas: [N, length of meta data]. Details about each image.
        windows: [N, (y1, x1, y2, x2)]. The portion of the image that has the
            original image (padding excluded).
        """
        molded_images = []
        image_metas = []
        windows = []
        for image in images:
W
Waleed Abdulla 已提交
2403
            # Resize image
W
Waleed Abdulla 已提交
2404
            # TODO: move resizing to mold_image()
2405
            molded_image, window, scale, padding, crop = utils.resize_image(
W
Waleed Abdulla 已提交
2406 2407
                image,
                min_dim=self.config.IMAGE_MIN_DIM,
2408
                min_scale=self.config.IMAGE_MIN_SCALE,
W
Waleed Abdulla 已提交
2409
                max_dim=self.config.IMAGE_MAX_DIM,
W
Waleed Abdulla 已提交
2410
                mode=self.config.IMAGE_RESIZE_MODE)
W
Waleed Abdulla 已提交
2411 2412 2413
            molded_image = mold_image(molded_image, self.config)
            # Build image_meta
            image_meta = compose_image_meta(
2414
                0, image.shape, molded_image.shape, window, scale,
W
Waleed Abdulla 已提交
2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425
                np.zeros([self.config.NUM_CLASSES], dtype=np.int32))
            # Append
            molded_images.append(molded_image)
            windows.append(window)
            image_metas.append(image_meta)
        # Pack into arrays
        molded_images = np.stack(molded_images)
        image_metas = np.stack(image_metas)
        windows = np.stack(windows)
        return molded_images, image_metas, windows

2426 2427
    def unmold_detections(self, detections, mrcnn_mask, original_image_shape,
                          image_shape, window):
W
Waleed Abdulla 已提交
2428 2429 2430 2431
        """Reformats the detections of one image from the format of the neural
        network output to a format suitable for use in the rest of the
        application.

2432
        detections: [N, (y1, x1, y2, x2, class_id, score)] in normalized coordinates
W
Waleed Abdulla 已提交
2433
        mrcnn_mask: [N, height, width, num_classes]
2434 2435 2436 2437
        original_image_shape: [H, W, C] Original image shape before resizing
        image_shape: [H, W, C] Shape of the image after resizing and padding
        window: [y1, x1, y2, x2] Pixel coordinates of box in the image where the real
                image is excluding the padding.
G
Gyuri Im 已提交
2438

W
Waleed Abdulla 已提交
2439 2440 2441 2442 2443 2444 2445 2446
        Returns:
        boxes: [N, (y1, x1, y2, x2)] Bounding boxes in pixels
        class_ids: [N] Integer class IDs for each bounding box
        scores: [N] Float probability scores of the class_id
        masks: [height, width, num_instances] Instance masks
        """
        # How many detections do we have?
        # Detections array is padded with zeros. Find the first class_id == 0.
G
Gyuri Im 已提交
2447
        zero_ix = np.where(detections[:, 4] == 0)[0]
W
Waleed Abdulla 已提交
2448
        N = zero_ix[0] if zero_ix.shape[0] > 0 else detections.shape[0]
G
Gyuri Im 已提交
2449

W
Waleed Abdulla 已提交
2450 2451 2452 2453 2454 2455
        # Extract boxes, class_ids, scores, and class-specific masks
        boxes = detections[:N, :4]
        class_ids = detections[:N, 4].astype(np.int32)
        scores = detections[:N, 5]
        masks = mrcnn_mask[np.arange(N), :, :, class_ids]

2456 2457 2458 2459 2460 2461 2462
        # Translate normalized coordinates in the resized image to pixel
        # coordinates in the original image before resizing
        window = utils.norm_boxes(window, image_shape[:2])
        wy1, wx1, wy2, wx2 = window
        shift = np.array([wy1, wx1, wy1, wx1])
        wh = wy2 - wy1  # window height
        ww = wx2 - wx1  # window width
2463
        scale = np.array([wh, ww, wh, ww])
2464 2465 2466 2467 2468 2469 2470
        # Convert boxes to normalized coordinates on the window
        boxes = np.divide(boxes - shift, scale)
        # Convert boxes to pixel coordinates on the original image
        boxes = utils.denorm_boxes(boxes, original_image_shape[:2])

        # Filter out detections with zero area. Happens in early training when
        # network weights are still random
2471 2472 2473 2474 2475 2476 2477 2478 2479
        exclude_ix = np.where(
            (boxes[:, 2] - boxes[:, 0]) * (boxes[:, 3] - boxes[:, 1]) <= 0)[0]
        if exclude_ix.shape[0] > 0:
            boxes = np.delete(boxes, exclude_ix, axis=0)
            class_ids = np.delete(class_ids, exclude_ix, axis=0)
            scores = np.delete(scores, exclude_ix, axis=0)
            masks = np.delete(masks, exclude_ix, axis=0)
            N = class_ids.shape[0]

W
Waleed Abdulla 已提交
2480 2481 2482 2483
        # Resize masks to original image size and set boundary threshold.
        full_masks = []
        for i in range(N):
            # Convert neural network mask to full size mask
2484
            full_mask = utils.unmold_mask(masks[i], boxes[i], original_image_shape)
W
Waleed Abdulla 已提交
2485 2486
            full_masks.append(full_mask)
        full_masks = np.stack(full_masks, axis=-1)\
2487
            if full_masks else np.empty(original_image_shape[:2] + (0,))
G
Gyuri Im 已提交
2488

W
Waleed Abdulla 已提交
2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502
        return boxes, class_ids, scores, full_masks

    def detect(self, images, verbose=0):
        """Runs the detection pipeline.

        images: List of images, potentially of different sizes.

        Returns a list of dicts, one dict per image. The dict contains:
        rois: [N, (y1, x1, y2, x2)] detection bounding boxes
        class_ids: [N] int class IDs
        scores: [N] float probability scores for the class IDs
        masks: [H, W, N] instance binary masks
        """
        assert self.mode == "inference", "Create model in inference mode."
G
Gyuri Im 已提交
2503 2504
        assert len(
            images) == self.config.BATCH_SIZE, "len(images) must be equal to BATCH_SIZE"
W
Waleed Abdulla 已提交
2505

G
Gyuri Im 已提交
2506
        if verbose:
W
Waleed Abdulla 已提交
2507 2508 2509
            log("Processing {} images".format(len(images)))
            for image in images:
                log("image", image)
2510

2511 2512 2513
        # Mold inputs to format expected by the neural network
        molded_images, image_metas, windows = self.mold_inputs(images)

2514
        # Validate image sizes
2515 2516 2517 2518 2519
        # All images in a batch MUST be of the same size
        image_shape = molded_images[0].shape
        for g in molded_images[1:]:
            assert g.shape == image_shape,\
                "After resizing, all images must have the same size. Check IMAGE_RESIZE_MODE and image sizes."
2520 2521 2522 2523 2524 2525 2526

        # Anchors
        anchors = self.get_anchors(image_shape)
        # Duplicate across the batch dimension because Keras requires it
        # TODO: can this be optimized to avoid duplicating the anchors?
        anchors = np.broadcast_to(anchors, (self.config.BATCH_SIZE,) + anchors.shape)

W
Waleed Abdulla 已提交
2527 2528 2529
        if verbose:
            log("molded_images", molded_images)
            log("image_metas", image_metas)
2530
            log("anchors", anchors)
W
Waleed Abdulla 已提交
2531
        # Run object detection
2532 2533
        detections, _, _, mrcnn_mask, _, _, _ =\
            self.keras_model.predict([molded_images, image_metas, anchors], verbose=0)
W
Waleed Abdulla 已提交
2534 2535 2536 2537 2538
        # Process detections
        results = []
        for i, image in enumerate(images):
            final_rois, final_class_ids, final_scores, final_masks =\
                self.unmold_detections(detections[i], mrcnn_mask[i],
2539 2540
                                       image.shape, molded_images[i].shape,
                                       windows[i])
W
Waleed Abdulla 已提交
2541 2542 2543 2544 2545 2546 2547 2548
            results.append({
                "rois": final_rois,
                "class_ids": final_class_ids,
                "scores": final_scores,
                "masks": final_masks,
            })
        return results

2549 2550 2551 2552 2553 2554
    def detect_molded(self, molded_images, image_metas, verbose=0):
        """Runs the detection pipeline, but expect inputs that are
        molded already. Used mostly for debugging and inspecting
        the model.

        molded_images: List of images loaded using load_image_gt()
C
Corey Hu 已提交
2555
        image_metas: image meta data, also returned by load_image_gt()
2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606

        Returns a list of dicts, one dict per image. The dict contains:
        rois: [N, (y1, x1, y2, x2)] detection bounding boxes
        class_ids: [N] int class IDs
        scores: [N] float probability scores for the class IDs
        masks: [H, W, N] instance binary masks
        """
        assert self.mode == "inference", "Create model in inference mode."
        assert len(molded_images) == self.config.BATCH_SIZE,\
            "Number of images must be equal to BATCH_SIZE"

        if verbose:
            log("Processing {} images".format(len(molded_images)))
            for image in molded_images:
                log("image", image)

        # Validate image sizes
        # All images in a batch MUST be of the same size
        image_shape = molded_images[0].shape
        for g in molded_images[1:]:
            assert g.shape == image_shape, "Images must have the same size"

        # Anchors
        anchors = self.get_anchors(image_shape)
        # Duplicate across the batch dimension because Keras requires it
        # TODO: can this be optimized to avoid duplicating the anchors?
        anchors = np.broadcast_to(anchors, (self.config.BATCH_SIZE,) + anchors.shape)

        if verbose:
            log("molded_images", molded_images)
            log("image_metas", image_metas)
            log("anchors", anchors)
        # Run object detection
        detections, _, _, mrcnn_mask, _, _, _ =\
            self.keras_model.predict([molded_images, image_metas, anchors], verbose=0)
        # Process detections
        results = []
        for i, image in enumerate(molded_images):
            window = [0, 0, image.shape[0], image.shape[1]]
            final_rois, final_class_ids, final_scores, final_masks =\
                self.unmold_detections(detections[i], mrcnn_mask[i],
                                       image.shape, molded_images[i].shape,
                                       window)
            results.append({
                "rois": final_rois,
                "class_ids": final_class_ids,
                "scores": final_scores,
                "masks": final_masks,
            })
        return results

2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628
    def get_anchors(self, image_shape):
        """Returns anchor pyramid for the given image size."""
        backbone_shapes = compute_backbone_shapes(self.config, image_shape)
        # Cache anchors and reuse if image shape is the same
        if not hasattr(self, "_anchor_cache"):
            self._anchor_cache = {}
        if not tuple(image_shape) in self._anchor_cache:
            # Generate Anchors
            a = utils.generate_pyramid_anchors(
                self.config.RPN_ANCHOR_SCALES,
                self.config.RPN_ANCHOR_RATIOS,
                backbone_shapes,
                self.config.BACKBONE_STRIDES,
                self.config.RPN_ANCHOR_STRIDE)
            # Keep a copy of the latest anchors in pixel coordinates because
            # it's used in inspect_model notebooks.
            # TODO: Remove this after the notebook are refactored to not use it
            self.anchors = a
            # Normalize coordinates
            self._anchor_cache[tuple(image_shape)] = utils.norm_boxes(a, image_shape[:2])
        return self._anchor_cache[tuple(image_shape)]

W
Waleed Abdulla 已提交
2629 2630 2631 2632
    def ancestor(self, tensor, name, checked=None):
        """Finds the ancestor of a TF tensor in the computation graph.
        tensor: TensorFlow symbolic tensor.
        name: Name of ancestor tensor to find
G
Gyuri Im 已提交
2633
        checked: For internal use. A list of tensors that were already
W
Waleed Abdulla 已提交
2634 2635 2636 2637 2638 2639 2640 2641 2642 2643
                 searched to avoid loops in traversing the graph.
        """
        checked = checked if checked is not None else []
        # Put a limit on how deep we go to avoid very long loops
        if len(checked) > 500:
            return None
        # Convert name to a regex and allow matching a number prefix
        # because Keras adds them automatically
        if isinstance(name, str):
            name = re.compile(name.replace("/", r"(\_\d+)*/"))
G
Gyuri Im 已提交
2644

W
Waleed Abdulla 已提交
2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676
        parents = tensor.op.inputs
        for p in parents:
            if p in checked:
                continue
            if bool(re.fullmatch(name, p.name)):
                return p
            checked.append(p)
            a = self.ancestor(p, name, checked)
            if a is not None:
                return a
        return None

    def find_trainable_layer(self, layer):
        """If a layer is encapsulated by another layer, this function
        digs through the encapsulation and returns the layer that holds
        the weights.
        """
        if layer.__class__.__name__ == 'TimeDistributed':
            return self.find_trainable_layer(layer.layer)
        return layer

    def get_trainable_layers(self):
        """Returns a list of layers that have weights."""
        layers = []
        # Loop through all layers
        for l in self.keras_model.layers:
            # If layer is a wrapper, find inner trainable layer
            l = self.find_trainable_layer(l)
            # Include layer if it has weights
            if l.get_weights():
                layers.append(l)
        return layers
G
Gyuri Im 已提交
2677

2678
    def run_graph(self, images, outputs, image_metas=None):
W
Waleed Abdulla 已提交
2679 2680 2681
        """Runs a sub-set of the computation graph that computes the given
        outputs.

2682
        image_metas: If provided, the images are assumed to be already
C
Corey Hu 已提交
2683
            molded (i.e. resized, padded, and normalized)
2684

G
Gyuri Im 已提交
2685
        outputs: List of tuples (name, tensor) to compute. The tensors are
W
Waleed Abdulla 已提交
2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703
            symbolic TensorFlow tensors and the names are for easy tracking.

        Returns an ordered dict of results. Keys are the names received in the
        input and values are Numpy arrays.
        """
        model = self.keras_model

        # Organize desired outputs into an ordered dict
        outputs = OrderedDict(outputs)
        for o in outputs.values():
            assert o is not None

        # Build a Keras function to run parts of the computation graph
        inputs = model.inputs
        if model.uses_learning_phase and not isinstance(K.learning_phase(), int):
            inputs += [K.learning_phase()]
        kf = K.function(model.inputs, list(outputs.values()))

2704
        # Prepare inputs
2705 2706 2707 2708
        if image_metas is None:
            molded_images, image_metas, _ = self.mold_inputs(images)
        else:
            molded_images = images
2709 2710 2711 2712 2713 2714 2715
        image_shape = molded_images[0].shape
        # Anchors
        anchors = self.get_anchors(image_shape)
        # Duplicate across the batch dimension because Keras requires it
        # TODO: can this be optimized to avoid duplicating the anchors?
        anchors = np.broadcast_to(anchors, (self.config.BATCH_SIZE,) + anchors.shape)
        model_in = [molded_images, image_metas, anchors]
W
Waleed Abdulla 已提交
2716

2717
        # Run inference
W
Waleed Abdulla 已提交
2718 2719 2720 2721 2722
        if model.uses_learning_phase and not isinstance(K.learning_phase(), int):
            model_in.append(0.)
        outputs_np = kf(model_in)

        # Pack the generated Numpy arrays into a a dict and log the results.
G
Gyuri Im 已提交
2723 2724
        outputs_np = OrderedDict([(k, v)
                                  for k, v in zip(outputs.keys(), outputs_np)])
W
Waleed Abdulla 已提交
2725 2726 2727 2728 2729 2730 2731 2732 2733
        for k, v in outputs_np.items():
            log(k, v)
        return outputs_np


############################################################
#  Data Formatting
############################################################

2734 2735
def compose_image_meta(image_id, original_image_shape, image_shape,
                       window, scale, active_class_ids):
2736
    """Takes attributes of an image and puts them in one 1D array.
G
Gyuri Im 已提交
2737

W
Waleed Abdulla 已提交
2738
    image_id: An int ID of the image. Useful for debugging.
2739 2740
    original_image_shape: [H, W, C] before resizing or padding.
    image_shape: [H, W, C] after resizing and padding
W
Waleed Abdulla 已提交
2741 2742
    window: (y1, x1, y2, x2) in pixels. The area of the image where the real
            image is (excluding the padding)
2743
    scale: The scaling factor applied to the original image (float32)
W
Waleed Abdulla 已提交
2744 2745 2746 2747 2748
    active_class_ids: List of class_ids available in the dataset from which
        the image came. Useful if training on images from multiple datasets
        where not all classes are present in all datasets.
    """
    meta = np.array(
2749 2750 2751 2752 2753 2754
        [image_id] +                  # size=1
        list(original_image_shape) +  # size=3
        list(image_shape) +           # size=3
        list(window) +                # size=4 (y1, x1, y2, x2) in image cooredinates
        [scale] +                     # size=1
        list(active_class_ids)        # size=num_classes
W
Waleed Abdulla 已提交
2755 2756 2757
    )
    return meta

2758

2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782
def parse_image_meta(meta):
    """Parses an array that contains image attributes to its components.
    See compose_image_meta() for more details.

    meta: [batch, meta length] where meta length depends on NUM_CLASSES

    Returns a dict of the parsed values.
    """
    image_id = meta[:, 0]
    original_image_shape = meta[:, 1:4]
    image_shape = meta[:, 4:7]
    window = meta[:, 7:11]  # (y1, x1, y2, x2) window of image in in pixels
    scale = meta[:, 11]
    active_class_ids = meta[:, 12:]
    return {
        "image_id": image_id.astype(np.int32),
        "original_image_shape": original_image_shape.astype(np.int32),
        "image_shape": image_shape.astype(np.int32),
        "window": window.astype(np.int32),
        "scale": scale.astype(np.float32),
        "active_class_ids": active_class_ids.astype(np.int32),
    }


S
Shenoy 已提交
2783 2784
def parse_image_meta_graph(meta):
    """Parses a tensor that contains image attributes to its components.
W
Waleed Abdulla 已提交
2785
    See compose_image_meta() for more details.
S
Shenoy 已提交
2786 2787

    meta: [batch, meta length] where meta length depends on NUM_CLASSES
2788 2789

    Returns a dict of the parsed tensors.
W
Waleed Abdulla 已提交
2790 2791
    """
    image_id = meta[:, 0]
2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804
    original_image_shape = meta[:, 1:4]
    image_shape = meta[:, 4:7]
    window = meta[:, 7:11]  # (y1, x1, y2, x2) window of image in in pixels
    scale = meta[:, 11]
    active_class_ids = meta[:, 12:]
    return {
        "image_id": image_id,
        "original_image_shape": original_image_shape,
        "image_shape": image_shape,
        "window": window,
        "scale": scale,
        "active_class_ids": active_class_ids,
    }
W
Waleed Abdulla 已提交
2805

2806

W
Waleed Abdulla 已提交
2807
def mold_image(images, config):
C
Corey Hu 已提交
2808
    """Expects an RGB image (or array of images) and subtracts
W
Waleed Abdulla 已提交
2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823
    the mean pixel and converts it to float. Expects image
    colors in RGB order.
    """
    return images.astype(np.float32) - config.MEAN_PIXEL


def unmold_image(normalized_images, config):
    """Takes a image normalized with mold() and returns the original."""
    return (normalized_images + config.MEAN_PIXEL).astype(np.uint8)


############################################################
#  Miscellenous Graph Functions
############################################################

W
Waleed Abdulla 已提交
2824
def trim_zeros_graph(boxes, name=None):
C
Corey Hu 已提交
2825
    """Often boxes are represented with matrices of shape [N, 4] and
W
Waleed Abdulla 已提交
2826 2827 2828
    are padded with zeros. This removes zero boxes.

    boxes: [N, 4] matrix of boxes.
W
Waleed Abdulla 已提交
2829
    non_zeros: [N] a 1D boolean mask identifying the rows to keep
W
Waleed Abdulla 已提交
2830
    """
W
Waleed Abdulla 已提交
2831 2832 2833
    non_zeros = tf.cast(tf.reduce_sum(tf.abs(boxes), axis=1), tf.bool)
    boxes = tf.boolean_mask(boxes, non_zeros, name=name)
    return boxes, non_zeros
W
Waleed Abdulla 已提交
2834 2835 2836 2837 2838 2839 2840 2841 2842 2843


def batch_pack_graph(x, counts, num_rows):
    """Picks different number of values from each row
    in x depending on the values in counts.
    """
    outputs = []
    for i in range(num_rows):
        outputs.append(x[i, :counts[i]])
    return tf.concat(outputs, axis=0)
2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877


def norm_boxes_graph(boxes, shape):
    """Converts boxes from pixel coordinates to normalized coordinates.
    boxes: [..., (y1, x1, y2, x2)] in pixel coordinates
    shape: [..., (height, width)] in pixels

    Note: In pixel coordinates (y2, x2) is outside the box. But in normalized
    coordinates it's inside the box.

    Returns:
        [..., (y1, x1, y2, x2)] in normalized coordinates
    """
    h, w = tf.split(tf.cast(shape, tf.float32), 2)
    scale = tf.concat([h, w, h, w], axis=-1) - tf.constant(1.0)
    shift = tf.constant([0., 0., 1., 1.])
    return tf.divide(boxes - shift, scale)


def denorm_boxes_graph(boxes, shape):
    """Converts boxes from normalized coordinates to pixel coordinates.
    boxes: [..., (y1, x1, y2, x2)] in normalized coordinates
    shape: [..., (height, width)] in pixels

    Note: In pixel coordinates (y2, x2) is outside the box. But in normalized
    coordinates it's inside the box.

    Returns:
        [..., (y1, x1, y2, x2)] in pixel coordinates
    """
    h, w = tf.split(tf.cast(shape, tf.float32), 2)
    scale = tf.concat([h, w, h, w], axis=-1) - tf.constant(1.0)
    shift = tf.constant([0., 0., 1., 1.])
    return tf.cast(tf.round(tf.multiply(boxes, scale) + shift), tf.int32)