Added classes VignetteSet and CompressedVignetteSet to abstract the data-sets and...
[pysvrt.git] / README.md
1 # Introduction #
2
3 This is the port of the Synthetic Visual Reasoning Test to the pytorch
4 framework.
5
6 The main function is
7
8 ```
9 torch.ByteTensor svrt.generate_vignettes(int problem_number, torch.LongTensor labels)
10 ```
11
12 where
13
14  * `problem_number` indicates which of the 23 problem to use
15  * `labels` indicates the boolean labels of the vignettes to generate
16
17 The returned ByteTensor has three dimensions:
18
19  * Vignette index
20  * Pixel row
21  * Pixel col
22
23 # Installation and test #
24
25 Executing
26
27 ```
28 make -j -k
29 ./test-svrt.py
30 ```
31
32 should generate an image example.png in the current directory.
33
34 Note that the image generation does not take advantage of GPUs or
35 multi-core, and can be as fast as 10,000 vignettes per second and as
36 slow as 40 on a 4GHz i7-6700K.