Update.

[flatland.git] / README.md

diff --git a/README.md b/README.md
index c9abf2e..c1ff0a2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 This is an implementation of a simple 2d physics simulator usable from
 the pytorch framework.
 
-The core provided function is
+The main function is
 
 ```
 torch.ByteTensor generate_sequence(bool pulling,
@@ -11,7 +11,7 @@ torch.ByteTensor generate_sequence(bool pulling,
                                    int nb_images,
                                    int image_height, int image_width,
                                    int nb_shapes,
-                                   bool random_shape_size, bool random_colors) {
+                                   bool random_shape_size, bool random_colors)
 ```
 with
 
@@ -23,10 +23,10 @@ with
  * `random_shape_size` should they be of different size
  * `random_colors` should they be of different colors
 
-The returned ByteTensor is of four dimensions:
+The returned ByteTensor has five dimensions:
 
- * Sequence number
- * Image number
+ * Sequence index
+ * Image index
  * Channel (3, as for RGB)
  * Pixel row
  * Pixel col