Siamese networks are commonly used in image comparison applications such as face or signature verification. In a typical Siamese network a large part of the network is duplicated at the base to allow multiple inputs to go through identical layers. This example follows the Caffe Siamese Tutorial and shows how to use DIGITS to teach a neural network to map an image from the MNIST dataset to a 2D point, while trying to minimize the distance between points of the same class and maximize the distance between points of different classes.
In our dataset, each input sample is a pair of images and the associated label is set to 1 when both images are from the same class (i.e. both images represent the same digit) and 0 when images are from different classes.
Since DIGITS expects input data to be images, we will create one RGB image for each pair of (grayscale) images in the MNIST dataset:
- the Blue channel will contain the first image in the pair
- the Green channel will contain the second image in the pair
- the Red channel will be unused and set to 0.
If you followed the introductory walkthrough on GettingStarted, you should have the MNIST dataset created in DIGITS already and DIGITS will have conveniently created a list of MNIST image paths and stored it in a file called train.txt.
Click on your MNIST image classification model to display dataset information: this will allow you to find the path to the job directory which includes the train.txt file:
In this example the path is /fast-scratch/gheinrich/ws/digits/digits/jobs/20151111-210842-a4ec.
Non-classification datasets may be created in DIGITS through the "other" type of datasets. For these datasets, DIGITS expects the user to provide a set of LMDB databases. Note that since labels may be vectors (or matrices), it is not possible to use a single LMDB database to hold the image and its label. Therefore DIGITS expects one LMDB database for the images and a separate LMDB database for the labels.
The first step in creating the dataset is to create the LMDB databases. In this example you will use the Python test script located in /examples/siamese/create_db.py.
To create a train database of 100000 pairs of images into a folder called siamesedb:
$ cd $DIGITS_ROOT/examples/siamese
$ create_db.py siamesedb ../../digits/jobs/20151111-210842-a4ec/train.txt -c 100000The script also creates a validation database of 1000 samples. Overall, the script creates:
- train image and label databases,
- validation image and label databases,
- train and validation mean images,
- two sets of 10 test images: one set includes images that are taken from the same class, the other set includes images that are taken from different classes
NOTE:
create_db.pydoes not resize images. All images must have the same size.
Now that we have created the required files, we may create the dataset using DIGITS. On the main page, click New Dataset > Images > Other:
In the generic dataset creation form you need to provide the paths to:
- the train image database
- the train label database
- the validation image database
- the validation label database
- the train mean image
train_mean.binaryprotofile
Now that you have a regression dataset to train on, you may create a Siamese model by clicking on New Model > Images > Other on the main page:
On the model creation form, select the dataset you just created.
Under the Custom Network tab, select Caffe. There you can paste this network definition then give your model a name and click Create.
Click on the Visualize button to see a graphical depiction of the network architecture:
In this model the data layer is sliced into three separate branches, one per channel. The red channel is discarded through a SilenceLayer.
Each of the blue and green channels are going through identical copies of a LeNet model. Weights are named the same, in order to keep them equal.
At the top of the network a ContrastiveLoss layer is used. This will cause the network to try and push together images of the same class and
pull apart images from different classes. The L2 distance between extracted features is used to measure the distance between images.
Under the Custom Network tab, select Torch. There you can paste this network definition then give your model a name and click Create.
In this model an nn.Narrow layer is used to drop the red channel. An nn.Parallel layer is used to make the green and blue channels go through identical copies of LeNet, with shared weights.
Finally, the nn.CosineEmbeddingCriterion criterion is used. Similar to Caffe's ContrastiveLoss, this will cause the network to try and push together images of the same class and
pull apart images from different classes. However, since the Cosine distance is used, the model will learn to minimize the angle between features that are extracted from images of the same class
and conversely will maximize the angle between features extracted from images from different classes. See below for a visual illustration of the impact this difference has on extracted features.
Under the Custom Network tab, select Tensorflow. There you can paste this network definition then give your model a name and click Create.
After training the Caffe model for 30 epochs the loss function should look similar to this:
Now we can assess the quality of the model. To this avail, we can use the test images that were generated by create_db.py.
At the bottom of the model page, in the Upload Image field, select for example image val_test_different_class_0.png. Don't forget to click on Show visualizations and statistics.
Note how the image looks like two overlapping digits (a 5 and a 6 in this case). Here the left image is mapped to point [-0.31048527 0.26351458] and the right image is mapped to point [ 1.33714581 -0.3224836 ]. The L2 distance between these points is 1.74 i.e. greater than 1.
Note also how the network is extracting each individual image from the channels of the original images:
Now run the same test using image val_test_same_class_0.png. In this case this maps two different representations of
a 2 to [-0.23325665 -1.02958131] and [-0.13545063 -1.07779765], with an L2 distance of 0.109 i.e. much smaller than 1.
In this case the training objective is met: images from the same class are very close to each other in 2D space, while the distance between images of different classes is greater than 1.
Similar results are obtained from the Torch model however the angle between feature vectors is used instead of the L2 distance.
You can also provide DIGITS with any grayscale image from the MNIST dataset and DIGITS will convert it to an RGB image. In that case
the left and right components of the Siamese network will be activated in the same way and will produce the same feature vectors. You
can also use DIGITS /models/images/generic/infer_many.json route to compute the feature vectors of all the images in the MNIST
dataset in one command line:
curl localhost:5000/models/images/generic/infer_many.json -XPOST -F job_id=20151203-082705-7ad6 -F image_list=@../../digits/jobs/20151111-210842-a4ec/train.txt > predictions.txt
The above command dumps all predictions into a large file that can be parsed to display clusters of image classes as in the below figure:
In the above figure we can see how the model has learnt to separate classes into ten clusters. Since the L2 distance is used to
measure the distance between features, centroids tend to look like round point clouds and clusters are arranged in a circular way.
In the above figure we can see the ten separate clusters. However since the cosine distance is used, centroids tend to look like
elongated ellipses, starting from the origin of the axes. Clusters are evenly spaced by an angle. You might note from the
model that we have used a margin of cos(2pi/10)~=0.8 as we found that this margin helped learn an optimal representation of features
where each of the ten clusters is located at an angle of 2pi/10 from its neighbour.
For extra credit, can you guess what clusters would look like if the L1 distance was used?