Minor fixes + changed the default number of epochs to 100.

[pysvrt.git] / README.md

diff --git a/README.md b/README.md
index 44e9e1a..adae280 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ framework.
 The main function is
 
 ```
-torch.ByteTensor generate_vignettes(int problem_number, torch.LongTensor labels)
+torch.ByteTensor svrt.generate_vignettes(int problem_number, torch.LongTensor labels)
 ```
 
 where
@@ -22,8 +22,15 @@ The returned ByteTensor has three dimensions:
 
 # Installation and test #
 
+Executing
+
 ```
 make -j -k
-./built.py
 ./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.