improve compression docs

activeloopai · Dec 13, 2021 · 6278f1f · 6278f1f
1 parent 6e73650
commit 6278f1f
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/hub/compression.py b/hub/compression.py
@@ -1,10 +1,17 @@
 """
 Supported compressions (formats):
+
     Image : bmp, dib, gif, ico, jpeg, jp2, pcx, png, ppm, sgi, tga, tiff, webp, wmf, xbm
     Audio : flac, mp3, wav
     Video : mp4, mkv, avi
     Bytes : lz4
 
+__Note__:- 
+
+For video compressions, we only support already compressed data read using hub.read. We do not actually compress the video data. 
+
+Also, when using hub.read with one of the video compressions, ensure that the compression matches, otherwise hub will be unable to compress the data to the specified compression.
+
 """
 from PIL import Image  # type: ignore
 
@@ -90,6 +97,7 @@
 
 
 def get_compression_type(c):
+    """Returns the compression type for the given compression name."""
     if c is None:
         return None
     ret = _compression_types.get(c)