X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=README.md;h=735bee39a9514619a4f4e158ad4fa0927149d17c;hb=05414734a8c423314aaa9447db04ed348066c2f9;hp=adae280d444a3ca5ddc2b130276ad0cf12ae67aa;hpb=d1e63e9f82ddd47886ae80e894182e1a5cc8e1a3;p=pysvrt.git

diff --git a/README.md b/README.md
index adae280..735bee3 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,28 @@ The returned ByteTensor has three dimensions:
  * Pixel row
  * Pixel col
 
+The two additional functions
+
+```
+torch.ByteStorage svrt.compress(torch.ByteStorage x)
+```
+
+and
+
+```
+torch.ByteStorage svrt.uncompress(torch.ByteStorage x)
+```
+
+provide a lossless compression scheme adapted to the ByteStorage of
+the vignette ByteTensor (i.e. expecting a lot of 255s, a few 0s, and
+no other value).
+
+They allow to reduce the memory footprint by a factor ~50, and may be
+usefull to deal with very large data-sets and avoid re-generating
+images at every batch.
+
+See vignette_set.py for a class CompressedVignetteSet using it.
+
 # Installation and test #
 
 Executing