X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=flatland.git;a=blobdiff_plain;f=README.md;h=d6e302caa8068552216f9a9c8b7bb894144b1552;hp=c1ff0a278434c5f5a2e28b0c42b77884e51c0d79;hb=HEAD;hpb=db40d75f91d5d332b475a260df8c034103159286

diff --git a/README.md b/README.md
index c1ff0a2..d6e302c 100644
--- a/README.md
+++ b/README.md
@@ -6,28 +6,29 @@ the pytorch framework.
 The main function is
 
 ```
-torch.ByteTensor generate_sequence(bool pulling,
-                                   int nb_sequences,
-                                   int nb_images,
-                                   int image_height, int image_width,
-                                   int nb_shapes,
-                                   bool random_shape_size, bool random_colors)
+torch.ByteTensor flatland.generate_sequence(bool pulling,
+                                            int nb_sequences,
+                                            int nb_images,
+                                            int image_height, int image_width,
+                                            int nb_shapes,
+                                            bool random_shape_size, bool random_colors)
 ```
-with
 
- * `pulling` indicating if one of the shape should be pulled upward,
- * `nb_sequences` the number of sequences to generate
- * `nb_images` the number of frames per sequence
- * `image_height` an `image_width` the individual image size
- * `nb_shapes` how many rectangular shapes to put in the simulation
- * `random_shape_size` should they be of different size
- * `random_colors` should they be of different colors
+where
+
+ * `pulling` indicates if one of the shape should be pulled upward,
+ * `nb_sequences` is the number of sequences to generate,
+ * `nb_images` is the number of frames per sequence,
+ * `image_height` and `image_width` is the individual image size,
+ * `nb_shapes` is the number of rectangular shapes in the simulation,
+ * `random_shape_size` states if the shapes should be of different sizes,
+ * `random_colors` states if they should be of different colors.
 
 The returned ByteTensor has five dimensions:
 
  * Sequence index
  * Image index
- * Channel (3, as for RGB)
+ * Channel (3 since it is RGB)
  * Pixel row
  * Pixel col
 
@@ -38,6 +39,5 @@ small images), the simulation may be stuck.
 
 ```
 make -j -k
-./built.py
-./flatland-test.py
+./test-flatland.py
 ```