X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=pysvrt.git;a=blobdiff_plain;f=README.md;fp=README.md;h=44e9e1af4cc11610119e7c22d58da49d64181d61;hp=0000000000000000000000000000000000000000;hb=b39a4f3da90f5af903a4d23e94e9b7823ed7d205;hpb=24368498f3065e8a4be34c5e8e2b68f9d1220f7d

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..44e9e1a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Introduction #
+
+This is the port of the Synthetic Visual Reasoning Test to the pytorch
+framework.
+
+The main function is
+
+```
+torch.ByteTensor generate_vignettes(int problem_number, torch.LongTensor labels)
+```
+
+where
+
+ * `problem_number` indicates which of the 23 problem to use
+ * `labels` indicates the boolean labels of the vignettes to generate
+
+The returned ByteTensor has three dimensions:
+
+ * Vignette index
+ * Pixel row
+ * Pixel col
+
+# Installation and test #
+
+```
+make -j -k
+./built.py
+./test-svrt.py
+```