X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=README.md;h=b6e29c72db385f3c19cfba8bb04080313af98f6c;hb=7966c9007cbcf9766b80781c927bf22fd20269af;hp=95e6206c186b77b49b055de64326fb2dea6ad4b3;hpb=96715f555094d276c72060ee9610bcda288d04fd;p=pysvrt.git

diff --git a/README.md b/README.md
index 95e6206..b6e29c7 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,44 @@
 # Introduction #
 
-This is the port of the Synthetic Visual Reasoning Test to the pytorch
-framework.
+This is a port of the Synthetic Visual Reasoning Test problems to the
+pytorch framework, with an implementation of two convolutional
+networks to solve them.
 
-The main function is
+# Installation and test #
+
+Executing
+
+```
+make -j -k
+./test-svrt.py
+```
+
+should generate an image example.png in the current directory.
+
+Note that the image generation does not take advantage of GPUs or
+multi-core, and can be as fast as 10,000 vignettes per second and as
+slow as 40 on a 4GHz i7-6700K.
+
+# Vignette generation and compression #
+
+## Vignette sets ##
+
+The svrtset.py implements the classes `VignetteSet` and
+`CompressedVignetteSet` with the following constructor
+
+```
+def __init__(self, problem_number, nb_samples, batch_size, cuda = False, logger = None):
+```
+
+and the following method to return one batch
+
+```
+def get_batch(self, b):
+```
+
+## Low-level functions ##
+
+The main function for genering vignettes is
 
 ```
 torch.ByteTensor svrt.generate_vignettes(int problem_number, torch.LongTensor labels)
@@ -20,17 +55,40 @@ The returned ByteTensor has three dimensions:
  * Pixel row
  * Pixel col
 
-# Installation and test #
+The two additional functions
 
-Executing
+```
+torch.ByteStorage svrt.compress(torch.ByteStorage x)
+```
+
+and
 
 ```
-make -j -k
-./test-svrt.py
+torch.ByteStorage svrt.uncompress(torch.ByteStorage x)
 ```
 
-should generate an image example.png in the current directory.
+provide a lossless compression scheme adapted to the ByteStorage of
+the vignette ByteTensor (i.e. expecting a lot of 255s, a few 0s, and
+no other value).
 
-Note that the image generation does not take advantage of GPUs or
-multi-core, and can be as fast as 3,000 vignettes per second and as
-slow as 40 on a 4GHz i7-6700K.
+This compression reduces the memory footprint by a factor ~50, and may
+be usefull to deal with very large data-sets and avoid re-generating
+images at every batch. It induces a little overhead for decompression,
+and moving from CPU to GPU memory.
+
+See vignette_set.py for a class CompressedVignetteSet using it.
+
+# Testing convolution networks #
+
+The file
+
+```
+cnn-svrt.py
+```
+
+provides the implementation of two deep networks, and use the
+compressed vignette code to allow the training with several millions
+vignettes on a PC with 16Gb and a GPU with 8Gb.
+
+The networks were designed by Afroze Baqapuri during an internship at
+Idiap.