X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=flatland.git;a=blobdiff_plain;f=README.md;h=c1ff0a278434c5f5a2e28b0c42b77884e51c0d79;hp=c9abf2e9a0808124078cc7e67f14fac3f4faa765;hb=db40d75f91d5d332b475a260df8c034103159286;hpb=dcda16c32fa43d04f795f289725c00707225f460 diff --git a/README.md b/README.md index c9abf2e..c1ff0a2 100644 --- 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