# Deep painterly harmonization¶

This notebook is an implementation of the article Deep Painterly Harmonization. It runs on top of the fastai library although it doesn't use many features from it apart to load the images and normalize them in the way the model (VGG16) expects it, so it's easy to convert it in full pytorch.

The authors of the article provided their code (in torch) here and I've used it to get an idea on how they implemented certain parameters that aren't very well explained in the paper. There are also a few instances where the code and the article directly contradict each other. In those cases, I've followed the code, but I'll put some warnings so you know what I'm talking about.

Lastly, there is one feature described in the second stage of their algorithm that I haven't understood, and when I tried to replicate the corresponding code, it gave awful results. Since I got the same kind of final results as the ones they showed, I decided to ignore it. Again, I'll explain what it is when we get there.

In [1]:
%matplotlib inline

In [2]:
from fastai.conv_learner import *


You can download the data they used for their article here. Be sure to make the PATH variable point to it.

In [3]:
PATH = Path('../data/paintings')


We will focus on example 4 for this notebook. Each example has four pictures associated to it: the input (our objet superposed on the painting), the style image (which is the painting), the mask that allows us to know where we added the object and a dilated version of it.

In [4]:
idx = 16
input_img = open_image(PATH/f'{idx}_naive.jpg')
style_img = open_image(PATH/f'{idx}_target.jpg')


Let's draw this.

In [5]:
fig, axs = plt.subplots(1,3,figsize = (12,6))
axs[0].axis('off')
axs[1].imshow(input_img)
axs[1].axis('off')
axs[2].imshow(style_img)
axs[2].axis('off')

Out[5]:
(-0.5, 699.5, 556.5, -0.5)

The loose mask is just a bit wider as the regular mask.

In [6]:
fig, axs = plt.subplots(1,2,figsize = (12,6))
axs[0].axis('off')
axs[1].axis('off')

Out[6]:
(-0.5, 699.5, 556.5, -0.5)

The authors of the article proved the function they used to dilate a given mask. If you want to run your own examples, here it is. The gaussian blur will smoothly enlarge it, and then we only keep the pixel values greater than 0.1.

In [7]:
def dilate_mask(mask):


Let's check it works properly here.

In [8]:
loose_mask1 = dilate_mask(mask)

In [9]:
fig, axs = plt.subplots(1,2,figsize = (12,6))
axs[0].axis('off')
axs[1].axis('off')

Out[9]:
(-0.5, 699.5, 556.5, -0.5)

They look the same indeed! Lastly we create a slightly enlarged version of our tight mask that we will use in the end to reconstruct the output.

In [10]:
mask_smth = cv2.GaussianBlur(mask, (3,3) , 1)


We get the transforms from the vgg model, to have the right parameters for Normalization (since I'm lazy).

In [11]:
trn_tfms, val_tfms = tfms_from_model(vgg16, 500, crop_type=CropType.NO)


This bit removes the resize transform since we want to keep the image at their specific size.

In [12]:
val_tfms.tfms = val_tfms.tfms[2:]

In [13]:
val_tfms

Out[13]:
[<fastai.transforms.Normalize object at 0x7ff8acffafd0>, <fastai.transforms.ChannelOrder object at 0x7ff8ad0c2e10>]

If you don't have a lot of RAM on your GPU, you may want to uncomment this to halves the dimensions of the images. Result won't be as nice, but you'll get the idea.

In [14]:
#def halve_size(mask):
#    h,w = mask.shape[:2]
#    return cv2.resize(mask, (w//2,h//2))
#input_img = halve_size(input_img)
#style_img = halve_size(style_img)


Then we can get our pictures ready for the model.

In [15]:
input_tfm = val_tfms(input_img)
style_tfm = val_tfms(style_img)


# Model¶

The authors of the article used VGG19 but I didn't see any difference by using VGG16 (the version with BatchNorm), so since it's lighter and a bit faster, we'll use this one. You can switch back to VGG19 by replacing the 16 here, then be careful with layer numbers (I've provided the correct ones if you decide to change).

In the two steps of the algorithm, we will only use the results of the layer 36 max (42 in VGG19), so I've discarded the ones we don't use for memory purposes.

In [16]:
layers = cut_model(vgg16(True),37) #43 vor VGG19
m_vgg = to_gpu(nn.Sequential(*layers)).eval()
set_trainable(m_vgg, False)

In [17]:
m_vgg = to_gpu(vgg16(True)).eval()
set_trainable(m_vgg, False)


We will use the results of conv1_1, conv2_1, conv3_1, conv4_1 and conv5_1 during the two steps of the process. It corresponds to the result of the first ReLU we can see at the beginning (for conv1) and after each MaxPool (for the others) so the indexes are 2, 9, 16, 26 and 36 (2, 9, 16, 29 and 42 for VGG19).

In [18]:
m_vgg

Out[18]:
Sequential(
(0): Conv2d(3, 64, kernel_size=(3, 3), stride=(1, 1), padding=(1, 1))
(1): BatchNorm2d(64, eps=1e-05, momentum=0.1, affine=True)
(2): ReLU(inplace)
(3): Conv2d(64, 64, kernel_size=(3, 3), stride=(1, 1), padding=(1, 1))
(4): BatchNorm2d(64, eps=1e-05, momentum=0.1, affine=True)
(5): ReLU(inplace)
(6): MaxPool2d(kernel_size=(2, 2), stride=(2, 2), dilation=(1, 1), ceil_mode=False)
(7): Conv2d(64, 128, kernel_size=(3, 3), stride=(1, 1), padding=(1, 1))
(8): BatchNorm2d(128, eps=1e-05, momentum=0.1, affine=True)
(9): ReLU(inplace)
(10): Conv2d(128, 128, kernel_size=(3, 3), stride=(1, 1), padding=(1, 1))
(11): BatchNorm2d(128, eps=1e-05, momentum=0.1, affine=True)
(12): ReLU(inplace)
(13): MaxPool2d(kernel_size=(2, 2), stride=(2, 2), dilation=(1, 1), ceil_mode=False)
(14): Conv2d(128, 256, kernel_size=(3, 3), stride=(1, 1), padding=(1, 1))
(15): BatchNorm2d(256, eps=1e-05, momentum=0.1, affine=True)
(16): ReLU(inplace)
(17): Conv2d(256, 256, kernel_size=(3, 3), stride=(1, 1), padding=(1, 1))
(18): BatchNorm2d(256, eps=1e-05, momentum=0.1, affine=True)
(19): ReLU(inplace)
(20): Conv2d(256, 256, kernel_size=(3, 3), stride=(1, 1), padding=(1, 1))
(21): BatchNorm2d(256, eps=1e-05, momentum=0.1, affine=True)
(22): ReLU(inplace)
(23): MaxPool2d(kernel_size=(2, 2), stride=(2, 2), dilation=(1, 1), ceil_mode=False)
(24): Conv2d(256, 512, kernel_size=(3, 3), stride=(1, 1), padding=(1, 1))
(25): BatchNorm2d(512, eps=1e-05, momentum=0.1, affine=True)
(26): ReLU(inplace)
(27): Conv2d(512, 512, kernel_size=(3, 3), stride=(1, 1), padding=(1, 1))
(28): BatchNorm2d(512, eps=1e-05, momentum=0.1, affine=True)
(29): ReLU(inplace)
(30): Conv2d(512, 512, kernel_size=(3, 3), stride=(1, 1), padding=(1, 1))
(31): BatchNorm2d(512, eps=1e-05, momentum=0.1, affine=True)
(32): ReLU(inplace)
(33): MaxPool2d(kernel_size=(2, 2), stride=(2, 2), dilation=(1, 1), ceil_mode=False)
(34): Conv2d(512, 512, kernel_size=(3, 3), stride=(1, 1), padding=(1, 1))
(35): BatchNorm2d(512, eps=1e-05, momentum=0.1, affine=True)
(36): ReLU(inplace)
(37): Conv2d(512, 512, kernel_size=(3, 3), stride=(1, 1), padding=(1, 1))
(38): BatchNorm2d(512, eps=1e-05, momentum=0.1, affine=True)
(39): ReLU(inplace)
(40): Conv2d(512, 512, kernel_size=(3, 3), stride=(1, 1), padding=(1, 1))
(41): BatchNorm2d(512, eps=1e-05, momentum=0.1, affine=True)
(42): ReLU(inplace)
(43): MaxPool2d(kernel_size=(2, 2), stride=(2, 2), dilation=(1, 1), ceil_mode=False)
)

# First pass¶

The first pass only uses conv3_1, conv4_1 and conv5_1.

In [19]:
idx_layers = [16,26,36] #[16, 29, 42] for VGG19


Let's hook those specific layers so that when we get one thing through the model, it saves their results.

In [20]:
class SaveFeatures(nn.Module):
features = None
def __init__(self, m): self.hook = m.register_forward_hook(self.hook_fn)
def hook_fn(self, module, input, output): self.features = output
def close(self): self.hook.remove()

In [21]:
sfs = [SaveFeatures(children(m_vgg)[idx]) for idx in idx_layers]


Now we can grab the features for our image input and our style image. The [None] is to had a batch dimension and the VV command is short for Variable without require_grad, so that pytorch is happy.

In [22]:
m_vgg(VV(input_tfm[None]))
input_ftrs = [s.features for s in sfs]
[sf.shape for sf in input_ftrs]

Out[22]:
[torch.Size([1, 256, 139, 175]),
torch.Size([1, 512, 69, 87]),
torch.Size([1, 512, 34, 43])]
In [23]:
m_vgg(VV(style_tfm[None]))
style_ftrs = [s.features for s in sfs]
[sf.shape for sf in style_ftrs]

Out[23]:
[torch.Size([1, 256, 139, 175]),
torch.Size([1, 512, 69, 87]),
torch.Size([1, 512, 34, 43])]

The next thing we need is to make a pass with our mask to have its corresponding features. The authors say in the article they resize it, but in the code, they half its dimension at each max pooling, then pass it through a 3 by 3 stride 1 padding 1 average pooling at each convolutional layer, so let's do that.

In [24]:
def halve_size(mask):

In [25]:
ConvolMask = nn.AvgPool2d(3, 1, 1)
for i in range(nb): x = ConvolMask(x)

In [26]:
def get_mask_ftrs(mask):
ftrs = []
return ftrs

In [27]:
mask_ftrs = get_mask_ftrs(loose_mask[:,:,0])
[mf.shape for mf in mask_ftrs]

Out[27]:
[(139, 175), (69, 87), (34, 43)]

Note that the shapes of our input features, style features, mask features are all the same for each layer.

## Mapping¶

The first pass is based on a content loss and a style loss as is usual in style transfer, but first, we have to map every pixel of the content features to one in the style features. To determine the mapping, we look at every 3 by 3 window of the style features, that we flatten into a vector of size 9 * channels. We will then map a pixel in the content to the one in the style that is at the center of the patch nearest to the 3 by 3 patch around the pixel.

To do this fast, we use this function to get all the possible patches in a big array that we'll throw on the CPU. This program is very much like the one I used to code a convolutional layer from scratch in numpy in this blog post.

Basically we had a padding of zeros (to have a 3 by 3 window everywhere), the start indexes correspond to all the top-left corners of the windows, and the grid gives the indexes of all the 3 by 3 by channel window.

In [28]:
def get_patches(x,ks=3,stride=1,padding=1):
ch, n1, n2 = x.shape
start_idx = np.array([j + (n2+2*padding)*i for i in range(0,n1-ks+1+2*padding,stride) for j in range(0,n2-ks+1+2*padding,stride) ])
grid = np.array([j + (n2+2*padding)*i + (n1+2*padding) * (n2+2*padding) * k for k in range(0,ch) for i in range(ks) for j in range(ks)])
to_take = start_idx[:,None] + grid[None,:]
return y.take(to_take)


Then we can compute all the cosine similarities very easily and get the mapping. VV puts all on the GPU if there's one available so that this goes fast.

In [29]:
def match_ftrs(inp_ftrs,sty_ftrs):
res = []
for l_inp,s_inp in zip(inp_ftrs,sty_ftrs):
l_inp = VV(get_patches(to_np(l_inp[0].data)))
s_inp = VV(get_patches(to_np(s_inp[0].data)))
scals = torch.mm(l_inp,s_inp.t())
norms_in = torch.sqrt((l_inp ** 2).sum(1))
norms_st = torch.sqrt((s_inp ** 2).sum(1))
cosine_sim = scals / (1e-15 + norms_in.unsqueeze(1) * norms_st.unsqueeze(0))
_, idx_max = cosine_sim.max(1)
res.append(to_np(idx_max))
return res

In [30]:
map_ftrs = match_ftrs(input_ftrs, style_ftrs)


Then we use this map to transform the style features.

In [31]:
def map_style():
res = []
for sf, mapf in zip(style_ftrs, map_ftrs):
sf = to_np(sf).reshape(sf.size(1),-1)
sf = sf[:,mapf]
res.append(VV(sf))
return res

In [32]:
sty_ftrs = map_style()


# Reconstruction¶

At first, our input is the content picture.

In [33]:
opt_img = input_tfm.copy()
plt.imshow(val_tfms.denorm(to_np(opt_img).transpose(1,2,0)));


We put it in a variable that will require grad.

In [34]:
opt_img_v = V(opt_img[None], requires_grad=True)
opt_img_v.shape

Out[34]:
torch.Size([1, 3, 557, 700])

This is the generic optimizer and the step function for the training.

In [35]:
max_iter = 1000
show_iter = 100
optimizer = optim.LBFGS([opt_img_v], lr=1)

In [36]:
def step(loss_fn):
global n_iter
loss = loss_fn(opt_img_v)
loss.backward()
n_iter += 1
if n_iter%show_iter==0: print(f'Iteration: {n_iter}, loss: {loss.data[0]}')
return loss


Our content loss is just the MSE loss of the content and input features from the 4th convolutional layers (stored at index 1). We apply the corresponding mask to both of them before taking this loss.

Note that in the MSE loss, instead of dividing by the number of activations times the number of channels, we use the number of selected activations (inside the mask) times the number of channels

In [37]:
def content_loss(out_ftrs):
return F.mse_loss(msk_of,msk_if, size_average=False) / float(out_ftrs.size(1) * mask_ftrs[1].sum())


For the syle loss, we compute the gram matrix and the MSE loss of two gram matrices.

In [38]:
def gram(input):
x = input

def gram_mse_loss(input, target): return F.mse_loss(gram(input), gram(target))


Then we apply the mask before taking this loss, for all the layers (conv 3, 4 and 5), with the input features and the remapped style features.

In [39]:
def style_loss(out_ftrs):
loss = 0
for of, sf, mf in zip(out_ftrs, sty_ftrs, mask_ftrs):
to_pass = of * V(mf[None,None], requires_grad=False)
to_pass = to_pass.view(to_pass.size(1),-1)
sf = sf * V(mf, requires_grad=False).view(1,-1)
loss += gram_mse_loss(to_pass,sf)
return loss / 3


Thos are the weights for stage 1.

In [40]:
w_c, w_s = 1, 10

In [41]:
def stage1_loss(opt_img_v):
m_vgg(opt_img_v)
out_ftrs = [o.features for o in sfs]
c_loss = content_loss(out_ftrs[1])
s_loss = style_loss(out_ftrs)
return w_c * c_loss + w_s * s_loss


Let's launch the training.

In [42]:
n_iter=0
while n_iter <= max_iter: optimizer.step(partial(step,stage1_loss))

Iteration: 100, loss: 1.071435570716858
Iteration: 200, loss: 0.6738872528076172
Iteration: 300, loss: 0.5438193082809448
Iteration: 400, loss: 0.4766045808792114
Iteration: 500, loss: 0.4371315836906433
Iteration: 600, loss: 0.41064155101776123
Iteration: 700, loss: 0.39184218645095825
Iteration: 800, loss: 0.37797218561172485
Iteration: 900, loss: 0.36782580614089966
Iteration: 1000, loss: 0.35957789421081543


And here are the results.

In [43]:
fig, ax = plt.subplots(1,1, figsize=(10,10))
out_img = val_tfms.denorm(to_np(opt_img_v.data)[0].transpose(1,2,0))
out_img = out_img * mask_smth + style_img * (1-mask_smth)
out_img = out_img.clip(0, 1) #Pixel values shouldn't get below 0 or be greater than 1.
ax.imshow(out_img)
ax.axis('off')

Out[43]:
(-0.5, 699.5, 556.5, -0.5)