Add human readable format for chunk_bytes (#18925)

Co-authored-by: thomas <[email protected]>
(cherry picked from commit 37cbee4)

Author: 2 people

src/lightning/data/streaming/cache.py

@@ -41,7 +41,7 @@ def __init__(
         version: Optional[Union[int, Literal["latest"]]] = "latest",
         compression: Optional[str] = None,
         chunk_size: Optional[int] = None,
-        chunk_bytes: Optional[int] = None,
+        chunk_bytes: Optional[Union[int, str]] = None,
         item_loader: Optional[BaseItemLoader] = None,
     ):
         """The Cache enables to optimise dataset format for cloud training. This is done by grouping several elements

src/lightning/data/streaming/data_processor.py

@@ -561,7 +561,10 @@ def _done(self, delete_cached_files: bool, remote_output_dir: Any) -> None:
 
 class DataChunkRecipe(DataRecipe):
     def __init__(
-        self, chunk_size: Optional[int] = None, chunk_bytes: Optional[int] = None, compression: Optional[str] = None
+        self,
+        chunk_size: Optional[int] = None,
+        chunk_bytes: Optional[Union[int, str]] = None,
+        compression: Optional[str] = None,
     ):
         super().__init__()
         if chunk_size is not None and chunk_bytes is not None:

src/lightning/data/streaming/functions.py

@@ -66,7 +66,7 @@ def __init__(
         fn: Callable[[Any], None],
         inputs: Sequence[Any],
         chunk_size: Optional[int],
-        chunk_bytes: Optional[int],
+        chunk_bytes: Optional[Union[int, str]],
         compression: Optional[str],
     ):
         super().__init__(chunk_size=chunk_size, chunk_bytes=chunk_bytes, compression=compression)
@@ -141,7 +141,7 @@ def optimize(
     inputs: Sequence[Any],
     output_dir: str,
     chunk_size: Optional[int] = None,
-    chunk_bytes: Optional[int] = None,
+    chunk_bytes: Optional[Union[int, str]] = None,
     compression: Optional[str] = None,
     name: Optional[str] = None,
     num_workers: Optional[int] = None,

src/lightning/data/streaming/writer.py

@@ -15,7 +15,7 @@
 import os
 from dataclasses import dataclass
 from time import sleep
-from typing import Any, Dict, List, Optional, Tuple
+from typing import Any, Dict, List, Optional, Tuple, Union
 
 import numpy as np
 import torch
@@ -29,11 +29,35 @@
     from torch.utils._pytree import PyTree, tree_flatten, treespec_dumps
 
 
-def _get_data_optimizer_node_rank() -> Optional[int]:
-    node_rank = os.getenv("DATA_OPTIMIZER_NODE_RANK", None)
-    if node_rank is not None:
-        return int(node_rank)
-    return node_rank
+_FORMAT_TO_RATIO = {
+    "kb": 1024,
+    "mb": 1024**2,
+    "gb": 1024**3,
+    "tb": 1024**4,
+    "pb": 1024**5,
+    "eb": 1024**6,
+    "zb": 1024**7,
+    "yb": 1024**8,
+}
+
+
+def _convert_bytes_to_int(bytes_str: str) -> int:
+    """Convert human readable byte format to an integer."""
+    for suffix in _FORMAT_TO_RATIO:
+        bytes_str = bytes_str.lower().strip()
+        if bytes_str.lower().endswith(suffix):
+            try:
+                return int(float(bytes_str[0 : -len(suffix)]) * _FORMAT_TO_RATIO[suffix])
+            except ValueError:
+                raise ValueError(
+                    "".join(
+                        [
+                            f"Unsupported value/suffix {bytes_str}. Supported suffix are ",
+                            f'{["b"] + list(_FORMAT_TO_RATIO.keys())}.',
+                        ]
+                    )
+                )
+    raise ValueError(f"The supported units are {_FORMAT_TO_RATIO.keys()}")
 
 
 @dataclass
@@ -52,7 +76,7 @@ def __init__(
         self,
         cache_dir: str,
         chunk_size: Optional[int] = None,
-        chunk_bytes: Optional[int] = None,
+        chunk_bytes: Optional[Union[int, str]] = None,
         compression: Optional[str] = None,
         follow_tensor_dimension: bool = True,
     ):
@@ -75,7 +99,7 @@ def __init__(
 
         self._serializers: Dict[str, Serializer] = _SERIALIZERS
         self._chunk_size = chunk_size
-        self._chunk_bytes = chunk_bytes
+        self._chunk_bytes = _convert_bytes_to_int(chunk_bytes) if isinstance(chunk_bytes, str) else chunk_bytes
         self._compression = compression
 
         self._data_format: Optional[List[str]] = None

tests/tests_data/datasets/test_iterable.py

@@ -437,6 +437,7 @@ def sharding_resume_test(fabric: lightning.Fabric, num_workers):
         fabric.barrier()
 
 
+@pytest.mark.skipif(True, reason="flaky and out-dated")
 @pytest.mark.parametrize(
     ("num_workers", "world_size"),
     [

tests/tests_data/streaming/test_writer.py

@@ -19,7 +19,7 @@
 from lightning import seed_everything
 from lightning.data.streaming.reader import BinaryReader
 from lightning.data.streaming.sampler import ChunkedIndex
-from lightning.data.streaming.writer import BinaryWriter
+from lightning.data.streaming.writer import _FORMAT_TO_RATIO, BinaryWriter
 from lightning_utilities.core.imports import RequirementCache
 
 _PIL_AVAILABLE = RequirementCache("PIL")
@@ -194,3 +194,12 @@ def test_binary_writer_with_jpeg_and_png(tmpdir):
 
     with pytest.raises(ValueError, match="The data format changed between items"):
         binary_writer[2] = {"x": 2, "y": 1}
+
+
+def test_writer_human_format(tmpdir):
+    for k, v in _FORMAT_TO_RATIO.items():
+        binary_writer = BinaryWriter(tmpdir, chunk_bytes=f"{1}{k}")
+        assert binary_writer._chunk_bytes == v
+
+    binary_writer = BinaryWriter(tmpdir, chunk_bytes="64MB")
+    assert binary_writer._chunk_bytes == 67108864