Clarify OfflineDataset usage for bayesflow-org#255

elseml · Feb 14, 2025 · 91c4385 · 91c4385
1 parent a9f17de
commit 91c4385
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/bayesflow/datasets/offline_dataset.py b/bayesflow/datasets/offline_dataset.py
@@ -6,7 +6,9 @@
 
 class OfflineDataset(keras.utils.PyDataset):
     """
-    A dataset that is pre-simulated and stored in memory.
+    A dataset that is pre-simulated and stored in memory. When storing and loading data from disk, it is recommended to
+    save any pre-simulated data in raw form and create the `OfflineDataset` object only after loading in the raw data.
+    See the `DiskDataset` class for handling large datasets that are split into multiple smaller files.
     """
 
     def __init__(self, data: dict[str, np.ndarray], batch_size: int, adapter: Adapter | None, **kwargs):